MemoryDB / Client / create_multi_region_cluster

create_multi_region_cluster

MemoryDB.Client.create_multi_region_cluster(**kwargs)

Creates a new multi-Region cluster.

See also: AWS API Documentation

Request Syntax

response = client.create_multi_region_cluster(
    MultiRegionClusterNameSuffix='string',
    Description='string',
    Engine='string',
    EngineVersion='string',
    NodeType='string',
    MultiRegionParameterGroupName='string',
    NumShards=123,
    TLSEnabled=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• MultiRegionClusterNameSuffix (string) –

  [REQUIRED]

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

• Description (string) – A description for the multi-Region cluster.

• Engine (string) – The name of the engine to be used for the multi-Region cluster.

• EngineVersion (string) – The version of the engine to be used for the multi-Region cluster.

• NodeType (string) –

  [REQUIRED]

  The node type to be used for the multi-Region cluster.

• MultiRegionParameterGroupName (string) – The name of the multi-Region parameter group to be associated with the cluster.

• NumShards (integer) – The number of shards for the multi-Region cluster.

• TLSEnabled (boolean) – Whether to enable TLS encryption for the multi-Region cluster.

• Tags (list) –

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

  • (dict) –

    A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources

    • Key (string) –

      The key for the tag. May not be null.

    • Value (string) –

      The tag’s value. May be null.

Return type:

dict

Returns:

Response Syntax

{
    'MultiRegionCluster': {
        'MultiRegionClusterName': 'string',
        'Description': 'string',
        'Status': 'string',
        'NodeType': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'NumberOfShards': 123,
        'Clusters': [
            {
                'ClusterName': 'string',
                'Region': 'string',
                'Status': 'string',
                'ARN': 'string'
            },
        ],
        'MultiRegionParameterGroupName': 'string',
        'TLSEnabled': True|False,
        'ARN': 'string'
    }
}

Response Structure

• (dict) –

  • MultiRegionCluster (dict) –

    Details about the newly created multi-Region cluster.

    • MultiRegionClusterName (string) –

      The name of the multi-Region cluster.

    • Description (string) –

      The description of the multi-Region cluster.

    • Status (string) –

      The current status of the multi-Region cluster.

    • NodeType (string) –

      The node type used by the multi-Region cluster.

    • Engine (string) –

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

    • EngineVersion (string) –

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

    • NumberOfShards (integer) –

      The number of shards in the multi-Region cluster.

    • Clusters (list) –

      The clusters in this multi-Region cluster.

      • (dict) –

        Represents a Regional cluster

        • ClusterName (string) –

          The name of the Regional cluster

        • Region (string) –

          The Region the current Regional cluster is assigned to.

        • Status (string) –

          The status of the Regional cluster.

        • ARN (string) –

          The Amazon Resource Name (ARN) the Regional cluster

    • MultiRegionParameterGroupName (string) –

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

    • TLSEnabled (boolean) –

      Indiciates if the multi-Region cluster is TLS enabled.

    • ARN (string) –

      The Amazon Resource Name (ARN) of the multi-Region cluster.

Exceptions

• MemoryDB.Client.exceptions.MultiRegionClusterAlreadyExistsFault

• MemoryDB.Client.exceptions.InvalidParameterCombinationException

• MemoryDB.Client.exceptions.InvalidParameterValueException

• MemoryDB.Client.exceptions.MultiRegionParameterGroupNotFoundFault

• MemoryDB.Client.exceptions.ClusterQuotaForCustomerExceededFault

• MemoryDB.Client.exceptions.TagQuotaPerResourceExceeded