interface CfnLocationS3Props
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.DataSync.CfnLocationS3Props |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnLocationS3Props |
![]() | software.amazon.awscdk.services.datasync.CfnLocationS3Props |
![]() | aws_cdk.aws_datasync.CfnLocationS3Props |
![]() | aws-cdk-lib » aws_datasync » CfnLocationS3Props |
Properties for defining a CfnLocationS3
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datasync as datasync } from 'aws-cdk-lib';
const cfnLocationS3Props: datasync.CfnLocationS3Props = {
s3Config: {
bucketAccessRoleArn: 'bucketAccessRoleArn',
},
// the properties below are optional
s3BucketArn: 's3BucketArn',
s3StorageClass: 's3StorageClass',
subdirectory: 'subdirectory',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
s3 | IResolvable | S3 | The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket. |
s3 | string | The ARN of the Amazon S3 bucket. |
s3 | string | The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. |
subdirectory? | string | Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location). |
tags? | Cfn [] | Specifies labels that help you categorize, filter, and search for your AWS resources. |
s3Config
Type:
IResolvable
|
S3
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, default: "STANDARD")
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)
Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).
DataSync can't transfer objects with a prefix that begins with a slash (
/
) or includes//
,/./
, or/../
patterns. For example:
/photos
photos//2006/January
photos/./2006/February
photos/../2006/March
tags?
Type:
Cfn
[]
(optional)
Specifies labels that help you categorize, filter, and search for your AWS resources.
We recommend creating at least a name tag for your transfer location.