@SinceCouchbase(value="7.0") public class S3ExternalAnalyticsLink extends AnalyticsLink
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 and Description |
---|
S3ExternalAnalyticsLink(String name,
String dataverse)
Creates a new Analytics Link to S3.
|
Modifier and Type | Method and Description |
---|---|
String |
accessKeyId()
Returns the S3 access key ID.
|
S3ExternalAnalyticsLink |
accessKeyId(String accessKeyId)
Sets the S3 access key ID (required).
|
String |
region()
Returns the S3 region.
|
S3ExternalAnalyticsLink |
region(String region)
Sets the S3 region (required).
|
String |
secretAccessKey()
Returns the S3 secret access key.
|
S3ExternalAnalyticsLink |
secretAccessKey(String secretAccessKey)
Sets the S3 secret access key (required).
|
String |
serviceEndpoint()
Returns the S3 service endpoint.
|
S3ExternalAnalyticsLink |
serviceEndpoint(String serviceEndpoint)
Sets the S3 service endpoint.
|
String |
sessionToken()
Returns the S3 session token.
|
S3ExternalAnalyticsLink |
sessionToken(String sessionToken)
Sets the S3 session token.
|
String |
toString() |
AnalyticsLinkType |
type()
Returns the type of the link.
|
couchbaseRemote, dataverse, name, s3, toMap
public S3ExternalAnalyticsLink(String name, String dataverse)
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.
public AnalyticsLinkType type()
AnalyticsLink
type
in class AnalyticsLink
public String accessKeyId()
public S3ExternalAnalyticsLink accessKeyId(String accessKeyId)
accessKeyId
- the S3 access key ID.S3ExternalAnalyticsLink
instance for chaining.public String secretAccessKey()
public S3ExternalAnalyticsLink secretAccessKey(String secretAccessKey)
secretAccessKey
- the S3 secret access key.S3ExternalAnalyticsLink
instance for chaining.public String region()
public S3ExternalAnalyticsLink region(String region)
region
- the S3 region.S3ExternalAnalyticsLink
instance for chaining.public String serviceEndpoint()
public S3ExternalAnalyticsLink serviceEndpoint(String serviceEndpoint)
serviceEndpoint
- the service endpoint.S3ExternalAnalyticsLink
instance for chaining.public String sessionToken()
public S3ExternalAnalyticsLink sessionToken(String sessionToken)
sessionToken
- the S3 session token.S3ExternalAnalyticsLink
instance for chaining.Copyright © 2024 Couchbase, Inc.. All rights reserved.