Class AmazonS3LinkedService
java.lang.Object
com.azure.analytics.synapse.artifacts.models.LinkedService
com.azure.analytics.synapse.artifacts.models.AmazonS3LinkedService
Linked service for Amazon S3.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the accessKeyId property: The access key identifier of the Amazon S3 Identity and Access Management (IAM) user.Get the authenticationType property: The authentication type of S3.Get the encryptedCredential property: The encrypted credential used for authentication.Get the secretAccessKey property: The secret access key of the Amazon S3 Identity and Access Management (IAM) user.Get the serviceUrl property: This value specifies the endpoint to access with the S3 Connector.Get the sessionToken property: The session token for the S3 temporary security credential.setAccessKeyId
(Object accessKeyId) Set the accessKeyId property: The access key identifier of the Amazon S3 Identity and Access Management (IAM) user.setAnnotations
(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.setAuthenticationType
(Object authenticationType) Set the authenticationType property: The authentication type of S3.setConnectVia
(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.setDescription
(String description) Set the description property: Linked service description.setEncryptedCredential
(Object encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.setParameters
(Map<String, ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.setSecretAccessKey
(SecretBase secretAccessKey) Set the secretAccessKey property: The secret access key of the Amazon S3 Identity and Access Management (IAM) user.setServiceUrl
(Object serviceUrl) Set the serviceUrl property: This value specifies the endpoint to access with the S3 Connector.setSessionToken
(SecretBase sessionToken) Set the sessionToken property: The session token for the S3 temporary security credential.Methods inherited from class com.azure.analytics.synapse.artifacts.models.LinkedService
getAdditionalProperties, getAnnotations, getConnectVia, getDescription, getParameters, setAdditionalProperties
-
Constructor Details
-
AmazonS3LinkedService
public AmazonS3LinkedService()
-
-
Method Details
-
getAuthenticationType
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.
-
setAuthenticationType
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.
-
getAccessKeyId
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.
-
setAccessKeyId
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.
-
getSecretAccessKey
Get the secretAccessKey property: The secret access key of the Amazon S3 Identity and Access Management (IAM) user.- Returns:
- the secretAccessKey value.
-
setSecretAccessKey
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.
-
getServiceUrl
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.
-
setServiceUrl
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.
-
getSessionToken
Get the sessionToken property: The session token for the S3 temporary security credential.- Returns:
- the sessionToken value.
-
setSessionToken
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.
-
getEncryptedCredential
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.
-
setEncryptedCredential
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.
-
setConnectVia
Set the connectVia property: The integration runtime reference.- Overrides:
setConnectVia
in classLinkedService
- Parameters:
connectVia
- the connectVia value to set.- Returns:
- the LinkedService object itself.
-
setDescription
Set the description property: Linked service description.- Overrides:
setDescription
in classLinkedService
- Parameters:
description
- the description value to set.- Returns:
- the LinkedService object itself.
-
setParameters
Set the parameters property: Parameters for linked service.- Overrides:
setParameters
in classLinkedService
- Parameters:
parameters
- the parameters value to set.- Returns:
- the LinkedService object itself.
-
setAnnotations
Set the annotations property: List of tags that can be used for describing the linked service.- Overrides:
setAnnotations
in classLinkedService
- Parameters:
annotations
- the annotations value to set.- Returns:
- the LinkedService object itself.
-