Package software.amazon.awscdk.cfnpropertymixins.services.memorydb

Interface CfnClusterMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:01.695Z")
@Stability(Stable)
public interface CfnClusterMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnClusterPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.memorydb.*;
 CfnClusterMixinProps cfnClusterMixinProps = CfnClusterMixinProps.builder()
         .aclName("aclName")
         .autoMinorVersionUpgrade(false)
         .clusterEndpoint(EndpointProperty.builder()
                 .address("address")
                 .port(123)
                 .build())
         .clusterName("clusterName")
         .dataTiering("dataTiering")
         .description("description")
         .engine("engine")
         .engineVersion("engineVersion")
         .finalSnapshotName("finalSnapshotName")
         .ipDiscovery("ipDiscovery")
         .kmsKeyId("kmsKeyId")
         .maintenanceWindow("maintenanceWindow")
         .multiRegionClusterName("multiRegionClusterName")
         .networkType("networkType")
         .nodeType("nodeType")
         .numReplicasPerShard(123)
         .numShards(123)
         .parameterGroupName("parameterGroupName")
         .port(123)
         .securityGroupIds(List.of("securityGroupIds"))
         .snapshotArns(List.of("snapshotArns"))
         .snapshotName("snapshotName")
         .snapshotRetentionLimit(123)
         .snapshotWindow("snapshotWindow")
         .snsTopicArn("snsTopicArn")
         .snsTopicStatus("snsTopicStatus")
         .subnetGroupName("subnetGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tlsEnabled(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnClusterMixinProps.Builder	A builder for CfnClusterMixinProps
static final class	CfnClusterMixinProps.Jsii$Proxy	An implementation for CfnClusterMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnClusterMixinProps.Builder	builder()
default String	getAclName()	The name of the Access Control List to associate with the cluster .
default Object	getAutoMinorVersionUpgrade()	When set to true, the cluster will automatically receive minor engine version upgrades after launch.
default Object	getClusterEndpoint()	The cluster 's configuration endpoint.
default String	getClusterName()	The name of the cluster .
default String	getDataTiering()	Enables data tiering.
default String	getDescription()	A description of the cluster .
default String	getEngine()	The name of the engine used by the cluster.
default String	getEngineVersion()	The Redis engine version used by the cluster .
default String	getFinalSnapshotName()	The user-supplied name of a final cluster snapshot.
default String	getIpDiscovery()	The mechanism that the cluster uses to discover IP addresses.
default String	getKmsKeyId()	The ID of the KMS key used to encrypt the cluster .
default String	getMaintenanceWindow()	Specifies the weekly time range during which maintenance on the cluster is performed.
default String	getMultiRegionClusterName()	The name of the multi-Region cluster that this cluster belongs to.
default String	getNetworkType()	The IP address type for the cluster.
default String	getNodeType()	The cluster 's node type.
default Number	getNumReplicasPerShard()	The number of replicas to apply to each shard.
default Number	getNumShards()	The number of shards in the cluster .
default String	getParameterGroupName()	The name of the parameter group used by the cluster .
default Number	getPort()	The port used by the cluster .
default List<Object>	getSecurityGroupIds()	A list of security group names to associate with this cluster .
default List<String>	getSnapshotArns()	A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
default String	getSnapshotName()	The name of a snapshot from which to restore data into the new cluster .
default Number	getSnapshotRetentionLimit()	The number of days for which MemoryDB retains automatic snapshots before deleting them.
default String	getSnapshotWindow()	The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
default String	getSnsTopicArn()	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.
default String	getSnsTopicStatus()	The SNS topic must be in Active status to receive notifications.
default String	getSubnetGroupName()	The name of the subnet group used by the cluster .
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default Object	getTlsEnabled()	A flag to indicate if In-transit encryption is enabled.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAclName

@Stability(Stable)
@Nullable
default String getAclName()

The name of the Access Control List to associate with the cluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-aclname

getAutoMinorVersionUpgrade

@Stability(Stable)
@Nullable
default Object getAutoMinorVersionUpgrade()

When set to true, the cluster will automatically receive minor engine version upgrades after launch.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-autominorversionupgrade

getClusterEndpoint

@Stability(Stable)
@Nullable
default Object getClusterEndpoint()

The cluster 's configuration endpoint.

Returns union: either IResolvable or CfnClusterPropsMixin.EndpointProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clusterendpoint

getClusterName

@Stability(Stable)
@Nullable
default String getClusterName()

The name of the cluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clustername

getDataTiering

@Stability(Stable)
@Nullable
default String getDataTiering()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-datatiering

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the cluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-description

getEngine

@Stability(Stable)
@Nullable
default String getEngine()

The name of the engine used by the cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engine

getEngineVersion

@Stability(Stable)
@Nullable
default String getEngineVersion()

The Redis engine version used by the cluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engineversion

getFinalSnapshotName

@Stability(Stable)
@Nullable
default String getFinalSnapshotName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-finalsnapshotname

getIpDiscovery

@Stability(Stable)
@Nullable
default String getIpDiscovery()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-ipdiscovery

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-kmskeyid

getMaintenanceWindow

@Stability(Stable)
@Nullable
default String getMaintenanceWindow()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-maintenancewindow

getMultiRegionClusterName

@Stability(Stable)
@Nullable
default String getMultiRegionClusterName()

The name of the multi-Region cluster that this cluster belongs to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-multiregionclustername

getNetworkType

@Stability(Stable)
@Nullable
default String getNetworkType()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-networktype

getNodeType

@Stability(Stable)
@Nullable
default String getNodeType()

The cluster 's node type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-nodetype

getNumReplicasPerShard

@Stability(Stable)
@Nullable
default Number getNumReplicasPerShard()

The number of replicas to apply to each shard.

Default value : 1

Maximum value : 5

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numreplicaspershard

getNumShards

@Stability(Stable)
@Nullable
default Number getNumShards()

The number of shards in the cluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numshards

getParameterGroupName

@Stability(Stable)
@Nullable
default String getParameterGroupName()

The name of the parameter group used by the cluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-parametergroupname

getPort

@Stability(Stable)
@Nullable
default Number getPort()

The port used by the cluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-port

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<Object> getSecurityGroupIds()

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

Returns union: Listinvalid input: '<'either String or ISecurityGroupRef>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-securitygroupids

getSnapshotArns

@Stability(Stable)
@Nullable
default List<String> getSnapshotArns()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotarns

getSnapshotName

@Stability(Stable)
@Nullable
default String getSnapshotName()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotname

getSnapshotRetentionLimit

@Stability(Stable)
@Nullable
default Number getSnapshotRetentionLimit()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotretentionlimit

getSnapshotWindow

@Stability(Stable)
@Nullable
default String getSnapshotWindow()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotwindow

getSnsTopicArn

@Stability(Stable)
@Nullable
default String getSnsTopicArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicarn

getSnsTopicStatus

@Stability(Stable)
@Nullable
default String getSnsTopicStatus()

The SNS topic must be in Active status to receive notifications.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicstatus

getSubnetGroupName

@Stability(Stable)
@Nullable
default String getSubnetGroupName()

The name of the subnet group used by the cluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-subnetgroupname

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tags

getTlsEnabled

@Stability(Stable)
@Nullable
default Object getTlsEnabled()

A flag to indicate if In-transit encryption is enabled.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tlsenabled

builder

@Stability(Stable)
static CfnClusterMixinProps.Builder builder()

Returns:

a CfnClusterMixinProps.Builder of CfnClusterMixinProps