class CfnCacheCluster (construct)

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

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.

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 cfnCacheCluster = new elasticache.CfnCacheCluster(this, 'MyCfnCacheCluster', {
  cacheNodeType: 'cacheNodeType',
  engine: 'engine',
  numCacheNodes: 123,

  // the properties below are optional
  autoMinorVersionUpgrade: false,
  azMode: 'azMode',
  cacheParameterGroupName: 'cacheParameterGroupName',
  cacheSecurityGroupNames: ['cacheSecurityGroupNames'],
  cacheSubnetGroupName: 'cacheSubnetGroupName',
  clusterName: 'clusterName',
  engineVersion: 'engineVersion',
  ipDiscovery: 'ipDiscovery',
  logDeliveryConfigurations: [{
    destinationDetails: {
      cloudWatchLogsDetails: {
        logGroup: 'logGroup',
      },
      kinesisFirehoseDetails: {
        deliveryStream: 'deliveryStream',
      },
    },
    destinationType: 'destinationType',
    logFormat: 'logFormat',
    logType: 'logType',
  }],
  networkType: 'networkType',
  notificationTopicArn: 'notificationTopicArn',
  port: 123,
  preferredAvailabilityZone: 'preferredAvailabilityZone',
  preferredAvailabilityZones: ['preferredAvailabilityZones'],
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  snapshotArns: ['snapshotArns'],
  snapshotName: 'snapshotName',
  snapshotRetentionLimit: 123,
  snapshotWindow: 'snapshotWindow',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  transitEncryptionEnabled: false,
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
});

Initializer

new CfnCacheCluster(scope: Construct, id: string, props: CfnCacheClusterProps)

Parameters

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

Construct Props

Name	Type	Description
cacheNodeType	`string`	The compute and memory capacity of the nodes in the node group (shard).
engine	`string`	The name of the cache engine to be used for this cluster.
numCacheNodes	`number`	The number of cache nodes that the cache cluster should have.
autoMinorVersionUpgrade?	`boolean \|` `IResolvable`	If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
azMode?	`string`	Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
cacheParameterGroupName?	`string`	The name of the parameter group to associate with this cluster.
cacheSecurityGroupNames?	`string[]`	A list of security group names to associate with this cluster.
cacheSubnetGroupName?	`string`	The name of the subnet group to be used for the cluster.
clusterName?	`string`	A name for the cache cluster.
engineVersion?	`string`	The version number of the cache engine to be used for this cluster.
ipDiscovery?	`string`	The network type you choose when modifying a cluster, either `ipv4`	`ipv6` .
logDeliveryConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `LogDeliveryConfigurationRequestProperty[]`	Specifies the destination, format and type of the logs.
networkType?	`string`	Must be either `ipv4`	`ipv6`	`dual_stack` .
notificationTopicArn?	`string`	The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
port?	`number`	The port number on which each of the cache nodes accepts connections.
preferredAvailabilityZone?	`string`	The EC2 Availability Zone in which the cluster is created.
preferredAvailabilityZones?	`string[]`	A list of the Availability Zones in which cache nodes are created.
preferredMaintenanceWindow?	`string`	Specifies the weekly time range during which maintenance on the cluster is performed.
snapshotArns?	`string[]`	A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
snapshotName?	`string`	The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
snapshotRetentionLimit?	`number`	The number of days for which ElastiCache retains automatic snapshots before deleting them.
snapshotWindow?	`string`	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
tags?	`CfnTag[]`	A list of tags to be added to this resource.
transitEncryptionEnabled?	`boolean \|` `IResolvable`	A flag that enables in-transit encryption when set to true.
vpcSecurityGroupIds?	`string[]`	One or more VPC security groups associated with the cluster.

cacheNodeType

Type: string

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. Changing the CacheNodeType of a Memcached instance is currently not supported. If you need to scale using Memcached, we recommend forcing a replacement update by changing the LogicalResourceId of the resource.

General purpose:
Current generation:

M6g node types: cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge , cache.m6g.12xlarge , cache.m6g.16xlarge , cache.m6g.24xlarge

M5 node types: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge

M4 node types: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge

T4g node types: cache.t4g.micro , cache.t4g.small , cache.t4g.medium

T3 node types: cache.t3.micro , cache.t3.small , cache.t3.medium

T2 node types: cache.t2.micro , cache.t2.small , cache.t2.medium

Previous generation: (not recommended)

T1 node types: cache.t1.micro

M1 node types: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge

M3 node types: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge

Compute optimized:
Previous generation: (not recommended)

C1 node types: cache.c1.xlarge

