Skip to content

UserPoolReplicaType

Source code in docs_src/capo_cognito_identity_provider/types/user_pool_replica_type.py
class UserPoolReplicaType(TypedDict, closed=True):
    region_name: NotRequired[
        "capo_cognito_identity_provider.types.region_name_type.RegionNameType"
    ]
    """<p>The Amazon Web Services Region where the replica is located.</p>"""
    status: NotRequired[
        "capo_cognito_identity_provider.types.replica_status_type.ReplicaStatusType"
    ]
    """<p>The current status of the replica.</p> <dl> <dt>CREATING</dt> <dd> <p>The replica is being created.</p> </dd> <dt>INACTIVE</dt> <dd> <p>The replica has been created, but is not accepting requests for end-users. Administrator configuration operations are supported.</p> </dd> <dt>ACTIVE</dt> <dd> <p>The replica is available for both end-user and administrator operations.</p> </dd> <dt>DELETING</dt> <dd> <p>The replica is being deleted.</p> </dd> </dl>"""
    role: NotRequired[
        "capo_cognito_identity_provider.types.replica_role_type.ReplicaRoleType"
    ]
    """<p>The role of the user pool replica that determines which API operations are enabled.</p> <dl> <dt>PRIMARY</dt> <dd> <p>The primary replica supports all end user and administrator operations.</p> </dd> <dt>SECONDARY</dt> <dd> <p>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. </p> </dd> </dl>"""
    user_pool_arn: NotRequired["capo_cognito_identity_provider.types.arn_type.ArnType"]
    """<p>The Amazon Resource Name (ARN) of the replica user pool.</p>"""

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.

user_pool_arn instance-attribute

user_pool_arn: NotRequired[ArnType]

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