# CfnClusterProps

Properties for defining a `CfnCluster`.

Extends: CfnClusterProps
Used as props by: CfnCluster

- Source: Generated code
- Type last changed: v2.227.0 · 21 Nov 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_memorydb as memorydb } from 'aws-cdk-lib';
const cfnClusterProps: memorydb.CfnClusterProps = {
  aclName: 'aclName',
  clusterName: 'clusterName',
  nodeType: 'nodeType',

  // the properties below are optional
  autoMinorVersionUpgrade: false,
  clusterEndpoint: {
    address: 'address',
    port: 123,
  },
  dataTiering: 'dataTiering',
  description: 'description',
  engine: 'engine',
  engineVersion: 'engineVersion',
  finalSnapshotName: 'finalSnapshotName',
  ipDiscovery: 'ipDiscovery',
  kmsKeyId: 'kmsKeyId',
  maintenanceWindow: 'maintenanceWindow',
  multiRegionClusterName: 'multiRegionClusterName',
  networkType: 'networkType',
  numReplicasPerShard: 123,
  numShards: 123,
  parameterGroupName: 'parameterGroupName',
  port: 123,
  securityGroupIds: ['securityGroupIds'],
  snapshotArns: ['snapshotArns'],
  snapshotName: 'snapshotName',
  snapshotRetentionLimit: 123,
  snapshotWindow: 'snapshotWindow',
  snsTopicArn: 'snsTopicArn',
  snsTopicStatus: 'snsTopicStatus',
  subnetGroupName: 'subnetGroupName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tlsEnabled: false,
};
```

## Properties

- `aclName`: string (required) — The name of the Access Control List to associate with the cluster .

- `autoMinorVersionUpgrade`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — When set to true, the cluster will automatically receive minor engine version upgrades after launch.

- `clusterEndpoint`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnCluster.EndpointProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_memorydb.CfnCluster.EndpointProperty.html) — The cluster 's configuration endpoint.

- `clusterName`: string (required) — The name of the cluster .

- `dataTiering`: string — Enables data tiering.

  Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html) .

- `description`: string — A description of the cluster .

- `engine`: string — The name of the engine used by the cluster.

- `engineVersion`: string — The Redis engine version used by the cluster .

- `finalSnapshotName`: string — The user-supplied name of a final cluster snapshot.

  This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.

- `ipDiscovery`: string — The mechanism that the cluster uses to discover IP addresses.

  Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.

- `kmsKeyId`: string — The ID of the KMS key used to encrypt the cluster .

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

  *Pattern* : `ddd:hh24:mi-ddd:hh24:mi`

- `multiRegionClusterName`: string — The name of the multi-Region cluster that this cluster belongs to.

- `networkType`: string — The IP address type for the cluster.

  Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.

- `nodeType`: string (required) — The cluster 's node type.

- `numReplicasPerShard`: number — The number of replicas to apply to each shard.

  *Default value* : `1`

  *Maximum value* : `5`

- `numShards`: number — The number of shards in the cluster .

- `parameterGroupName`: string — The name of the parameter group used by the cluster .

- `port`: number — The port used by the cluster .

- `securityGroupIds`: string | [ISecurityGroupRef](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_ec2.ISecurityGroupRef.html)[] — A list of security group names to associate with this cluster .

- `snapshotArns`: string[] — A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.

  The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.

- `snapshotName`: string — The name of a snapshot from which to restore data into the new cluster .

  The snapshot status changes to restoring while the new cluster is being created.

- `snapshotRetentionLimit`: number — The number of days for which MemoryDB retains automatic snapshots before deleting them.

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

- `snapshotWindow`: string — The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

  Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.

- `snsTopicArn`: string — When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.

- `snsTopicStatus`: string — The SNS topic must be in Active status to receive notifications.

- `subnetGroupName`: string — The name of the subnet group used by the cluster .

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — An array of key-value pairs to apply to this resource.

  For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

- `tlsEnabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — A flag to indicate if In-transit encryption is enabled.