Skip to content

Secrets Manager  >  Operations  >  stop_replication_to_replica

stop_replication_to_replica

Operation

stop_replication_to_replica async 

stop_replication_to_replica(input: StopReplicationToReplicaInput, plugins: list[Plugin] | None = None) -> StopReplicationToReplicaOutput

Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.

You must call this operation from the Region in which you want to promote the replica to a primary secret.

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:StopReplicationToReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameters:

Name Type Description Default
input StopReplicationToReplicaInput

An instance of StopReplicationToReplicaInput.

 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
StopReplicationToReplicaOutput

An instance of StopReplicationToReplicaOutput.

Input

StopReplicationToReplicaInput dataclass

Dataclass for StopReplicationToReplicaInput structure.

Attributes

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

The name of the secret or the replica ARN. The replica ARN is the same as the original primary secret ARN expect the Region is changed to the replica Region.

Output

StopReplicationToReplicaOutput dataclass

Dataclass for StopReplicationToReplicaOutput structure.

Attributes

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

The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.