Class: Aws::DataSync::Types::CreateLocationS3Request

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

Note:

When making an API call, you may pass CreateLocationS3Request data as a hash:

{
  subdirectory: "S3Subdirectory",
  s3_bucket_arn: "S3BucketArn", # required
  s3_storage_class: "STANDARD", # accepts STANDARD, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
  s3_config: { # required
    bucket_access_role_arn: "IamRoleArn", # required
  },
  agent_arns: ["AgentArn"],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

CreateLocationS3Request

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_arnsArray<String>

If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

Returns:

  • (Array<String>)


840
841
842
843
844
845
846
847
848
849
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 840

class CreateLocationS3Request < Struct.new(
  :subdirectory,
  :s3_bucket_arn,
  :s3_storage_class,
  :s3_config,
  :agent_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket_arnString

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

Returns:

  • (String)


840
841
842
843
844
845
846
847
848
849
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 840

class CreateLocationS3Request < Struct.new(
  :subdirectory,
  :s3_bucket_arn,
  :s3_storage_class,
  :s3_config,
  :agent_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#s3_configTypes::S3Config

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

For detailed information about using such a role, see Creating a Location for Amazon S3 in the DataSync User Guide.

Returns:



840
841
842
843
844
845
846
847
848
849
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 840

class CreateLocationS3Request < Struct.new(
  :subdirectory,
  :s3_bucket_arn,
  :s3_storage_class,
  :s3_config,
  :agent_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#s3_storage_classString

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

Returns:

  • (String)


840
841
842
843
844
845
846
847
848
849
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 840

class CreateLocationS3Request < Struct.new(
  :subdirectory,
  :s3_bucket_arn,
  :s3_storage_class,
  :s3_config,
  :agent_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subdirectoryString

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

Returns:

  • (String)


840
841
842
843
844
845
846
847
848
849
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 840

class CreateLocationS3Request < Struct.new(
  :subdirectory,
  :s3_bucket_arn,
  :s3_storage_class,
  :s3_config,
  :agent_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::TagListEntry>

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Returns:



840
841
842
843
844
845
846
847
848
849
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 840

class CreateLocationS3Request < Struct.new(
  :subdirectory,
  :s3_bucket_arn,
  :s3_storage_class,
  :s3_config,
  :agent_arns,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end