AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . dsql ]

create-multi-region-clusters

Description

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

Synopsis

  create-multi-region-clusters
--linked-region-list <value>
[--cluster-properties <value>]
--witness-region <value>
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--linked-region-list (list)

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

(string)

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

Syntax:

"string" "string" ...

--cluster-properties (map)

A mapping of properties to use when creating linked clusters.

key -> (string)

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

value -> (structure)

Properties of linked clusters.

deletionProtectionEnabled -> (boolean)

Whether deletion protection is enabled.

tags -> (map)

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

key -> (string)

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

value -> (string)

Tag value, maximum 256 Unicode characters in UTF-8

Shorthand Syntax:

KeyName1=deletionProtectionEnabled=boolean,tags={KeyName1=string,KeyName2=string},KeyName2=deletionProtectionEnabled=boolean,tags={KeyName1=string,KeyName2=string}

JSON Syntax:

{"string": {
      "deletionProtectionEnabled": true|false,
      "tags": {"string": "string"
        ...}
    }
  ...}

--witness-region (string)

The witness Region of multi-Region clusters.

--client-token (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

linkedClusterArns -> (list)

An array that contains the ARNs of all linked clusters.

(string)

Cluster ARN