Skip to content

CognitoUserPoolConfigurationDetail

Source code in docs_src/capo_verifiedpermissions/types/cognito_user_pool_configuration_detail.py
class CognitoUserPoolConfigurationDetail(TypedDict, closed=True):
    user_pool_arn: "capo_verifiedpermissions.types.user_pool_arn.UserPoolArn"
    """<p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool that contains the identities to be authorized.</p> <p>Example: <code>"userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</code> </p>"""
    client_ids: "capo_verifiedpermissions.types.client_ids.ClientIds"
    """<p>The unique application client IDs that are associated with the specified Amazon Cognito user pool.</p> <p>Example: <code>"clientIds": ["&amp;ExampleCogClientId;"]</code> </p>"""
    issuer: "capo_verifiedpermissions.types.issuer.Issuer"
    """<p>The OpenID Connect (OIDC) <code>issuer</code> ID of the Amazon Cognito user pool that contains the identities to be authorized.</p> <p>Example: <code>"issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"</code> </p>"""
    group_configuration: NotRequired[
        "capo_verifiedpermissions.types.cognito_group_configuration_detail.CognitoGroupConfigurationDetail"
    ]
    """<p>The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.</p>"""

client_ids instance-attribute

client_ids: ClientIds

The unique application client IDs that are associated with the specified Amazon Cognito user pool.

Example: "clientIds": ["&ExampleCogClientId;"]

group_configuration instance-attribute

group_configuration: NotRequired[CognitoGroupConfigurationDetail]

The type of entity that a policy store maps to groups from an Amazon Cognito user pool identity source.

issuer instance-attribute

issuer: Issuer

The OpenID Connect (OIDC) issuer ID of the Amazon Cognito user pool that contains the identities to be authorized.

Example: "issuer": "https://cognito-idp.us-east-1.amazonaws.com/us-east-1_1a2b3c4d5"

user_pool_arn instance-attribute

user_pool_arn: UserPoolArn

The Amazon Resource Name (ARN) of the Amazon Cognito user pool that contains the identities to be authorized.

Example: "userPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"