aws-cdk-lib.aws_memorydb.CfnMultiRegionClusterProps

CfnMultiRegionClusterProps Struct

Properties for defining a CfnMultiRegionCluster.

CfnMultiRegionClusterProps

used as props by

• CfnMultiRegionCluster

Source

Generated code

Type last changed

v2.173.0 · 12 Dec 2024

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_memorydb as memorydb } from 'aws-cdk-lib';
const cfnMultiRegionClusterProps: memorydb.CfnMultiRegionClusterProps = {
  nodeType: 'nodeType',

  // the properties below are optional
  description: 'description',
  engine: 'engine',
  engineVersion: 'engineVersion',
  multiRegionClusterNameSuffix: 'multiRegionClusterNameSuffix',
  multiRegionParameterGroupName: 'multiRegionParameterGroupName',
  numShards: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tlsEnabled: false,
  updateStrategy: 'updateStrategy',
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

The description of the multi-Region cluster.

enginestringenginestrengineStringEnginestringEngine*string#

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

engineVersionstringengine_versionstrengineVersionStringEngineVersionstringEngineVersion*string#

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

multiRegionClusterNameSuffixstringmulti_region_cluster_name_suffixstrmultiRegionClusterNameSuffixStringMultiRegionClusterNameSuffixstringMultiRegionClusterNameSuffix*string#

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

notes

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.

multiRegionParameterGroupNamestringmulti_region_parameter_group_namestrmultiRegionParameterGroupNameStringMultiRegionParameterGroupNamestringMultiRegionParameterGroupName*string#

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

nodeTypestringnode_typestrnodeTypeStringNodeTypestringNodeType*stringrequired#

The node type used by the multi-Region cluster.

numShardsnumbernum_shardsint | floatnumShardsNumberNumShardsdoubleNumShards*float64#

The number of shards in the multi-Region cluster.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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

tlsEnabledboolean | IResolvabletls_enabledtyping.Union[bool, IResolvable]tlsEnabledBooleanTlsEnabledboolTlsEnabledinterface{}#

Indiciates if the multi-Region cluster is TLS enabled.

updateStrategystringupdate_strategystrupdateStrategyStringUpdateStrategystringUpdateStrategy*string#

The strategy to use for the update operation.

Supported values are "coordinated" or "uncoordinated".