Class AmazonS3LinkedService


  • public final class AmazonS3LinkedService
    extends LinkedService
    Linked service for Amazon S3.
    • Constructor Detail

      • AmazonS3LinkedService

        public AmazonS3LinkedService()
    • Method Detail

      • withDescription

        public AmazonS3LinkedService withDescription​(String description)
        Set the description property: Linked service description.
        Overrides:
        withDescription in class LinkedService
        Parameters:
        description - the description value to set.
        Returns:
        the LinkedService object itself.
      • withAnnotations

        public AmazonS3LinkedService withAnnotations​(List<Object> annotations)
        Set the annotations property: List of tags that can be used for describing the linked service.
        Overrides:
        withAnnotations in class LinkedService
        Parameters:
        annotations - the annotations value to set.
        Returns:
        the LinkedService object itself.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • sessionToken

        public SecretBase sessionToken()
        Get the sessionToken property: The session token for the S3 temporary security credential.
        Returns:
        the sessionToken value.
      • 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.
      • encryptedCredential

        public Object encryptedCredential()
        Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Returns:
        the encryptedCredential value.
      • withEncryptedCredential

        public AmazonS3LinkedService withEncryptedCredential​(Object encryptedCredential)
        Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
        Parameters:
        encryptedCredential - the encryptedCredential value to set.
        Returns:
        the AmazonS3LinkedService object itself.