AwsS3DataArgs

data class AwsS3DataArgs(val awsAccessKey: Output<AwsAccessKeyArgs>? = null, val bucketName: Output<String>, val credentialsSecret: Output<String>? = null, val path: Output<String>? = null, val roleArn: Output<String>? = null) : ConvertibleToJava<AwsS3DataArgs>

An AwsS3Data resource can be a data source, but not a data sink. In an AwsS3Data resource, an object's name is the S3 object's key name.

Constructors

Link copied to clipboard
fun AwsS3DataArgs(awsAccessKey: Output<AwsAccessKeyArgs>? = null, bucketName: Output<String>, credentialsSecret: Output<String>? = null, path: Output<String>? = null, roleArn: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): AwsS3DataArgs

Properties

Link copied to clipboard
val awsAccessKey: Output<AwsAccessKeyArgs>? = null

Input only. AWS access key used to sign the API requests to the AWS S3 bucket. Permissions on the bucket must be granted to the access ID of the AWS access key. For information on our data retention policy for user credentials, see /storage-transfer/docs/data-retention#user-credentials.

Link copied to clipboard
val bucketName: Output<String>

S3 Bucket name (see Creating a bucket).

Link copied to clipboard
val credentialsSecret: Output<String>? = null

Optional. The Resource name of a secret in Secret Manager. The Azure SAS token must be stored in Secret Manager in JSON format: { "sas_token" : "SAS_TOKEN" } GoogleServiceAccount must be granted roles/secretmanager.secretAccessor for the resource. See Configure access to a source: Microsoft Azure Blob Storage (https://cloud.google.com/storage-transfer/docs/source-microsoft-azure#secret_manager) for more information. If credentials_secret is specified, do not specify azure_credentials. This feature is in preview. Format: projects/{project_number}/secrets/{secret_name}

Link copied to clipboard
val path: Output<String>? = null

Root path to transfer objects. Must be an empty string or full path name that ends with a '/'. This field is treated as an object prefix. As such, it should generally not begin with a '/'.

Link copied to clipboard
val roleArn: Output<String>? = null

The Amazon Resource Name (ARN) of the role to support temporary credentials via AssumeRoleWithWebIdentity. For more information about ARNs, see IAM ARNs. When a role ARN is provided, Transfer Service fetches temporary credentials for the session using a AssumeRoleWithWebIdentity call for the provided role using the GoogleServiceAccount for this project.