Skip to content

CreateIdentityPoolInput

Source code in docs_src/capo_cognito_identity/types/create_identity_pool_input.py
class CreateIdentityPoolInput(TypedDict, closed=True):
    identity_pool_name: (
        "capo_cognito_identity.types.identity_pool_name.IdentityPoolName"
    )
    """<p>A string that you provide.</p>"""
    allow_unauthenticated_identities: "capo_cognito_identity.types.identity_pool_unauthenticated.IdentityPoolUnauthenticated"
    """<p>TRUE if the identity pool supports unauthenticated logins.</p>"""
    allow_classic_flow: NotRequired[
        "capo_cognito_identity.types.classic_flow.ClassicFlow"
    ]
    """<p>Enables or disables the Basic (Classic) authentication flow. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/authentication-flow.html">Identity Pools (Federated Identities) Authentication Flow</a> in the <i>Amazon Cognito Developer Guide</i>.</p>"""
    supported_login_providers: NotRequired[
        "capo_cognito_identity.types.identity_providers.IdentityProviders"
    ]
    """<p>Optional key:value pairs mapping provider names to provider app IDs.</p>"""
    developer_provider_name: NotRequired[
        "capo_cognito_identity.types.developer_provider_name.DeveloperProviderName"
    ]
    """<p>The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the <code>DeveloperProviderName</code>, you can use letters as well as period (<code>.</code>), underscore (<code>_</code>), and dash (<code>-</code>).</p> <p>Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.</p>"""
    open_id_connect_provider_ar_ns: NotRequired[
        "capo_cognito_identity.types.oidc_provider_list.OIDCProviderList"
    ]
    """<p>The Amazon Resource Names (ARN) of the OpenID Connect providers.</p>"""
    cognito_identity_providers: NotRequired[
        "capo_cognito_identity.types.cognito_identity_provider_list.CognitoIdentityProviderList"
    ]
    """<p>An array of Amazon Cognito user pools and their client IDs.</p>"""
    saml_provider_ar_ns: NotRequired[
        "capo_cognito_identity.types.saml_provider_list.SAMLProviderList"
    ]
    """<p>An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.</p>"""
    identity_pool_tags: NotRequired[
        "capo_cognito_identity.types.identity_pool_tags_type.IdentityPoolTagsType"
    ]
    """<p>Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.</p>"""

allow_classic_flow instance-attribute

allow_classic_flow: NotRequired[ClassicFlow]

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

allow_unauthenticated_identities instance-attribute

allow_unauthenticated_identities: IdentityPoolUnauthenticated

TRUE if the identity pool supports unauthenticated logins.

cognito_identity_providers instance-attribute

cognito_identity_providers: NotRequired[CognitoIdentityProviderList]

An array of Amazon Cognito user pools and their client IDs.

developer_provider_name instance-attribute

developer_provider_name: NotRequired[DeveloperProviderName]

The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

identity_pool_name instance-attribute

identity_pool_name: IdentityPoolName

A string that you provide.

identity_pool_tags instance-attribute

identity_pool_tags: NotRequired[IdentityPoolTagsType]

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

open_id_connect_provider_ar_ns instance-attribute

open_id_connect_provider_ar_ns: NotRequired[OIDCProviderList]

The Amazon Resource Names (ARN) of the OpenID Connect providers.

saml_provider_ar_ns instance-attribute

saml_provider_ar_ns: NotRequired[SAMLProviderList]

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

supported_login_providers instance-attribute

supported_login_providers: NotRequired[IdentityProviders]

Optional key:value pairs mapping provider names to provider app IDs.