AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateLocationS3Request as input to an Aws::Client method, you can use a vanilla 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

Instance Attribute Summary collapse

Instance Attribute Details

#agent_arnsArray<String>

If you are using DataSync on an AWS 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 AWS Outpost, see outposts-agent.

Returns:

  • (Array<String>)

    If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost.

#s3_bucket_arnString

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

Returns:

  • (String)

    The ARN of the Amazon S3 bucket.

#s3_configTypes::S3Config

The Amazon Resource Name (ARN) of the AWS 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 AWS DataSync User Guide.

Returns:

  • (Types::S3Config)

    The Amazon Resource Name (ARN) of the AWS 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 AWS DataSync User Guide.

    .

#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 AWS Regions, the storage class defaults to Standard. For buckets on AWS Outposts, the storage class defaults to AWS 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 using-storage-classes.

Returns:

  • (String)

    The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.

#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)

    A subdirectory in the Amazon S3 bucket.

#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:

  • (Array<Types::TagListEntry>)

    The key-value pair that represents the tag that you want to add to the location.