Skip to content

replicate_secret_to_regions

Operation

replicate_secret_to_regions

replicate_secret_to_regions(request: ReplicateSecretToRegionsInput | ReplicateSecretToRegionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ReplicateSecretToRegionsInputDict]) -> 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
request ReplicateSecretToRegionsInput | ReplicateSecretToRegionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ReplicateSecretToRegionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ReplicateSecretToRegionsOutput

An instance of ReplicateSecretToRegionsOutput.

replicate_secret_to_regions async

replicate_secret_to_regions(request: ReplicateSecretToRegionsInput | ReplicateSecretToRegionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ReplicateSecretToRegionsInputDict]) -> 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
request ReplicateSecretToRegionsInput | ReplicateSecretToRegionsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ReplicateSecretToRegionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ReplicateSecretToRegionsOutput

An instance of ReplicateSecretToRegionsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ReplicateSecretToRegionsInputDict

Bases: TypedDict

Dictionary form of ReplicateSecretToRegionsInput.

Attributes

add_replica_regions instance-attribute

A list of Regions in which to replicate the secret.

force_overwrite_replica_secret instance-attribute
force_overwrite_replica_secret: bool | None

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

secret_id instance-attribute
secret_id: Required[str]

The ARN or name of the secret to replicate.

ReplicateSecretToRegionsInput dataclass

Bases: _SerdeShape

Dataclass for ReplicateSecretToRegionsInput structure.

Attributes

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

A list of Regions in which to replicate the secret.

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

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

The ARN or name of the secret to replicate.

Output

ReplicateSecretToRegionsOutput dataclass

Bases: _SerdeShape

Dataclass for ReplicateSecretToRegionsOutput structure.

Attributes

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

The ARN of the primary secret.

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

The status of replication.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.