Storage Transfer Service V1 API - Class Google::Cloud::StorageTransfer::V1::AwsS3Data (v1.1.1)

Reference documentation and code samples for the Storage Transfer Service V1 API class Google::Cloud::StorageTransfer::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#aws_access_key

def aws_access_key() -> ::Google::Cloud::StorageTransfer::V1::AwsAccessKey
Returns

#aws_access_key=

def aws_access_key=(value) -> ::Google::Cloud::StorageTransfer::V1::AwsAccessKey
Parameter
Returns

#bucket_name

def bucket_name() -> ::String
Returns

#bucket_name=

def bucket_name=(value) -> ::String
Parameter
Returns

#cloudfront_domain

def cloudfront_domain() -> ::String
Returns
  • (::String) — Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching.

    See Transfer from S3 via CloudFront for more information.

    Format: https://{id}.cloudfront.net or any valid custom domain. Must begin with https://.

#cloudfront_domain=

def cloudfront_domain=(value) -> ::String
Parameter
  • value (::String) — Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching.

    See Transfer from S3 via CloudFront for more information.

    Format: https://{id}.cloudfront.net or any valid custom domain. Must begin with https://.

Returns
  • (::String) — Optional. The CloudFront distribution domain name pointing to this bucket, to use when fetching.

    See Transfer from S3 via CloudFront for more information.

    Format: https://{id}.cloudfront.net or any valid custom domain. Must begin with https://.

#credentials_secret

def credentials_secret() -> ::String
Returns
  • (::String) — Optional. The Resource name of a secret in Secret Manager.

    AWS credentials must be stored in Secret Manager in JSON format:

    { "access_key_id": "ACCESS_KEY_ID", "secret_access_key": "SECRET_ACCESS_KEY" }

    GoogleServiceAccount must be granted roles/secretmanager.secretAccessor for the resource.

    See Configure access to a source: Amazon S3 for more information.

    If credentials_secret is specified, do not specify role_arn or aws_access_key.

    Format: projects/{project_number}/secrets/{secret_name}

#credentials_secret=

def credentials_secret=(value) -> ::String
Parameter
  • value (::String) — Optional. The Resource name of a secret in Secret Manager.

    AWS credentials must be stored in Secret Manager in JSON format:

    { "access_key_id": "ACCESS_KEY_ID", "secret_access_key": "SECRET_ACCESS_KEY" }

    GoogleServiceAccount must be granted roles/secretmanager.secretAccessor for the resource.

    See Configure access to a source: Amazon S3 for more information.

    If credentials_secret is specified, do not specify role_arn or aws_access_key.

    Format: projects/{project_number}/secrets/{secret_name}

Returns
  • (::String) — Optional. The Resource name of a secret in Secret Manager.

    AWS credentials must be stored in Secret Manager in JSON format:

    { "access_key_id": "ACCESS_KEY_ID", "secret_access_key": "SECRET_ACCESS_KEY" }

    GoogleServiceAccount must be granted roles/secretmanager.secretAccessor for the resource.

    See Configure access to a source: Amazon S3 for more information.

    If credentials_secret is specified, do not specify role_arn or aws_access_key.

    Format: projects/{project_number}/secrets/{secret_name}

#managed_private_network

def managed_private_network() -> ::Boolean
Returns
  • (::Boolean) — Egress bytes over a Google-managed private network. This network is shared between other users of Storage Transfer Service.

#managed_private_network=

def managed_private_network=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Egress bytes over a Google-managed private network. This network is shared between other users of Storage Transfer Service.
Returns
  • (::Boolean) — Egress bytes over a Google-managed private network. This network is shared between other users of Storage Transfer Service.

#path

def path() -> ::String
Returns
  • (::String) — 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 '/'.

#path=

def path=(value) -> ::String
Parameter
  • value (::String) — 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 '/'.

Returns
  • (::String) — 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 '/'.

#role_arn

def role_arn() -> ::String
Returns
  • (::String) — 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.

#role_arn=

def role_arn=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.