Deletes a secondary replica user pool¶

Description¶

Deletes a secondary replica user pool. You can only delete replicas that are in the INACTIVE status. This operation must be called from the primary Region.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests
• Using the Amazon Cognito user pools API and user pool endpoints

Usage¶

cognitoidentityprovider_delete_user_pool_replica(UserPoolId, RegionName)

Arguments¶

• UserPoolId

[required] The ID of the user pool that contains the replica to delete.

• RegionName

[required] The Amazon Web Services Region of the replica to delete.

Value¶

A list with the following syntax:

list(
  UserPoolReplica = list(
    RegionName = "string",
    Status = "CREATING"|"ACTIVE"|"INACTIVE"|"DELETING",
    Role = "PRIMARY"|"SECONDARY",
    UserPoolArn = "string"
  )
)

Request syntax¶

svc$delete_user_pool_replica(
  UserPoolId = "string",
  RegionName = "string"
)