UserPoolReplicaType

Contains information about a replica user pool, including Region, status, role, and ARN.

RegionName

The AWS Region where the replica is located.

Type: String

Length Constraints: Minimum length of 5. Maximum length of 32.

Required: No

Role

The role of the user pool replica that determines which API operations are enabled.

PRIMARY: The primary replica supports all end user and administrator operations.
SECONDARY: The secondary replica supports a limited set of end user and administrator operations. Generally, only administrator operations that set configurations specific to the replica, and only end-user operations that do not create or change attributes of a user are supported.

Type: String

Valid Values: PRIMARY | SECONDARY

Required: No

Status

The current status of the replica.

CREATING: The replica is being created.
INACTIVE: The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported.
ACTIVE: The replica is available for both end-user and administrator operations.
DELETING: The replica is being deleted.

Type: String

Valid Values: CREATING | ACTIVE | INACTIVE | DELETING

Required: No

UserPoolArn

The Amazon Resource Name (ARN) of the replica user pool.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Required: No

Contents