AuroraDSQL / Client / create_multi_region_clusters

create_multi_region_clusters#

AuroraDSQL.Client.create_multi_region_clusters(**kwargs)#

Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.

See also: AWS API Documentation

Request Syntax

response = client.create_multi_region_clusters(
    linkedRegionList=[
        'string',
    ],
    clusterProperties={
        'string': {
            'deletionProtectionEnabled': True|False,
            'tags': {
                'string': 'string'
            }
        }
    },
    witnessRegion='string',
    clientToken='string'
)
Parameters:

  • linkedRegionList (list) –

    [REQUIRED]

    An array of the Regions in which you want to create additional clusters.

    • (string) –

      AWS Region name (e.g.: ‘us-east-1’)

  • clusterProperties (dict) –

    A mapping of properties to use when creating linked clusters.

    • (string) –

      AWS Region name (e.g.: ‘us-east-1’)

      • (dict) –

        Properties of linked clusters.

        • deletionProtectionEnabled (boolean) –

          Whether deletion protection is enabled.

        • tags (dict) –

          A map of key and value pairs the linked cluster is tagged with.

          • (string) –

            Unique tag key, maximum 128 Unicode characters in UTF-8

            • (string) –

              Tag value, maximum 256 Unicode characters in UTF-8

  • witnessRegion (string) –

    [REQUIRED]

    The witness Region of multi-Region clusters.

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

    If you don’t specify a client token, the Amazon Web Services SDK automatically generates one.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'linkedClusterArns': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • linkedClusterArns (list) –

      An array that contains the ARNs of all linked clusters.

      • (string) –

        Cluster ARN

Exceptions