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 . ssm-incidents ]

update-replication-set

Description

Add or delete Regions from your replication set.

See also: AWS API Documentation

Synopsis

  update-replication-set
--actions <value>
--arn <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

--actions (list)

An action to add or delete a Region.

(tagged union structure)

Details used when updating the replication set.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: addRegionAction, deleteRegionAction.

addRegionAction -> (structure)

Details about the Amazon Web Services Region that you're adding to the replication set.

regionName -> (string)

The Amazon Web Services Region name to add to the replication set.

sseKmsKeyId -> (string)

The KMS key ID to use to encrypt your replication set.

deleteRegionAction -> (structure)

Details about the Amazon Web Services Region that you're deleting to the replication set.

regionName -> (string)

The name of the Amazon Web Services Region you're deleting from the replication set.

Shorthand Syntax:

addRegionAction={regionName=string,sseKmsKeyId=string},deleteRegionAction={regionName=string} ...

JSON Syntax:

[
  {
    "addRegionAction": {
      "regionName": "string",
      "sseKmsKeyId": "string"
    },
    "deleteRegionAction": {
      "regionName": "string"
    }
  }
  ...
]

--arn (string)

The Amazon Resource Name (ARN) of the replication set you're updating.

--client-token (string)

A token ensuring that the operation is called only once with the specified details.

--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.

--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.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update a replication set

The following command-name example deletes the us-east-2 Region from the replication set.

aws ssm-incidents update-replication-set \
    --arn "arn:aws:ssm-incidents::111122223333:replication-set/a2bcc5c9-0f53-8047-7fef-c20749989b40" \
    --actions '[{"deleteRegionAction": {"regionName": "us-east-2"}}]'

This command produces no output.

For more information, see Using the Incident Manager replication set in the Incident Manager User Guide.

Output

None