stop_replication_to_replica¶
Operation¶
stop_replication_to_replica
¶
stop_replication_to_replica(request: StopReplicationToReplicaInput | StopReplicationToReplicaInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopReplicationToReplicaInputDict]) -> StopReplicationToReplicaOutput
Removes the link between a replica secret and its primary secret, and stops replication to the replica. You call this operation from the replica account or Region. Depending on the type of replica, the behavior is:
-
Cross-Region replica: promotes the replica to a standalone primary secret in the replica Region.
-
Cross-account replica: promotes the replica in your account to a standalone secret and stops replication from its primary secret in the other account. Secrets Manager updates the primary secret's replication status to
Detachedfor this replica.
To stop cross-account replication from the primary account instead, use DisassociateCrossAccountReplica.
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
cross-account replica secrets, you must also have
secretsmanager:DeleteResourcePolicy permissions. For more information,
see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StopReplicationToReplicaInput | StopReplicationToReplicaInputDict | 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[StopReplicationToReplicaInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StopReplicationToReplicaOutput
|
An instance of |
stop_replication_to_replica
async
¶
stop_replication_to_replica(request: StopReplicationToReplicaInput | StopReplicationToReplicaInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopReplicationToReplicaInputDict]) -> StopReplicationToReplicaOutput
Removes the link between a replica secret and its primary secret, and stops replication to the replica. You call this operation from the replica account or Region. Depending on the type of replica, the behavior is:
-
Cross-Region replica: promotes the replica to a standalone primary secret in the replica Region.
-
Cross-account replica: promotes the replica in your account to a standalone secret and stops replication from its primary secret in the other account. Secrets Manager updates the primary secret's replication status to
Detachedfor this replica.
To stop cross-account replication from the primary account instead, use DisassociateCrossAccountReplica.
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
cross-account replica secrets, you must also have
secretsmanager:DeleteResourcePolicy permissions. For more information,
see IAM policy actions for Secrets
Manager
and Authentication and access control in Secrets
Manager.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StopReplicationToReplicaInput | StopReplicationToReplicaInputDict | 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[StopReplicationToReplicaInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StopReplicationToReplicaOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
StopReplicationToReplicaInputDict
¶
Bases: TypedDict
Dictionary form of StopReplicationToReplicaInput.
Attributes¶
secret_id
instance-attribute
¶
The ARN or name of the replica secret.
For a cross-region replica, the replica ARN is the same as the original primary secret ARN except that the Region is changed to the replica Region. For a cross-account replica, this is the ARN or name of the replica secret in your account.
StopReplicationToReplicaInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StopReplicationToReplicaInput structure.
Attributes¶
secret_id
class-attribute
instance-attribute
¶
secret_id: str | None = ...
The ARN or name of the replica secret.
For a cross-region replica, the replica ARN is the same as the original primary secret ARN except that the Region is changed to the replica Region. For a cross-account replica, this is the ARN or name of the replica secret in your account.
Output¶
StopReplicationToReplicaOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StopReplicationToReplicaOutput structure.
Attributes¶
arn
class-attribute
instance-attribute
¶
arn: str | None = ...
The ARN of the promoted secret. For a cross-region replica, this ARN is the same as the original primary secret's ARN except that the Region is changed. For a cross-account replica, this is the ARN of the promoted secret in your account.
response_metadata
class-attribute
instance-attribute
¶
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.