Package software.amazon.awscdk.cfnpropertymixins.services.datasync

Interface CfnLocationS3MixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationS3MixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:57.880Z")
@Stability(Stable)
public interface CfnLocationS3MixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnLocationS3PropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.datasync.*;
 CfnLocationS3MixinProps cfnLocationS3MixinProps = CfnLocationS3MixinProps.builder()
         .s3BucketArn("s3BucketArn")
         .s3Config(S3ConfigProperty.builder()
                 .bucketAccessRoleArn("bucketAccessRoleArn")
                 .build())
         .s3StorageClass("s3StorageClass")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnLocationS3MixinProps.Builder	A builder for CfnLocationS3MixinProps
static final class	CfnLocationS3MixinProps.Jsii$Proxy	An implementation for CfnLocationS3MixinProps

Method Summary

Modifier and Type	Method	Description
static CfnLocationS3MixinProps.Builder	builder()
default Object	getS3BucketArn()	The ARN of the Amazon S3 bucket.
default Object	getS3Config()	The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.
default String	getS3StorageClass()	The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
default String	getSubdirectory()	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).
default List<CfnTag>	getTags()	Specifies labels that help you categorize, filter, and search for your AWS resources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getS3BucketArn

@Stability(Stable)
@Nullable
default Object getS3BucketArn()

The ARN of the Amazon S3 bucket.

Returns union: either String or IBucketRef

See Also:

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

getS3Config

@Stability(Stable)
@Nullable
default Object getS3Config()

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 union: either IResolvable or CfnLocationS3PropsMixin.S3ConfigProperty

See Also:

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

getS3StorageClass

@Stability(Stable)
@Nullable
default String getS3StorageClass()

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

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

getSubdirectory

@Stability(Stable)
@Nullable
default String getSubdirectory()

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

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

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

builder

@Stability(Stable)
static CfnLocationS3MixinProps.Builder builder()

Returns:

a CfnLocationS3MixinProps.Builder of CfnLocationS3MixinProps