class CfnSnapshot (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.ElastiCache.CfnSnapshot`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awselasticache#CfnSnapshot`
Java	`software.amazon.awscdk.services.elasticache.CfnSnapshot`
Python	`aws_cdk.aws_elasticache.CfnSnapshot`
TypeScript	`aws-cdk-lib` » `aws_elasticache` » `CfnSnapshot`

Implements IConstruct, IDependable, IInspectable, ISnapshotRef, IEnvironmentAware, ITaggableV2

Represents a copy of an entire cluster or replication group as of the time when the snapshot was taken.

Example

// 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 cfnSnapshot = new elasticache.CfnSnapshot(this, 'MyCfnSnapshot', {
  snapshotName: 'snapshotName',

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

Initializer

new CfnSnapshot(scope: Construct, id: string, props: CfnSnapshotProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnSnapshotProps — Resource properties.

Create a new AWS::ElastiCache::Snapshot.

Construct Props

Name	Type	Description
snapshotName	`string`	The name of a snapshot.
cacheClusterId?	`string`	The identifier of an existing cluster to create a snapshot from.
kmsKeyId?	`string`	The ID of the KMS key used to encrypt the snapshot.
replicationGroupId?	`string`	The identifier of an existing replication group to create a snapshot from.
tags?	`CfnTag[]`	A list of tags to be added to this resource.

snapshotName

Type: string

The name of a snapshot.

Must be unique within the customer account.

cacheClusterId?

Type: string (optional)

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

The snapshot is created from this cluster.

kmsKeyId?

Type: string (optional)

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

replicationGroupId?

Type: string (optional)

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

The snapshot is created from this replication group.

tags?

Type: CfnTag[] (optional)

A list of tags to be added to this resource.

Properties

Name	Type	Description
attrArn	`string`	The ARN (Amazon Resource Name) of the snapshot.
attrAutoMinorVersionUpgrade	`IResolvable`	If true, opt-in to the next auto minor version upgrade campaign.
attrAutomaticFailover	`string`	Indicates the status of automatic failover for the source replication group.
attrCacheClusterCreateTime	`string`	The date and time when the source cluster was created.
attrCacheNodeType	`string`	The name of the compute and memory capacity node type for the source cluster.
attrCacheParameterGroupName	`string`	The cache parameter group that is associated with the source cluster.
attrCacheSubnetGroupName	`string`	The name of the cache subnet group associated with the source cluster.
attrDataTiering	`string`	Enables data tiering.
attrEngine	`string`	The name of the cache engine used by the source cluster.
attrEngineVersion	`string`	The version of the cache engine version used by the source cluster.
attrNodeSnapshots	`IResolvable`	A list of the cache nodes in the source cluster.
attrNumCacheNodes	`number`	The number of cache nodes in the source cluster.
attrNumNodeGroups	`number`	The number of node groups (shards) in this snapshot.
attrPort	`number`	The port number used by each cache nodes in the source cluster.
attrPreferredAvailabilityZone	`string`	The name of the Availability Zone in which the source cluster is located.
attrPreferredMaintenanceWindow	`string`	Specifies the weekly time range during which maintenance on the cluster is performed.
attrReplicationGroupDescription	`string`	A description of the source replication group.
attrSnapshotRetentionLimit	`number`	For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
attrSnapshotSource	`string`	Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
attrSnapshotStatus	`string`	The status of the snapshot.
attrSnapshotWindow	`string`	The daily time range during which ElastiCache takes daily snapshots of the source cluster.
attrTopicArn	`string`	The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
attrVpcId	`string`	The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
cdkTagManager	`TagManager`	Tag Manager which manages the tags for this resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnPropertyNames	`{ [string]: string }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
env	`ResourceEnvironment`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
snapshotName	`string`	The name of a snapshot.
snapshotRef	`SnapshotReference`	A reference to a Snapshot resource.
stack	`Stack`	The stack in which this element is defined.
cacheClusterId?	`string`	The identifier of an existing cluster to create a snapshot from.
kmsKeyId?	`string`	The ID of the KMS key used to encrypt the snapshot.
replicationGroupId?	`string`	The identifier of an existing replication group to create a snapshot from.
tags?	`CfnTag[]`	A list of tags to be added to this resource.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

The ARN (Amazon Resource Name) of the snapshot.

attrAutoMinorVersionUpgrade

Type: IResolvable

If true, opt-in to the next auto minor version upgrade campaign.

attrAutomaticFailover

Type: string

Indicates the status of automatic failover for the source replication group.

attrCacheClusterCreateTime

Type: string

The date and time when the source cluster was created.

attrCacheNodeType

Type: string

The name of the compute and memory capacity node type for the source cluster.

attrCacheParameterGroupName

Type: string

The cache parameter group that is associated with the source cluster.

attrCacheSubnetGroupName

Type: string

The name of the cache subnet group associated with the source cluster.

attrDataTiering

Type: string

Enables data tiering.

Data tiering is only supported for replication groups using the r6gd node type.

attrEngine

Type: string

The name of the cache engine used by the source cluster.

attrEngineVersion

Type: string

The version of the cache engine version used by the source cluster.

attrNodeSnapshots

Type: IResolvable

A list of the cache nodes in the source cluster.

attrNumCacheNodes

Type: number

The number of cache nodes in the source cluster.

attrNumNodeGroups

Type: number

The number of node groups (shards) in this snapshot.

attrPort

Type: number

The port number used by each cache nodes in the source cluster.

attrPreferredAvailabilityZone

Type: string

The name of the Availability Zone in which the source cluster is located.

attrPreferredMaintenanceWindow

Type: string

Specifies the weekly time range during which maintenance on the cluster is performed.

attrReplicationGroupDescription

Type: string

A description of the source replication group.

attrSnapshotRetentionLimit

Type: number

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

attrSnapshotSource

Type: string

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

attrSnapshotStatus

Type: string

The status of the snapshot.

attrSnapshotWindow

Type: string

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

attrTopicArn

Type: string

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

attrVpcId

Type: string

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnPropertyNames

Type: { [string]: string }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

env

Type: ResourceEnvironment

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

snapshotName

Type: string

The name of a snapshot.

snapshotRef

Type: SnapshotReference

A reference to a Snapshot resource.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

cacheClusterId?

Type: string (optional)

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

kmsKeyId?

Type: string (optional)

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

replicationGroupId?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

A list of tags to be added to this resource.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
addResourceDependency(target, reason?)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
applyCrossStackReferenceStrength(strength)	Sets the cross-stack reference strength for this resource.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
cfnPropertyName(cdkPropertyName)
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources and stacks this resource depends on.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)⚠️	Indicates that this resource no longer depends on another resource.
removeResourceDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.
protected renderProperties(props)
static arnForSnapshot(resource)
static isCfnSnapshot(x)	Checks whether the given object is a CfnSnapshot.

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)⚠️

public addDependency(target: CfnResource): void

⚠️ Deprecated: Use addResourceDependency instead.

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: Use addResourceDependency instead.

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

addResourceDependency(target, reason?)

public addResourceDependency(target: CfnResource, reason?: string): void

Parameters

target CfnResource
reason string

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength)

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

strength ReferenceStrength — - The reference strength to use for this resource.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

cfnPropertyName(cdkPropertyName)

public cfnPropertyName(cdkPropertyName: string): string

Parameters

cdkPropertyName string

Returns

string

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): (Stack &#124; CfnResource)[]

Returns

(Stack | CfnResource)[]

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)⚠️

public removeDependency(target: CfnResource): void

⚠️ Deprecated: Use removeResourceDependency instead

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target)

public removeResourceDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

mixins IMixin

Returns

IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }

static arnForSnapshot(resource)

public static arnForSnapshot(resource: ISnapshotRef): string

Parameters

resource ISnapshotRef

Returns

string

static isCfnSnapshot(x)

public static isCfnSnapshot(x: any): boolean

Parameters

x any

Returns

boolean

Checks whether the given object is a CfnSnapshot.