Package software.amazon.awscdk.cfnpropertymixins.services.elasticache

Class CfnSnapshotPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.elasticache.CfnSnapshotPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSnapshotPropsMixin>

Enclosing class:

CfnSnapshotPropsMixin

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

A fluent builder for CfnSnapshotPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnSnapshotPropsMixin	build()
CfnSnapshotPropsMixin.Builder	cacheClusterId(String cacheClusterId)	The identifier of an existing cluster to create a snapshot from.
static CfnSnapshotPropsMixin.Builder	create()
static CfnSnapshotPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnSnapshotPropsMixin.Builder	kmsKeyId(String kmsKeyId)	The ID of the KMS key used to encrypt the snapshot.
CfnSnapshotPropsMixin.Builder	replicationGroupId(String replicationGroupId)	The identifier of an existing replication group to create a snapshot from.
CfnSnapshotPropsMixin.Builder	snapshotName(String snapshotName)	The name of a snapshot.
CfnSnapshotPropsMixin.Builder	tags(List<? extends CfnTag> tags)	A list of tags to be added to this resource.

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 CfnSnapshotPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnSnapshotPropsMixin.Builder.

create

@Stability(Stable)
public static CfnSnapshotPropsMixin.Builder create()

Returns:

a new instance of CfnSnapshotPropsMixin.Builder.

cacheClusterId

@Stability(Stable)
public CfnSnapshotPropsMixin.Builder cacheClusterId(String cacheClusterId)

The identifier of an existing cluster to create a snapshot from.

The snapshot is created from this cluster.

Parameters:

cacheClusterId - The identifier of an existing cluster to create a snapshot from. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-snapshot.html#cfn-elasticache-snapshot-cacheclusterid

kmsKeyId

@Stability(Stable)
public CfnSnapshotPropsMixin.Builder kmsKeyId(String kmsKeyId)

The ID of the KMS key used to encrypt the snapshot.

Parameters:

kmsKeyId - The ID of the KMS key used to encrypt the snapshot. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-snapshot.html#cfn-elasticache-snapshot-kmskeyid

replicationGroupId

@Stability(Stable)
public CfnSnapshotPropsMixin.Builder replicationGroupId(String replicationGroupId)

The identifier of an existing replication group to create a snapshot from.

The snapshot is created from this replication group.

Parameters:

replicationGroupId - The identifier of an existing replication group to create a snapshot from. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-snapshot.html#cfn-elasticache-snapshot-replicationgroupid

snapshotName

@Stability(Stable)
public CfnSnapshotPropsMixin.Builder snapshotName(String snapshotName)

The name of a snapshot.

Must be unique within the customer account.

Parameters:

snapshotName - The name of a snapshot. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-snapshot.html#cfn-elasticache-snapshot-snapshotname

tags

@Stability(Stable)
public CfnSnapshotPropsMixin.Builder tags(List<? extends CfnTag> tags)

A list of tags to be added to this resource.

Parameters:

tags - A list of tags to be added to this resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSnapshotPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnSnapshotPropsMixin.