CfnMultiRegionClusterProps

class aws_cdk.aws_memorydb.CfnMultiRegionClusterProps(*, node_type, description=None, engine=None, engine_version=None, multi_region_cluster_name_suffix=None, multi_region_parameter_group_name=None, num_shards=None, tags=None, tls_enabled=None, update_strategy=None)

Bases: object

Properties for defining a CfnMultiRegionCluster.

Parameters:

node_type (str) – The node type used by the multi-Region cluster.
description (Optional[str]) – The description of the multi-Region cluster.
engine (Optional[str]) – The name of the engine used by the multi-Region cluster.
engine_version (Optional[str]) – The version of the engine used by the multi-Region cluster.
multi_region_cluster_name_suffix (Optional[str]) – 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.
multi_region_parameter_group_name (Optional[str]) – The name of the multi-Region parameter group associated with the cluster.
num_shards (Union[int, float, None]) – TBD.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags to be applied to the multi-Region cluster.
tls_enabled (Union[bool, IResolvable, None]) – Indiciates if the multi-Region cluster is TLS enabled.
update_strategy (Optional[str]) – The strategy to use for the update operation. Supported values are “coordinated” or “uncoordinated”.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_memorydb as memorydb

cfn_multi_region_cluster_props = memorydb.CfnMultiRegionClusterProps(
    node_type="nodeType",

    # the properties below are optional
    description="description",
    engine="engine",
    engine_version="engineVersion",
    multi_region_cluster_name_suffix="multiRegionClusterNameSuffix",
    multi_region_parameter_group_name="multiRegionParameterGroupName",
    num_shards=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    tls_enabled=False,
    update_strategy="updateStrategy"
)

Attributes

description

The description of the multi-Region cluster.

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

engine

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

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

engine_version

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

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

multi_region_cluster_name_suffix

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.