Package software.amazon.awscdk.services.elasticache

Interface CfnSnapshotProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSnapshotProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T16:59:54.493Z")
@Stability(Stable)
public interface CfnSnapshotProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSnapshot.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.elasticache.*;
 CfnSnapshotProps cfnSnapshotProps = CfnSnapshotProps.builder()
         .snapshotName("snapshotName")
         // the properties below are optional
         .cacheClusterId("cacheClusterId")
         .kmsKeyId("kmsKeyId")
         .replicationGroupId("replicationGroupId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSnapshotProps.Builder	builder()
default String	getCacheClusterId()	The identifier of an existing cluster to create a snapshot from.
default String	getKmsKeyId()	The ID of the KMS key used to encrypt the snapshot.
default String	getReplicationGroupId()	The identifier of an existing replication group to create a snapshot from.
String	getSnapshotName()	The name of a snapshot.
default List<CfnTag>	getTags()	A list of tags to be added to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSnapshotName

@Stability(Stable)
@NotNull
String getSnapshotName()

The name of a snapshot.

Must be unique within the customer account.

See Also:

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

getCacheClusterId

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

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

The snapshot is created from this cluster.

See Also:

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

getKmsKeyId

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

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

See Also:

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

getReplicationGroupId

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

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

The snapshot is created from this replication group.

See Also:

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

getTags

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

A list of tags to be added to this resource.

See Also:

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

builder

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

Returns:

a CfnSnapshotProps.Builder of CfnSnapshotProps