Package software.amazon.awscdk.services.memorydb

Interface CfnMultiRegionClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMultiRegionClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:22.320Z")
@Stability(Stable)
public interface CfnMultiRegionClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMultiRegionCluster.

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.*;
 CfnMultiRegionClusterProps cfnMultiRegionClusterProps = CfnMultiRegionClusterProps.builder()
         .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:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMultiRegionClusterProps.Builder	builder()
default String	getDescription()	The description of the multi-Region cluster.
default String	getEngine()	The name of the engine used by the multi-Region cluster.
default String	getEngineVersion()	The version of the engine used by the multi-Region cluster.
default String	getMultiRegionClusterNameSuffix()	A suffix to be added to the Multi-Region cluster name.
default String	getMultiRegionParameterGroupName()	The name of the multi-Region parameter group associated with the cluster.
String	getNodeType()	The node type used by the multi-Region cluster.
default Number	getNumShards()	TBD.
default List<CfnTag>	getTags()	A list of tags to be applied to the multi-Region cluster.
default Object	getTlsEnabled()	Indiciates if the multi-Region cluster is TLS enabled.
default String	getUpdateStrategy()	The strategy to use for the update operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNodeType

@Stability(Stable)
@NotNull
String getNodeType()

The node type used by the multi-Region cluster.

See Also:

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

getDescription

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

The description of the multi-Region cluster.

See Also:

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

getEngine

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

The name of the engine used by the multi-Region cluster.

See Also:

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

getEngineVersion

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

The version of the engine used by the multi-Region cluster.

See Also:

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

getMultiRegionClusterNameSuffix

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

A suffix to be added to the Multi-Region cluster name.

Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.

See Also:

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

getMultiRegionParameterGroupName

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

The name of the multi-Region parameter group associated with the cluster.

See Also:

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

getNumShards

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

TBD.

See Also:

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

getTags

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

A list of tags to be applied to the multi-Region cluster.

See Also:

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

getTlsEnabled

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

Indiciates if the multi-Region cluster is TLS enabled.

See Also:

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

getUpdateStrategy

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

The strategy to use for the update operation.

Supported values are "coordinated" or "uncoordinated".

See Also:

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

builder

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

Returns:

a CfnMultiRegionClusterProps.Builder of CfnMultiRegionClusterProps