Package software.amazon.awscdk.services.elasticache

Class CfnSnapshot.Builder

java.lang.Object

software.amazon.awscdk.services.elasticache.CfnSnapshot.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSnapshot>

Enclosing class:

CfnSnapshot

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

A fluent builder for CfnSnapshot.

Method Summary

Modifier and Type	Method	Description
CfnSnapshot	build()
CfnSnapshot.Builder	cacheClusterId(String cacheClusterId)	The identifier of an existing cluster to create a snapshot from.
static CfnSnapshot.Builder	create(software.constructs.Construct scope, String id)
CfnSnapshot.Builder	kmsKeyId(String kmsKeyId)	The ID of the KMS key used to encrypt the snapshot.
CfnSnapshot.Builder	replicationGroupId(String replicationGroupId)	The identifier of an existing replication group to create a snapshot from.
CfnSnapshot.Builder	snapshotName(String snapshotName)	The name of a snapshot.
CfnSnapshot.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 CfnSnapshot.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 CfnSnapshot.Builder.

snapshotName

@Stability(Stable)
public CfnSnapshot.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

cacheClusterId

@Stability(Stable)
public CfnSnapshot.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 CfnSnapshot.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 CfnSnapshot.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

tags

@Stability(Stable)
public CfnSnapshot.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 CfnSnapshot build()

Specified by:

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

Returns:

a newly built instance of CfnSnapshot.