Package software.amazon.awscdk.services.datasync

Class CfnLocationS3.Builder

java.lang.Object

software.amazon.awscdk.services.datasync.CfnLocationS3.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnLocationS3>

Enclosing class:

CfnLocationS3

@Stability(Stable)
public static final class CfnLocationS3.Builder
extends Object
implements software.amazon.jsii.Builder<CfnLocationS3>

A fluent builder for CfnLocationS3.

Method Summary

Modifier and Type	Method	Description
CfnLocationS3	build()
static CfnLocationS3.Builder	create(software.constructs.Construct scope, String id)
CfnLocationS3.Builder	s3BucketArn(String s3BucketArn)	The ARN of the Amazon S3 bucket.
CfnLocationS3.Builder	s3Config(IResolvable s3Config)	The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.
CfnLocationS3.Builder	s3Config(CfnLocationS3.S3ConfigProperty s3Config)	The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.
CfnLocationS3.Builder	s3StorageClass(String s3StorageClass)	The Amazon S3 storage class that you want to store your files in when this location is used as a task destination.
CfnLocationS3.Builder	subdirectory(String 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).
CfnLocationS3.Builder	tags(List<? extends CfnTag> tags)	Specifies labels that help you categorize, filter, and search for your AWS resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnLocationS3.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnLocationS3.Builder.

s3Config

@Stability(Stable)
public CfnLocationS3.Builder s3Config(IResolvable 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 .

Parameters:

s3Config - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket. This parameter is required.

Returns:

this

See Also:

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

s3Config

@Stability(Stable)
public CfnLocationS3.Builder s3Config(CfnLocationS3.S3ConfigProperty 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 .

Parameters:

s3Config - The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket. This parameter is required.

Returns:

this

See Also:

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

s3BucketArn

@Stability(Stable)
public CfnLocationS3.Builder s3BucketArn(String s3BucketArn)

The ARN of the Amazon S3 bucket.

Parameters:

s3BucketArn - The ARN of the Amazon S3 bucket. This parameter is required.

Returns:

this

See Also:

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

s3StorageClass

@Stability(Stable)
public CfnLocationS3.Builder s3StorageClass(String s3StorageClass)

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"

Parameters:

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

Returns:

this

See Also:

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

subdirectory

@Stability(Stable)
public CfnLocationS3.Builder subdirectory(String 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

Parameters:

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). This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnLocationS3.Builder tags(List<? extends CfnTag> 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.

Parameters:

tags - Specifies labels that help you categorize, filter, and search for your AWS resources. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnLocationS3 build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnLocationS3>

Returns:

a newly built instance of CfnLocationS3.