update-replication-set¶

Description¶

Add or delete Regions from your replication set.

Synopsis¶

  update-replication-set
--actions <value>
--arn <value>
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--actions (list)

An action to add or delete a Region.

(structure)

Details used when updating the replication set.

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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

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

Table of Contents

Feedback

User Guide