Package software.amazon.awscdk.services.ssm

Class CfnResourceDataSync.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CfnResourceDataSync.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnResourceDataSync>

Enclosing class:

CfnResourceDataSync

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

A fluent builder for CfnResourceDataSync.

Method Summary

Modifier and Type	Method	Description
CfnResourceDataSync.Builder	bucketName(String bucketName)	The name of the S3 bucket where the aggregated data is stored.
CfnResourceDataSync.Builder	bucketPrefix(String bucketPrefix)	An Amazon S3 prefix for the bucket.
CfnResourceDataSync.Builder	bucketRegion(String bucketRegion)	The AWS Region with the S3 bucket targeted by the resource data sync.
CfnResourceDataSync	build()
static CfnResourceDataSync.Builder	create(software.constructs.Construct scope, String id)
CfnResourceDataSync.Builder	kmsKeyArn(String kmsKeyArn)	The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .
CfnResourceDataSync.Builder	s3Destination(IResolvable s3Destination)	Configuration information for the target S3 bucket.
CfnResourceDataSync.Builder	s3Destination(CfnResourceDataSync.S3DestinationProperty s3Destination)	Configuration information for the target S3 bucket.
CfnResourceDataSync.Builder	syncFormat(String syncFormat)	A supported sync format.
CfnResourceDataSync.Builder	syncName(String syncName)	A name for the resource data sync.
CfnResourceDataSync.Builder	syncSource(IResolvable syncSource)	Information about the source where the data was synchronized.
CfnResourceDataSync.Builder	syncSource(CfnResourceDataSync.SyncSourceProperty syncSource)	Information about the source where the data was synchronized.
CfnResourceDataSync.Builder	syncType(String syncType)	The type of resource data sync.

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 CfnResourceDataSync.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 CfnResourceDataSync.Builder.

syncName

@Stability(Stable)
public CfnResourceDataSync.Builder syncName(String syncName)

A name for the resource data sync.

Parameters:

syncName - A name for the resource data sync. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname

bucketName

@Stability(Stable)
public CfnResourceDataSync.Builder bucketName(String bucketName)

The name of the S3 bucket where the aggregated data is stored.

Parameters:

bucketName - The name of the S3 bucket where the aggregated data is stored. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname

bucketPrefix

@Stability(Stable)
public CfnResourceDataSync.Builder bucketPrefix(String bucketPrefix)

An Amazon S3 prefix for the bucket.

Parameters:

bucketPrefix - An Amazon S3 prefix for the bucket. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix

bucketRegion

@Stability(Stable)
public CfnResourceDataSync.Builder bucketRegion(String bucketRegion)

The AWS Region with the S3 bucket targeted by the resource data sync.

Parameters:

bucketRegion - The AWS Region with the S3 bucket targeted by the resource data sync. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion

kmsKeyArn

@Stability(Stable)
public CfnResourceDataSync.Builder kmsKeyArn(String kmsKeyArn)

The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 .

You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same AWS Region as the destination Amazon S3 bucket.

Parameters:

kmsKeyArn - The Amazon Resource Name (ARN) of an encryption key for a destination in Amazon S3 . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn

s3Destination

@Stability(Stable)
public CfnResourceDataSync.Builder s3Destination(IResolvable s3Destination)

Configuration information for the target S3 bucket.

Parameters:

s3Destination - Configuration information for the target S3 bucket. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination

s3Destination

@Stability(Stable)
public CfnResourceDataSync.Builder s3Destination(CfnResourceDataSync.S3DestinationProperty s3Destination)

Configuration information for the target S3 bucket.

Parameters:

s3Destination - Configuration information for the target S3 bucket. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination

syncFormat

@Stability(Stable)
public CfnResourceDataSync.Builder syncFormat(String syncFormat)

A supported sync format.

The following format is currently supported: JsonSerDe

Parameters:

syncFormat - A supported sync format. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat

syncSource

@Stability(Stable)
public CfnResourceDataSync.Builder syncSource(IResolvable syncSource)

Information about the source where the data was synchronized.

Parameters:

syncSource - Information about the source where the data was synchronized. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource

syncSource

@Stability(Stable)
public CfnResourceDataSync.Builder syncSource(CfnResourceDataSync.SyncSourceProperty syncSource)

Information about the source where the data was synchronized.

Parameters:

syncSource - Information about the source where the data was synchronized. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource

syncType

@Stability(Stable)
public CfnResourceDataSync.Builder syncType(String syncType)

The type of resource data sync.

If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .

Parameters:

syncType - The type of resource data sync. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype

build

@Stability(Stable)
public CfnResourceDataSync build()

Specified by:

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

Returns:

a newly built instance of CfnResourceDataSync.