View Source GoogleApi.StorageTransfer.V1.Model.AwsS3Data (google_api_storage_transfer v0.33.2)

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.


  • awsAccessKey (type: GoogleApi.StorageTransfer.V1.Model.AwsAccessKey.t, default: nil) - 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 User credentials.
  • bucketName (type: String.t, default: nil) - Required. S3 Bucket name (see Creating a bucket).
  • path (type: String.t, default: nil) - 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 '/'.
  • roleArn (type: String.t, default: nil) - 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.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.StorageTransfer.V1.Model.AwsS3Data{
  awsAccessKey: GoogleApi.StorageTransfer.V1.Model.AwsAccessKey.t() | nil,
  bucketName: String.t() | nil,
  path: String.t() | nil,
  roleArn: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.