SecretsManager / Client / stop_replication_to_replica

stop_replication_to_replica#

SecretsManager.Client.stop_replication_to_replica(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.stop_replication_to_replica(
    SecretId='string'
)
Parameters:

SecretId (string) –

[REQUIRED]

The ARN of the primary secret.

Return type:

dict

Returns:

Response Syntax

{
    'ARN': 'string'
}

Response Structure

  • (dict) –

    • ARN (string) –

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

Exceptions