1.204.0

interface CfnLocationS3Props

LanguageType name
.NETAmazon.CDK.AWS.DataSync.CfnLocationS3Props
Javasoftware.amazon.awscdk.services.datasync.CfnLocationS3Props
Pythonaws_cdk.aws_datasync.CfnLocationS3Props
TypeScript @aws-cdk/aws-datasync » CfnLocationS3Props

Properties for defining a CfnLocationS3.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as datasync from '@aws-cdk/aws-datasync';
const cfnLocationS3Props: datasync.CfnLocationS3Props = {
  s3Config: {
    bucketAccessRoleArn: 'bucketAccessRoleArn',
  },

  // the properties below are optional
  s3BucketArn: 's3BucketArn',
  s3StorageClass: 's3StorageClass',
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
s3ConfigIResolvable | S3ConfigPropertyThe Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.
s3BucketArn?stringThe ARN of the Amazon S3 bucket.
s3StorageClass?stringThe Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
subdirectory?stringA subdirectory in the Amazon S3 bucket.
tags?CfnTag[]The key-value pair that represents the tag that you want to add to the location.

s3Config

Type: IResolvable | S3ConfigProperty

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 .

s3BucketArn?

Type: string (optional)

The ARN of the Amazon S3 bucket.

s3StorageClass?

Type: string (optional)

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 S3 Standard.

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

subdirectory?

Type: string (optional)

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.

tags?

Type: CfnTag[] (optional)

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.

← PreviousNext →