Storage Transfer v1 API - Class AwsS3Data (2.4.0)

public sealed class AwsS3Data : IMessage<AwsS3Data>, IEquatable<AwsS3Data>, IDeepCloneable<AwsS3Data>, IBufferMessage, IMessage

Reference documentation and code samples for the Storage Transfer v1 API class AwsS3Data.

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.

Inheritance

object > AwsS3Data

Implements

IMessage AwsS3Data, IEquatable AwsS3Data, IDeepCloneable AwsS3Data, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.StorageTransfer.V1

Assembly

Google.Cloud.StorageTransfer.V1.dll

Constructors

AwsS3Data()

public AwsS3Data()

AwsS3Data(AwsS3Data)

public AwsS3Data(AwsS3Data other)

Parameter
Name	Description
`other`	`AwsS3Data`

Properties

AwsAccessKey

public AwsAccessKey AwsAccessKey { get; set; }

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.

Property Value
Type	Description
`AwsAccessKey`

BucketName

public string BucketName { get; set; }

Required. S3 Bucket name (see Creating a bucket).

Property Value
Type	Description
`string`

CredentialsSecret

public string CredentialsSecret { get; set; }

Optional. The Resource name of a secret in Secret Manager.

The Azure SAS token must be stored in Secret Manager in JSON format: <pre>{ "sas_token" : "<var>SAS_TOKEN</var>" }</pre> [GoogleServiceAccount][google.storagetransfer.v1.GoogleServiceAccount] must be granted roles/secretmanager.secretAccessor for the resource.

See Configure access to a source: Microsoft Azure Blob Storage 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}

Property Value
Type	Description
`string`

Path

public string Path { get; set; }

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 '/'.

Property Value
Type	Description
`string`

RoleArn

public string RoleArn { get; set; }

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][google.storagetransfer.v1.GoogleServiceAccount] for this project.

Property Value
Type	Description
`string`