CfnLocationS3Props

class aws_cdk.aws_datasync.CfnLocationS3Props(*, s3_config, s3_bucket_arn=None, s3_storage_class=None, subdirectory=None, tags=None)

Bases: object

Properties for defining a CfnLocationS3.

Parameters:

  • s3_config (Union[IResolvable, S3ConfigProperty, Dict[str, Any]]) – 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_bucket_arn (Optional[str]) – The ARN of the Amazon S3 bucket.

  • s3_storage_class (Optional[str]) – 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 . Default: - “STANDARD”

  • subdirectory (Optional[str]) – 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). .. epigraph:: 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_datasync as datasync

cfn_location_s3_props = datasync.CfnLocationS3Props(
    s3_config=datasync.CfnLocationS3.S3ConfigProperty(
        bucket_access_role_arn="bucketAccessRoleArn"
    ),

    # the properties below are optional
    s3_bucket_arn="s3BucketArn",
    s3_storage_class="s3StorageClass",
    subdirectory="subdirectory",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

s3_bucket_arn

The ARN of the Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3bucketarn

s3_config

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3config

s3_storage_class

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 .

Default:

  • “STANDARD”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-s3storageclass

subdirectory

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-subdirectory

tags

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locations3.html#cfn-datasync-locations3-tags