Skip to content
v2.275.0

CfnSnapshotProps Struct ​

Properties for defining a CfnSnapshot.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_elasticache as elasticache } from 'aws-cdk-lib';
const cfnSnapshotProps: elasticache.CfnSnapshotProps = {
  snapshotName: 'snapshotName',

  // the properties below are optional
  cacheClusterId: 'cacheClusterId',
  kmsKeyId: 'kmsKeyId',
  replicationGroupId: 'replicationGroupId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

cacheClusterIdoptionalstringcache_cluster_idoptionalstrcacheClusterIdoptionalStringCacheClusterIdoptionalstringCacheClusterIdoptional*string#
The identifier of an existing cluster to create a snapshot from.

The snapshot is created from this cluster.

kmsKeyIdoptionalstringkms_key_idoptionalstrkmsKeyIdoptionalStringKmsKeyIdoptionalstringKmsKeyIdoptional*string#
The ID of the KMS key used to encrypt the snapshot.
replicationGroupIdoptionalstringreplication_group_idoptionalstrreplicationGroupIdoptionalStringReplicationGroupIdoptionalstringReplicationGroupIdoptional*string#
The identifier of an existing replication group to create a snapshot from.

The snapshot is created from this replication group.

snapshotNamestringsnapshot_namestrsnapshotNameStringSnapshotNamestringSnapshotName*stringrequired#
The name of a snapshot.

Must be unique within the customer account.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of tags to be added to this resource.