Package software.amazon.awscdk.services.memorydb

Class CfnCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.memorydb.CfnCluster
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IClusterRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:24.847Z") @Stability(Stable) public class CfnCluster extends CfnResource implements IInspectable, IClusterRef, ITaggable
Specifies a cluster .

All nodes in the cluster run the same protocol-compliant engine software.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.memorydb.*;
 CfnCluster cfnCluster = CfnCluster.Builder.create(this, "MyCfnCluster")
         .aclName("aclName")
         .clusterName("clusterName")
         .nodeType("nodeType")
         // the properties below are optional
         .autoMinorVersionUpgrade(false)
         .clusterEndpoint(EndpointProperty.builder()
                 .address("address")
                 .port(123)
                 .build())
         .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(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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCluster

      protected CfnCluster(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCluster

      protected CfnCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCluster

      @Stability(Stable) public CfnCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnClusterProps props)
      Create a new AWS::MemoryDB::Cluster.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForCluster

      @Stability(Stable) @NotNull public static String arnForCluster(@NotNull IClusterRef resource)
      Parameters:
      resource - This parameter is required.

    • fromClusterArn

      @Stability(Stable) @NotNull public static IClusterRef fromClusterArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IClusterRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromClusterName

      @Stability(Stable) @NotNull public static IClusterRef fromClusterName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String clusterName)
      Creates a new IClusterRef from a clusterName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      clusterName - This parameter is required.

    • isCfnCluster

      @Stability(Stable) @NotNull public static Boolean isCfnCluster(@NotNull Object x)
      Checks whether the given object is a CfnCluster.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the cluster , such as arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster.

    • getAttrClusterEndpointAddress

      @Stability(Stable) @NotNull public String getAttrClusterEndpointAddress()
      The address of the cluster 's configuration endpoint.

    • getAttrClusterEndpointPort

      @Stability(Stable) @NotNull public Number getAttrClusterEndpointPort()
      The port used by the cluster configuration endpoint.

    • getAttrParameterGroupStatus

      @Stability(Stable) @NotNull public String getAttrParameterGroupStatus()
      The status of the parameter group used by the cluster , for example active or applying .

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the cluster.

      For example, 'available', 'updating' or 'creating'.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getClusterRef

      @Stability(Stable) @NotNull public ClusterReference getClusterRef()
      A reference to a Cluster resource.
      Specified by:
      getClusterRef in interface IClusterRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAclName

      @Stability(Stable) @NotNull public String getAclName()
      The name of the Access Control List to associate with the cluster .

    • setAclName

      @Stability(Stable) public void setAclName(@NotNull String value)
      The name of the Access Control List to associate with the cluster .

    • getClusterName

      @Stability(Stable) @NotNull public String getClusterName()
      The name of the cluster .

    • setClusterName

      @Stability(Stable) public void setClusterName(@NotNull String value)
      The name of the cluster .

    • getNodeType

      @Stability(Stable) @NotNull public String getNodeType()
      The cluster 's node type.

    • setNodeType

      @Stability(Stable) public void setNodeType(@NotNull String value)
      The cluster 's node type.

    • getAutoMinorVersionUpgrade

      @Stability(Stable) @Nullable public Object getAutoMinorVersionUpgrade()
      When set to true, the cluster will automatically receive minor engine version upgrades after launch.

      Returns union: either Boolean or IResolvable

    • setAutoMinorVersionUpgrade

      @Stability(Stable) public void setAutoMinorVersionUpgrade(@Nullable Boolean value)
      When set to true, the cluster will automatically receive minor engine version upgrades after launch.

    • setAutoMinorVersionUpgrade

      @Stability(Stable) public void setAutoMinorVersionUpgrade(@Nullable IResolvable value)
      When set to true, the cluster will automatically receive minor engine version upgrades after launch.

    • getClusterEndpoint

      @Stability(Stable) @Nullable public Object getClusterEndpoint()
      The cluster 's configuration endpoint.

      Returns union: either IResolvable or CfnCluster.EndpointProperty

    • setClusterEndpoint

      @Stability(Stable) public void setClusterEndpoint(@Nullable IResolvable value)
      The cluster 's configuration endpoint.

    • setClusterEndpoint

      @Stability(Stable) public void setClusterEndpoint(@Nullable CfnCluster.EndpointProperty value)
      The cluster 's configuration endpoint.

    • getDataTiering

      @Stability(Stable) @Nullable public String getDataTiering()
      Enables data tiering.

    • setDataTiering

      @Stability(Stable) public void setDataTiering(@Nullable String value)
      Enables data tiering.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the cluster .

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the cluster .

    • getEngine

      @Stability(Stable) @Nullable public String getEngine()
      The name of the engine used by the cluster.

    • setEngine

      @Stability(Stable) public void setEngine(@Nullable String value)
      The name of the engine used by the cluster.

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The Redis engine version used by the cluster .

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The Redis engine version used by the cluster .

    • getFinalSnapshotName

      @Stability(Stable) @Nullable public String getFinalSnapshotName()
      The user-supplied name of a final cluster snapshot.

    • setFinalSnapshotName

      @Stability(Stable) public void setFinalSnapshotName(@Nullable String value)
      The user-supplied name of a final cluster snapshot.

    • getIpDiscovery

      @Stability(Stable) @Nullable public String getIpDiscovery()
      The mechanism that the cluster uses to discover IP addresses.

    • setIpDiscovery

      @Stability(Stable) public void setIpDiscovery(@Nullable String value)
      The mechanism that the cluster uses to discover IP addresses.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ID of the KMS key used to encrypt the cluster .

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ID of the KMS key used to encrypt the cluster .

    • getMaintenanceWindow

      @Stability(Stable) @Nullable public String getMaintenanceWindow()
      Specifies the weekly time range during which maintenance on the cluster is performed.

    • setMaintenanceWindow

      @Stability(Stable) public void setMaintenanceWindow(@Nullable String value)
      Specifies the weekly time range during which maintenance on the cluster is performed.

    • getMultiRegionClusterName

      @Stability(Stable) @Nullable public String getMultiRegionClusterName()
      The name of the multi-Region cluster that this cluster belongs to.

    • setMultiRegionClusterName

      @Stability(Stable) public void setMultiRegionClusterName(@Nullable String value)
      The name of the multi-Region cluster that this cluster belongs to.

    • getNetworkType

      @Stability(Stable) @Nullable public String getNetworkType()
      The IP address type for the cluster.

    • setNetworkType

      @Stability(Stable) public void setNetworkType(@Nullable String value)
      The IP address type for the cluster.

    • getNumReplicasPerShard

      @Stability(Stable) @Nullable public Number getNumReplicasPerShard()
      The number of replicas to apply to each shard.

    • setNumReplicasPerShard

      @Stability(Stable) public void setNumReplicasPerShard(@Nullable Number value)
      The number of replicas to apply to each shard.

    • getNumShards

      @Stability(Stable) @Nullable public Number getNumShards()
      The number of shards in the cluster .

    • setNumShards

      @Stability(Stable) public void setNumShards(@Nullable Number value)
      The number of shards in the cluster .

    • getParameterGroupName

      @Stability(Stable) @Nullable public String getParameterGroupName()
      The name of the parameter group used by the cluster .

    • setParameterGroupName

      @Stability(Stable) public void setParameterGroupName(@Nullable String value)
      The name of the parameter group used by the cluster .

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      The port used by the cluster .

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      The port used by the cluster .

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      A list of security group names to associate with this cluster .

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      A list of security group names to associate with this cluster .

    • getSnapshotArns

      @Stability(Stable) @Nullable public List<String> getSnapshotArns()
      A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.

    • setSnapshotArns

      @Stability(Stable) public void setSnapshotArns(@Nullable List<String> value)
      A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.

    • getSnapshotName

      @Stability(Stable) @Nullable public String getSnapshotName()
      The name of a snapshot from which to restore data into the new cluster .

    • setSnapshotName

      @Stability(Stable) public void setSnapshotName(@Nullable String value)
      The name of a snapshot from which to restore data into the new cluster .

    • getSnapshotRetentionLimit

      @Stability(Stable) @Nullable public Number getSnapshotRetentionLimit()
      The number of days for which MemoryDB retains automatic snapshots before deleting them.

    • setSnapshotRetentionLimit

      @Stability(Stable) public void setSnapshotRetentionLimit(@Nullable Number value)
      The number of days for which MemoryDB retains automatic snapshots before deleting them.

    • getSnapshotWindow

      @Stability(Stable) @Nullable public String getSnapshotWindow()
      The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

    • setSnapshotWindow

      @Stability(Stable) public void setSnapshotWindow(@Nullable String value)
      The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.

    • getSnsTopicArn

      @Stability(Stable) @Nullable public 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.

    • setSnsTopicArn

      @Stability(Stable) public void setSnsTopicArn(@Nullable String value)
      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.

    • getSnsTopicStatus

      @Stability(Stable) @Nullable public String getSnsTopicStatus()
      The SNS topic must be in Active status to receive notifications.

    • setSnsTopicStatus

      @Stability(Stable) public void setSnsTopicStatus(@Nullable String value)
      The SNS topic must be in Active status to receive notifications.

    • getSubnetGroupName

      @Stability(Stable) @Nullable public String getSubnetGroupName()
      The name of the subnet group used by the cluster .

    • setSubnetGroupName

      @Stability(Stable) public void setSubnetGroupName(@Nullable String value)
      The name of the subnet group used by the cluster .

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getTlsEnabled

      @Stability(Stable) @Nullable public Object getTlsEnabled()
      A flag to indicate if In-transit encryption is enabled.

      Returns union: either Boolean or IResolvable

    • setTlsEnabled

      @Stability(Stable) public void setTlsEnabled(@Nullable Boolean value)
      A flag to indicate if In-transit encryption is enabled.

    • setTlsEnabled

      @Stability(Stable) public void setTlsEnabled(@Nullable IResolvable value)
      A flag to indicate if In-transit encryption is enabled.