AmazonS3LinkedService Class

public final class AmazonS3LinkedService
extends LinkedService

Linked service for Amazon S3.

Constructor Summary

Constructor Description
AmazonS3LinkedService()

Creates an instance of AmazonS3LinkedService class.

Method Summary

Modifier and Type Method and Description
Object accessKeyId()

Get the accessKeyId property: The access key identifier of the Amazon S3 Identity and Access Management (IAM) user.

Object authenticationType()

Get the authenticationType property: The authentication type of S3.

String encryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication.

SecretBase secretAccessKey()

Get the secretAccessKey property: The secret access key of the Amazon S3 Identity and Access Management (IAM) user.

Object serviceUrl()

Get the serviceUrl property: This value specifies the endpoint to access with the S3 Connector.

SecretBase sessionToken()

Get the sessionToken property: The session token for the S3 temporary security credential.

String type()

Get the type property: Type of linked service.

void validate()

Validates the instance.

AmazonS3LinkedService withAccessKeyId(Object accessKeyId)

Set the accessKeyId property: The access key identifier of the Amazon S3 Identity and Access Management (IAM) user.

AmazonS3LinkedService withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the linked service.

AmazonS3LinkedService withAuthenticationType(Object authenticationType)

Set the authenticationType property: The authentication type of S3.

AmazonS3LinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

AmazonS3LinkedService withDescription(String description)

Set the description property: Linked service description.

AmazonS3LinkedService withEncryptedCredential(String encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication.

AmazonS3LinkedService withParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for linked service.

AmazonS3LinkedService withSecretAccessKey(SecretBase secretAccessKey)

Set the secretAccessKey property: The secret access key of the Amazon S3 Identity and Access Management (IAM) user.

AmazonS3LinkedService withServiceUrl(Object serviceUrl)

Set the serviceUrl property: This value specifies the endpoint to access with the S3 Connector.

AmazonS3LinkedService withSessionToken(SecretBase sessionToken)

Set the sessionToken property: The session token for the S3 temporary security credential.

Methods inherited from LinkedService

Methods inherited from java.lang.Object

Constructor Details

AmazonS3LinkedService

public AmazonS3LinkedService()

Creates an instance of AmazonS3LinkedService class.

Method Details

accessKeyId

public Object accessKeyId()

Get the accessKeyId property: The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).

Returns:

the accessKeyId value.

authenticationType

public Object authenticationType()

Get the authenticationType property: The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string).

Returns:

the authenticationType value.

encryptedCredential

public String encryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Returns:

the encryptedCredential value.

secretAccessKey

public SecretBase secretAccessKey()

Get the secretAccessKey property: The secret access key of the Amazon S3 Identity and Access Management (IAM) user.

Returns:

the secretAccessKey value.

serviceUrl

public Object serviceUrl()

Get the serviceUrl property: This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

Returns:

the serviceUrl value.

sessionToken

public SecretBase sessionToken()

Get the sessionToken property: The session token for the S3 temporary security credential.

Returns:

the sessionToken value.

type

public String type()

Get the type property: Type of linked service.

Overrides:

AmazonS3LinkedService.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

AmazonS3LinkedService.validate()

withAccessKeyId

public AmazonS3LinkedService withAccessKeyId(Object accessKeyId)

Set the accessKeyId property: The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string).

Parameters:

accessKeyId - the accessKeyId value to set.

Returns:

the AmazonS3LinkedService object itself.

withAnnotations

public AmazonS3LinkedService withAnnotations(List annotations)

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

AmazonS3LinkedService.withAnnotations(List<Object> annotations)

Parameters:

annotations

withAuthenticationType

public AmazonS3LinkedService withAuthenticationType(Object authenticationType)

Set the authenticationType property: The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string).

Parameters:

authenticationType - the authenticationType value to set.

Returns:

the AmazonS3LinkedService object itself.

withConnectVia

public AmazonS3LinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

AmazonS3LinkedService.withConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

withDescription

public AmazonS3LinkedService withDescription(String description)

Set the description property: Linked service description.

Overrides:

AmazonS3LinkedService.withDescription(String description)

Parameters:

description

withEncryptedCredential

public AmazonS3LinkedService withEncryptedCredential(String encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Parameters:

encryptedCredential - the encryptedCredential value to set.

Returns:

the AmazonS3LinkedService object itself.

withParameters

public AmazonS3LinkedService withParameters(Map parameters)

Set the parameters property: Parameters for linked service.

Overrides:

AmazonS3LinkedService.withParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

withSecretAccessKey

public AmazonS3LinkedService withSecretAccessKey(SecretBase secretAccessKey)

Set the secretAccessKey property: The secret access key of the Amazon S3 Identity and Access Management (IAM) user.

Parameters:

secretAccessKey - the secretAccessKey value to set.

Returns:

the AmazonS3LinkedService object itself.

withServiceUrl

public AmazonS3LinkedService withServiceUrl(Object serviceUrl)

Set the serviceUrl property: This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string).

Parameters:

serviceUrl - the serviceUrl value to set.

Returns:

the AmazonS3LinkedService object itself.

withSessionToken

public AmazonS3LinkedService withSessionToken(SecretBase sessionToken)

Set the sessionToken property: The session token for the S3 temporary security credential.

Parameters:

sessionToken - the sessionToken value to set.

Returns:

the AmazonS3LinkedService object itself.

Applies to