Memory optimized:
Current generation:

R6gd node types: cache.r6gd.xlarge , cache.r6gd.2xlarge , cache.r6gd.4xlarge , cache.r6gd.8xlarge , cache.r6gd.12xlarge , cache.r6gd.16xlarge

The r6gd family is available in the following regions: us-east-2 , us-east-1 , us-west-2 , us-west-1 , eu-west-1 , eu-central-1 , ap-northeast-1 , ap-southeast-1 , ap-southeast-2 .

R6g node types: cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge , cache.r6g.12xlarge , cache.r6g.16xlarge , cache.r6g.24xlarge

R5 node types: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge

R4 node types: cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , cache.r4.8xlarge , cache.r4.16xlarge

Previous generation: (not recommended)

M2 node types: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge

R3 node types: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge

For region availability, see Supported Node Types by Region

Additional node type info

All current generation instance types are created in Amazon VPC by default.
Valkey and Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.
Valkey and Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.
Redis OSS configuration variables appendonly and appendfsync are not supported on Redis OSS version 2.8.22 and later.

engine

Type: string

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | valkey | redis

numCacheNodes

Type: number

The number of cache nodes that the cache cluster should have.

However, if the PreferredAvailabilityZone and PreferredAvailabilityZones properties were not previously specified and you don't specify any new values, an update requires replacement .

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.

azMode?

Type: string (optional)

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

cacheParameterGroupName?

Type: string (optional)

The name of the parameter group to associate with this cluster.

If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

cacheSecurityGroupNames?

Type: string[] (optional)

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

cacheSubnetGroupName?

Type: string (optional)

The name of the subnet group to be used for the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see [AWS::ElastiCache::SubnetGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html) .

clusterName?

Type: string (optional)

A name for the cache cluster.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see Name Type .

The name must contain 1 to 50 alphanumeric characters or hyphens. The name must start with a letter and cannot end with a hyphen or contain two consecutive hyphens.

engineVersion?

Type: string (optional)

The version number of the cache engine to be used for this cluster.

To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version ), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

ipDiscovery?

Type: string (optional)

The network type you choose when modifying a cluster, either ipv4 | ipv6 .

IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system .

logDeliveryConfigurations?

Type: IResolvable | IResolvable | LogDeliveryConfigurationRequestProperty[] (optional)

Specifies the destination, format and type of the logs.

networkType?

Type: string (optional)

Must be either ipv4 | ipv6 | dual_stack .

IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 to 7.1 and Memcached engine version 1.6.6 and above on all instances built on the Nitro system .

notificationTopicArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

port?

Type: number (optional)

The port number on which each of the cache nodes accepts connections.

preferredAvailabilityZone?

Type: string (optional)

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones .

Default: System chosen Availability Zone.

preferredAvailabilityZones?

Type: string[] (optional)

A list of the Availability Zones in which cache nodes are created.

The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheNodes .

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

preferredMaintenanceWindow?

Type: string (optional)

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

It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

sun
mon
tue
wed
thu
fri
sat

Example: sun:23:00-mon:01:30

snapshotArns?

Type: string[] (optional)

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.

The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis .

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

snapshotName?

Type: string (optional)

The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).

The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis .

snapshotRetentionLimit?

Type: number (optional)

The number of days for which ElastiCache retains automatic snapshots before deleting them.

For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis .

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

snapshotWindow?

Type: string (optional)

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis .

tags?

Type: CfnTag[] (optional)

A list of tags to be added to this resource.

transitEncryptionEnabled?

Type: boolean | IResolvable (optional)

A flag that enables in-transit encryption when set to true.

vpcSecurityGroupIds?

Type: string[] (optional)

One or more VPC security groups associated with the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

Properties

