Package com.couchbase.client.java.manager.analytics.link

Class S3ExternalAnalyticsLink

java.lang.Object
com.couchbase.client.java.manager.analytics.link.AnalyticsLink
com.couchbase.client.java.manager.analytics.link.S3ExternalAnalyticsLink
@SinceCouchbase("7.0") public class S3ExternalAnalyticsLink extends AnalyticsLink
An analytics link to S3.

Important: When creating a link to the Amazon S3 service, be sure to follow best practices for security. AWS root account credentials should never be used. The policy for the created IAM User roles should be as strict as possible and only allow access to the required data and required resources. You only need to know the Access Key Id and the Secret Access Key for the created IAM User role to access the S3 service. The link will be able to access whatever is permitted to the IAM User, since it will be using the IAM User credentials to interact with the AWS S3 service.

  • Constructor Details

    • S3ExternalAnalyticsLink

      public S3ExternalAnalyticsLink(String name, String dataverse)
      Creates a new Analytics Link to S3.

      As an alternative to this constructor, AnalyticsLink.s3(String, String) can be used as well.

      Please note that additional parameters are required and must be set on S3ExternalAnalyticsLink in order for a S3 link to work properly.

  • Method Details

    • type

      public AnalyticsLinkType type()
      Description copied from class: AnalyticsLink
      Returns the type of the link.
      Specified by:
      type in class AnalyticsLink
      Returns:
      the type of the link.

    • accessKeyId

      public String accessKeyId()
      Returns the S3 access key ID.
      Returns:
      the S3 access key ID.

    • accessKeyId

      public S3ExternalAnalyticsLink accessKeyId(String accessKeyId)
      Sets the S3 access key ID (required).
      Parameters:
      accessKeyId - the S3 access key ID.
      Returns:
      this S3ExternalAnalyticsLink instance for chaining.

    • secretAccessKey

      public String secretAccessKey()
      Returns the S3 secret access key.
      Returns:
      the S3 access key.

    • secretAccessKey

      public S3ExternalAnalyticsLink secretAccessKey(String secretAccessKey)
      Sets the S3 secret access key (required).
      Parameters:
      secretAccessKey - the S3 secret access key.
      Returns:
      this S3ExternalAnalyticsLink instance for chaining.

    • region

      public String region()
      Returns the S3 region.
      Returns:
      the S3 region.

    • region

      public S3ExternalAnalyticsLink region(String region)
      Sets the S3 region (required).
      Parameters:
      region - the S3 region.
      Returns:
      this S3ExternalAnalyticsLink instance for chaining.

    • serviceEndpoint

      public String serviceEndpoint()
      Returns the S3 service endpoint.
      Returns:
      the S3 service endpoint.

    • serviceEndpoint

      public S3ExternalAnalyticsLink serviceEndpoint(String serviceEndpoint)
      Sets the S3 service endpoint.
      Parameters:
      serviceEndpoint - the service endpoint.
      Returns:
      this S3ExternalAnalyticsLink instance for chaining.

    • sessionToken

      public String sessionToken()
      Returns the S3 session token.
      Returns:
      the S3 session token.

    • sessionToken

      public S3ExternalAnalyticsLink sessionToken(String sessionToken)
      Sets the S3 session token.
      Parameters:
      sessionToken - the S3 session token.
      Returns:
      this S3ExternalAnalyticsLink instance for chaining.

    • toString

      public String toString()
      Overrides:
      toString in class Object