AWS::MemoryDB::ClusterSpecifies a cluster . All nodes in the cluster run the same protocol-compliant engine software.
import { CfnCluster } from 'aws-cdk-lib/aws-memorydb';Or use the module namespace:
import * as memorydb from 'aws-cdk-lib/aws-memorydb';
// memorydb.CfnClusterConfiguration passed to the constructor as CfnClusterProps.
aclNameRequiredstringThe name of the Access Control List to associate with the cluster .
clusterNameRequiredstringThe name of the cluster .
nodeTypeRequiredstringThe cluster 's node type.
autoMinorVersionUpgradeOptionalboolean | IResolvableWhen set to true, the cluster will automatically receive minor engine version upgrades after launch.
clusterEndpointOptionalIResolvable | EndpointPropertyThe cluster 's configuration endpoint.
dataTieringOptionalstringEnables 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) .
descriptionOptionalstringA description of the cluster .
engineOptionalstringThe name of the engine used by the cluster.
engineVersionOptionalstringThe Redis engine version used by the cluster .
finalSnapshotNameOptionalstringThe 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.
ipDiscoveryOptionalstringThe 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.
kmsKeyIdOptionalstringThe ID of the KMS key used to encrypt the cluster .
maintenanceWindowOptionalstringSpecifies 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`
multiRegionClusterNameOptionalstringThe name of the multi-Region cluster that this cluster belongs to.
networkTypeOptionalstringThe 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.
numReplicasPerShardOptionalnumberThe number of replicas to apply to each shard. *Default value* : `1` *Maximum value* : `5`
numShardsOptionalnumberThe number of shards in the cluster .
parameterGroupNameOptionalstringThe name of the parameter group used by the cluster .
portOptionalnumberThe port used by the cluster .
securityGroupIdsOptionalstring | ISecurityGroupRef[]A list of security group names to associate with this cluster .
snapshotArnsOptionalstring[]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.
snapshotNameOptionalstringThe 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.
snapshotRetentionLimitOptionalnumberThe 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.
snapshotWindowOptionalstringThe 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.
snsTopicArnOptionalstringWhen 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`.
snsTopicStatusOptionalstringThe SNS topic must be in Active status to receive notifications.
subnetGroupNameOptionalstringThe name of the subnet group used by the cluster .
tagsOptionalCfnTag[]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) .
tlsEnabledOptionalboolean | IResolvableA flag to indicate if In-transit encryption is enabled.
This L1 construct maps directly to the following CloudFormation resource type.
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to Newsletteraws-memorydbAWS::MemoryDB::Cluster