UserPoolReplicaType
¶
Source code in docs_src/capo_cognito_identity_provider/types/user_pool_replica_type.py
region_name
instance-attribute
¶
region_name: NotRequired[RegionNameType]
The Amazon Web Services Region where the replica is located.
role
instance-attribute
¶
role: NotRequired[ReplicaRoleType]
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.
status
instance-attribute
¶
status: NotRequired[ReplicaStatusType]
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.