Skip to content

CognitoUserPoolConfiguration

Source code in docs_src/capo_verifiedpermissions/types/cognito_user_pool_configuration.py 
15
16
17
18
19
20
21
22
23
class CognitoUserPoolConfiguration(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: NotRequired["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>"""
    group_configuration: NotRequired[
        "capo_verifiedpermissions.types.cognito_group_configuration.CognitoGroupConfiguration"
    ]
    """<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: NotRequired[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[CognitoGroupConfiguration]

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

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"