Class: Google::Cloud::StorageTransfer::V1::AwsS3Data

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/storagetransfer/v1/transfer_types.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#aws_access_key ⇒ ::Google::Cloud::StorageTransfer::V1::AwsAccessKey

Returns 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.

Returns:



302
303
304
305
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 302

class AwsS3Data
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#bucket_name ⇒ ::String

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

Returns:



302
303
304
305
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 302

class AwsS3Data
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#cloudfront_domain ⇒ ::String

Returns 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://.



302
303
304
305
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 302

class AwsS3Data
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#credentials_secret ⇒ ::String

Returns 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}



302
303
304
305
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 302

class AwsS3Data
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#managed_private_network ⇒ ::Boolean

Returns 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.



302
303
304
305
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 302

class AwsS3Data
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#path ⇒ ::String

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



302
303
304
305
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 302

class AwsS3Data
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#role_arn ⇒ ::String

Returns 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.



302
303
304
305
 
# File 'proto_docs/google/storagetransfer/v1/transfer_types.rb', line 302

class AwsS3Data
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end