Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

replicate-secret-to-regions

Description

Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  replicate-secret-to-regions
--secret-id <value>
--add-replica-regions <value>
[--force-overwrite-replica-secret | --no-force-overwrite-replica-secret]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--secret-id (string)

Use the Secret Id to replicate a secret to regions.

--add-replica-regions (list)

Add Regions to replicate the secret.

(structure)

(Optional) Custom type consisting of a Region (required) and the KmsKeyId which can be an ARN , Key ID , or Alias .

Region -> (string)

Describes a single instance of Region objects.

KmsKeyId -> (string)

Can be an ARN , Key ID , or Alias .

Shorthand Syntax:

Region=string,KmsKeyId=string ...

JSON Syntax:

[
  {
    "Region": "string",
    "KmsKeyId": "string"
  }
  ...
]

--force-overwrite-replica-secret | --no-force-overwrite-replica-secret (boolean)

(Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region.

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

See 'aws help' for descriptions of global parameters.

Output

ARN -> (string)

Replicate a secret based on the ReplicaRegionType consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.

ReplicationStatus -> (list)

Describes the secret replication status as PENDING , SUCCESS or FAIL .

(structure)

A replication object consisting of a RegionReplicationStatus object and includes a Region, KMSKeyId, status, and status message.

Region -> (string)

The Region where replication occurs.

KmsKeyId -> (string)

Can be an ARN , Key ID , or Alias .

Status -> (string)

The status can be InProgress , Failed , or InSync .

StatusMessage -> (string)

Status message such as "Secret with this name already exists in this region ".

LastAccessedDate -> (timestamp)

The date that you last accessed the secret in the Region.