[ aws . secretsmanager ]



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.


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


--secret-id (string)

Use the Secret Id to replicate a secret to regions.

--add-replica-regions (list)

Add Regions to replicate the secret.


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


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 .


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.