Updates replica-specific settings for a user pool replica¶

Description¶

Updates replica-specific settings for a user pool replica. You can modify the status to activate or deactivate the replica. This request can be made in both primary and secondary regions of the user pool.

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_update_user_pool_replica(UserPoolId, RegionName,
  Status)

Arguments¶

• UserPoolId

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

• RegionName

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

• Status

[required] The status to set for the replica. Valid values are ACTIVE and INACTIVE.

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$update_user_pool_replica(
  UserPoolId = "string",
  RegionName = "string",
  Status = "ACTIVE"|"INACTIVE"
)