Creates a replica of an existing user pool in a specified Amazon Web Services Region¶

Description¶

Creates a replica of an existing user pool in a specified Amazon Web Services Region. The replica enables multi-region replication for high availability and disaster recovery. To create a replica, you must have permissions to create user pools in the target 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_create_user_pool_replica(UserPoolId, RegionName,
  UserPoolTags)

Arguments¶

• UserPoolId

[required] The ID of the user pool to replicate.

• RegionName

[required] The Amazon Web Services Region where you want to create the replica user pool.

• UserPoolTags

A map of tags to assign to the replica user pool. Each tag consists of a key and an optional value, both of which you define. You can maintain tags independently on replica user pools.

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$create_user_pool_replica(
  UserPoolId = "string",
  RegionName = "string",
  UserPoolTags = list(
    "string"
  )
)