Package software.amazon.awscdk.services.memorydb

Class CfnMultiRegionCluster

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.CfnMultiRegionCluster
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMultiRegionClusterRef, ITaggableV2, 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.851Z") @Stability(Stable) public class CfnMultiRegionCluster extends CfnResource implements IInspectable, IMultiRegionClusterRef, ITaggableV2
Represents a multi-Region cluster.

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.*;
 CfnMultiRegionCluster cfnMultiRegionCluster = CfnMultiRegionCluster.Builder.create(this, "MyCfnMultiRegionCluster")
         .nodeType("nodeType")
         // the properties below are optional
         .description("description")
         .engine("engine")
         .engineVersion("engineVersion")
         .multiRegionClusterNameSuffix("multiRegionClusterNameSuffix")
         .multiRegionParameterGroupName("multiRegionParameterGroupName")
         .numShards(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tlsEnabled(false)
         .updateStrategy("updateStrategy")
         .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

    • CfnMultiRegionCluster

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

    • CfnMultiRegionCluster

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

    • CfnMultiRegionCluster

      @Stability(Stable) public CfnMultiRegionCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMultiRegionClusterProps props)
      Create a new AWS::MemoryDB::MultiRegionCluster.

      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

    • arnForMultiRegionCluster

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

    • isCfnMultiRegionCluster

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

      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()
      The Amazon Resource Name (ARN) of the multi-Region cluster.

    • getAttrMultiRegionClusterName

      @Stability(Stable) @NotNull public String getAttrMultiRegionClusterName()
      The name of the multi-Region cluster.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the multi-Region cluster.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getMultiRegionClusterRef

      @Stability(Stable) @NotNull public MultiRegionClusterReference getMultiRegionClusterRef()
      A reference to a MultiRegionCluster resource.
      Specified by:
      getMultiRegionClusterRef in interface IMultiRegionClusterRef

    • getNodeType

      @Stability(Stable) @NotNull public String getNodeType()
      The node type used by the multi-Region cluster.

    • setNodeType

      @Stability(Stable) public void setNodeType(@NotNull String value)
      The node type used by the multi-Region cluster.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the multi-Region cluster.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the multi-Region cluster.

    • getEngine

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

    • setEngine

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

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The version of the engine used by the multi-Region cluster.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The version of the engine used by the multi-Region cluster.

    • getMultiRegionClusterNameSuffix

      @Stability(Stable) @Nullable public String getMultiRegionClusterNameSuffix()
      A suffix to be added to the Multi-Region cluster name.

    • setMultiRegionClusterNameSuffix

      @Stability(Stable) public void setMultiRegionClusterNameSuffix(@Nullable String value)
      A suffix to be added to the Multi-Region cluster name.

    • getMultiRegionParameterGroupName

      @Stability(Stable) @Nullable public String getMultiRegionParameterGroupName()
      The name of the multi-Region parameter group associated with the cluster.

    • setMultiRegionParameterGroupName

      @Stability(Stable) public void setMultiRegionParameterGroupName(@Nullable String value)
      The name of the multi-Region parameter group associated with the cluster.

    • getNumShards

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

    • setNumShards

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

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags to be applied to the multi-Region cluster.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags to be applied to the multi-Region cluster.

    • getTlsEnabled

      @Stability(Stable) @Nullable public Object getTlsEnabled()
      Indiciates if the multi-Region cluster is TLS enabled.

      Returns union: either Boolean or IResolvable

    • setTlsEnabled

      @Stability(Stable) public void setTlsEnabled(@Nullable Boolean value)
      Indiciates if the multi-Region cluster is TLS enabled.

    • setTlsEnabled

      @Stability(Stable) public void setTlsEnabled(@Nullable IResolvable value)
      Indiciates if the multi-Region cluster is TLS enabled.

    • getUpdateStrategy

      @Stability(Stable) @Nullable public String getUpdateStrategy()
      The strategy to use for the update operation.

    • setUpdateStrategy

      @Stability(Stable) public void setUpdateStrategy(@Nullable String value)
      The strategy to use for the update operation.