Name	Type	Description
attrConfigurationEndpointAddress	`string`	The DNS hostname of the cache node.
attrConfigurationEndpointPort	`string`	The port number of the configuration endpoint for the Memcached cache cluster.
attrId	`string`	The resource name.
attrRedisEndpointAddress	`string`	The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.
attrRedisEndpointPort	`string`	The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.
cacheNodeType	`string`	The compute and memory capacity of the nodes in the node group (shard).
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
engine	`string`	The name of the cache engine to be used for this cluster.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
numCacheNodes	`number`	The number of cache nodes that the cache cluster should have.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
autoMinorVersionUpgrade?	`boolean \|` `IResolvable`	If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
azMode?	`string`	Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
cacheParameterGroupName?	`string`	The name of the parameter group to associate with this cluster.
cacheSecurityGroupNames?	`string[]`	A list of security group names to associate with this cluster.
cacheSubnetGroupName?	`string`	The name of the subnet group to be used for the cluster.
clusterName?	`string`	A name for the cache cluster.
engineVersion?	`string`	The version number of the cache engine to be used for this cluster.
ipDiscovery?	`string`	The network type you choose when modifying a cluster, either `ipv4`	`ipv6` .
logDeliveryConfigurations?	`IResolvable` `\|` `IResolvable` `\|` `LogDeliveryConfigurationRequestProperty[]`	Specifies the destination, format and type of the logs.
networkType?	`string`	Must be either `ipv4`	`ipv6`	`dual_stack` .
notificationTopicArn?	`string`	The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
port?	`number`	The port number on which each of the cache nodes accepts connections.
preferredAvailabilityZone?	`string`	The EC2 Availability Zone in which the cluster is created.
preferredAvailabilityZones?	`string[]`	A list of the Availability Zones in which cache nodes are created.
preferredMaintenanceWindow?	`string`	Specifies the weekly time range during which maintenance on the cluster is performed.
snapshotArns?	`string[]`	A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
snapshotName?	`string`	The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
snapshotRetentionLimit?	`number`	The number of days for which ElastiCache retains automatic snapshots before deleting them.
snapshotWindow?	`string`	The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
tagsRaw?	`CfnTag[]`	A list of tags to be added to this resource.
transitEncryptionEnabled?	`boolean \|` `IResolvable`	A flag that enables in-transit encryption when set to true.
vpcSecurityGroupIds?	`string[]`	One or more VPC security groups associated with the cluster.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrConfigurationEndpointAddress

Type: string

The DNS hostname of the cache node.

Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, Fn::GetAtt returns a value for this attribute only if the replication group is clustered. Otherwise, Fn::GetAtt fails.

attrConfigurationEndpointPort

Type: string

The port number of the configuration endpoint for the Memcached cache cluster.

Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore, Fn::GetAtt returns a value for this attribute only if the replication group is clustered. Otherwise, Fn::GetAtt fails.

attrId

Type: string

The resource name.

attrRedisEndpointAddress

Type: string

The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.

attrRedisEndpointPort

Type: string

The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.

cacheNodeType

Type: string

The compute and memory capacity of the nodes in the node group (shard).

cfnOptions

Type: ICfnResourceOptions

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

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

engine

Type: string

The name of the cache engine to be used for this cluster.

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.

numCacheNodes

Type: number

The number of cache nodes that the cache cluster should have.

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 }).

stack

Type: Stack

The stack in which this element is defined.

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

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

azMode?

Type: string (optional)

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

cacheParameterGroupName?

Type: string (optional)

The name of the parameter group to associate with this cluster.

cacheSecurityGroupNames?

Type: string[] (optional)

A list of security group names to associate with this cluster.

cacheSubnetGroupName?

Type: string (optional)

The name of the subnet group to be used for the cluster.

clusterName?

Type: string (optional)

A name for the cache cluster.

engineVersion?

Type: string (optional)

The version number of the cache engine to be used for this cluster.

ipDiscovery?

Type: string (optional)

The network type you choose when modifying a cluster, either ipv4 | ipv6 .

logDeliveryConfigurations?

Type: IResolvable | IResolvable | LogDeliveryConfigurationRequestProperty[] (optional)

Specifies the destination, format and type of the logs.

networkType?

Type: string (optional)

Must be either ipv4 | ipv6 | dual_stack .

notificationTopicArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

port?

Type: number (optional)

The port number on which each of the cache nodes accepts connections.

preferredAvailabilityZone?

Type: string (optional)

The EC2 Availability Zone in which the cluster is created.

preferredAvailabilityZones?

Type: string[] (optional)

A list of the Availability Zones in which cache nodes are created.

preferredMaintenanceWindow?

Type: string (optional)

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

snapshotArns?

Type: string[] (optional)

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.

snapshotName?

Type: string (optional)

The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).

snapshotRetentionLimit?

Type: number (optional)

The number of days for which ElastiCache retains automatic snapshots before deleting them.

snapshotWindow?

Type: string (optional)

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

tagsRaw?

Type: CfnTag[] (optional)

A list of tags to be added to this resource.

transitEncryptionEnabled?

Type: boolean | IResolvable (optional)

A flag that enables in-transit encryption when set to true.

vpcSecurityGroupIds?

Type: string[] (optional)

One or more VPC security groups associated with the cluster.

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.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
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 this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(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.
protected renderProperties(props)

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

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.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

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

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).

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:

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 this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

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

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.

protected renderProperties(props)

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

Parameters

props { [string]: any }

Returns

{ [string]: any }