# CfnCacheCluster

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

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnCacheCluster
Implements: IInspectable, ITaggable, IEnvironmentAware, ICacheClusterRef, IConstruct, IDependable

- CloudFormation: [`AWS::ElastiCache::CacheCluster`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-elasticache-cachecluster.html)
- Source: Generated code
- Type last changed: v2.254.0 · 13 May 2026

## 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 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

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

## Construct Props

- `autoMinorVersionUpgrade`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — 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.

  This parameter is only supported for Memcached clusters.

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

- `cacheNodeType`: string (required) — 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](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion)

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

- `cacheParameterGroupName`: string — 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`: string[] — this property has been deprecated

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

- `cacheSubnetGroupName`: string — 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`: string — A name for the cache cluster.

  If you don't specify a name, CloudFormation generates a unique physical ID and uses that ID for the cache cluster. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .

  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.

- `engine`: string (required) — The name of the cache engine to be used for this cluster.

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

- `engineVersion`: string — 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](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement) ), 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`: string — 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](https://docs.aws.amazon.com/ec2/nitro/) .

- `logDeliveryConfigurations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCacheCluster.LogDeliveryConfigurationRequestProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheCluster.LogDeliveryConfigurationRequestProperty.html)[] — Specifies the destination, format and type of the logs.

- `networkType`: string — 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](https://docs.aws.amazon.com/ec2/nitro/) .

- `notificationTopicArn`: string — 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.

- `numCacheNodes`: number (required) — 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) .

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

  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`: string[] — 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`: string — 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`: 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.

  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`: string — 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`: number — 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`: string — 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`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — A list of tags to be added to this resource.

- `transitEncryptionEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — A flag that enables in-transit encryption when set to true.

- `vpcSecurityGroupIds`: string[] — 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

- `attrConfigurationEndpoint`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html)

- `attrConfigurationEndpointAddress`: 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`: 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.

- `attrRedisEndpoint`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html)

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

- `autoMinorVersionUpgrade`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — 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.

- `cacheClusterRef`: [CacheClusterReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_elasticache.CacheClusterReference.html) — A reference to a CacheCluster resource.

- `cacheNodeType`: string — The compute and memory capacity of the nodes in the node group (shard).

- `cacheParameterGroupName`: string — The name of the parameter group to associate with this cluster.

- `cacheSecurityGroupNames`: string[] — this property has been deprecated

- `cacheSubnetGroupName`: string — The name of the subnet group to be used for the cluster.

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `clusterName`: string — A name for the cache cluster.

- `creationStack`: string[]

- `engine`: string — The name of the cache engine to be used for this cluster.

- `engineVersion`: string — The version number of the cache engine to be used for this cluster.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

- `ipDiscovery`: string — The network type you choose when modifying a cluster, either `ipv4` | `ipv6` .

- `logDeliveryConfigurations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCacheCluster.LogDeliveryConfigurationRequestProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache.CfnCacheCluster.LogDeliveryConfigurationRequestProperty.html)[] — Specifies the destination, format and type of the logs.

- `logicalId`: 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)`.

- `networkType`: string — Must be either `ipv4` | `ipv6` | `dual_stack` .

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `notificationTopicArn`: string — The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

- `numCacheNodes`: number — The number of cache nodes that the cache cluster should have.

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

- `ref`: 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 })`.

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

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined.

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

- `tags`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `tagsRaw`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — A list of tags to be added to this resource.

- `transitEncryptionEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — A flag that enables in-transit encryption when set to true.

- `vpcSecurityGroupIds`: string[] — One or more VPC security groups associated with the cluster.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  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: CfnResource): void` — Use `addResourceDependency` instead.

  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: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — 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,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "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.

  **Parameters**

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

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

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

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — 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: ReferenceStrength): void` — 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.

  **Parameters**

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

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — 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: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): 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.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnCacheCluster(x: any): boolean` (static) — Checks whether the given object is a CfnCacheCluster.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): 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: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

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

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

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

- `removeResourceDependency(target: CfnResource): void` — 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: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): 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.