Skip to content

Secrets Manager  >  Operations  >  replicate_secret_to_regions

replicate_secret_to_regions

Operation

replicate_secret_to_regions async

replicate_secret_to_regions(input: ReplicateSecretToRegionsInput, plugins: list[Plugin] | None = None) -> ReplicateSecretToRegionsOutput

Replicates the secret to a new Regions. See Multi-Region secrets.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:ReplicateSecretToRegions. If the primary secret is encrypted with a KMS key other than aws/secretsmanager, you also need kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS key other than aws/secretsmanager, you need kms:GenerateDataKey and kms:Encrypt to the key. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameters:

Name Type Description Default
input ReplicateSecretToRegionsInput

An instance of ReplicateSecretToRegionsInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ReplicateSecretToRegionsOutput

An instance of ReplicateSecretToRegionsOutput.

Input

ReplicateSecretToRegionsInput dataclass

Dataclass for ReplicateSecretToRegionsInput structure.

Attributes

add_replica_regions class-attribute instance-attribute
add_replica_regions: list[ReplicaRegionType] | None = None

A list of Regions in which to replicate the secret.

force_overwrite_replica_secret class-attribute instance-attribute
force_overwrite_replica_secret: bool = False

Specifies whether to overwrite a secret with the same name in the destination Region. By default, secrets aren't overwritten.

secret_id class-attribute instance-attribute
secret_id: str | None = None

The ARN or name of the secret to replicate.

Output

ReplicateSecretToRegionsOutput dataclass

Dataclass for ReplicateSecretToRegionsOutput structure.

Attributes

arn class-attribute instance-attribute
arn: str | None = None

The ARN of the primary secret.

replication_status class-attribute instance-attribute
replication_status: list[ReplicationStatusType] | None = None

The status of replication.