AmazonS3LinkedService Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
AmazonS3LinkedService.cs

Linked service for Amazon S3.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AmazonS3LinkedService+AmazonS3LinkedServiceConverter))]
public class AmazonS3LinkedService : Azure.Analytics.Synapse.Artifacts.Models.LinkedService
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.AmazonS3LinkedService+AmazonS3LinkedServiceConverter))>]
type AmazonS3LinkedService = class
    inherit LinkedService
Public Class AmazonS3LinkedService
Inherits LinkedService
Inheritance
Object
LinkedService
AmazonS3LinkedService
Attributes
JsonConverterAttribute

Constructors

AmazonS3LinkedService()

Initializes a new instance of AmazonS3LinkedService.

Properties

AccessKeyId

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

Additional Properties.

(Inherited from LinkedService)
Annotations

List of tags that can be used for describing the linked service.

(Inherited from LinkedService)
AuthenticationType

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

The integration runtime reference.

(Inherited from LinkedService)
Description

Linked service description.

(Inherited from LinkedService)
EncryptedCredential

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).
Parameters

Parameters for linked service.

(Inherited from LinkedService)
SecretAccessKey

The secret access key of the Amazon S3 Identity and Access Management (IAM) user. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.
ServiceUrl

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).
SessionToken

The session token for the S3 temporary security credential. Please note SecretBase is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureKeyVaultSecretReference and SecureString.

Applies to