Skip to content

disassociate_cross_account_replica

Operation

disassociate_cross_account_replica

disassociate_cross_account_replica(request: DisassociateCrossAccountReplicaInput | DisassociateCrossAccountReplicaInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisassociateCrossAccountReplicaInputDict]) -> DisassociateCrossAccountReplicaOutput

Removes the link between a primary secret in your account and a cross-account replica secret, and stops replication to the replica secret. Call this operation on the primary secret. This action removes the replica association created by AssociateCrossAccountReplica.

Disassociating the replica from the primary does not delete the replica secret or convert the replica secret to a standalone secret. The replica secret remains in the other account and its replication status changes to Detached. Secrets Manager no longer sends updates from the primary secret to the replica secret after disassociation. To convert a detached replica into a standalone secret, call StopReplicationToReplica on the replica secret.

You must disassociate a cross-account replica before you call DeleteSecret for the primary secret. The DeleteSecret call fails if any replicas are still associated with the 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:DisassociateCrossAccountReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameters:

Name Type Description Default
request DisassociateCrossAccountReplicaInput | DisassociateCrossAccountReplicaInputDict | 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[DisassociateCrossAccountReplicaInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DisassociateCrossAccountReplicaOutput

An instance of DisassociateCrossAccountReplicaOutput.

disassociate_cross_account_replica async

disassociate_cross_account_replica(request: DisassociateCrossAccountReplicaInput | DisassociateCrossAccountReplicaInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DisassociateCrossAccountReplicaInputDict]) -> DisassociateCrossAccountReplicaOutput

Removes the link between a primary secret in your account and a cross-account replica secret, and stops replication to the replica secret. Call this operation on the primary secret. This action removes the replica association created by AssociateCrossAccountReplica.

Disassociating the replica from the primary does not delete the replica secret or convert the replica secret to a standalone secret. The replica secret remains in the other account and its replication status changes to Detached. Secrets Manager no longer sends updates from the primary secret to the replica secret after disassociation. To convert a detached replica into a standalone secret, call StopReplicationToReplica on the replica secret.

You must disassociate a cross-account replica before you call DeleteSecret for the primary secret. The DeleteSecret call fails if any replicas are still associated with the 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:DisassociateCrossAccountReplica. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Parameters:

Name Type Description Default
request DisassociateCrossAccountReplicaInput | DisassociateCrossAccountReplicaInputDict | 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[DisassociateCrossAccountReplicaInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DisassociateCrossAccountReplicaOutput

An instance of DisassociateCrossAccountReplicaOutput.

Input

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

DisassociateCrossAccountReplicaInputDict

Bases: TypedDict

Dictionary form of DisassociateCrossAccountReplicaInput.

Attributes

cross_account_replica_arn instance-attribute
cross_account_replica_arn: Required[str]

The ARN of the cross-account replica secret to unlink from the primary secret.

secret_id instance-attribute
secret_id: Required[str]

The ARN or name of the primary secret in your account.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

DisassociateCrossAccountReplicaInput dataclass

Bases: _SerdeShape

Dataclass for DisassociateCrossAccountReplicaInput structure.

Attributes

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

The ARN of the cross-account replica secret to unlink from the primary secret.

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

The ARN or name of the primary secret in your account.

For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.

Output

DisassociateCrossAccountReplicaOutput dataclass

Bases: _SerdeShape

Dataclass for DisassociateCrossAccountReplicaOutput structure.

Attributes

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

The ARN of the primary secret.

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

The ARN of the replica secret that was unlinked from the primary secret.

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.