IdentityPoolProps

class aws_cdk.aws_cognito_identitypool.IdentityPoolProps(*, allow_classic_flow=None, allow_unauthenticated_identities=None, authenticated_role=None, authentication_providers=None, identity_pool_name=None, role_mappings=None, unauthenticated_role=None)

Bases: object

Props for the Identity Pool construct.

Parameters:

  • allow_classic_flow (Optional[bool]) – Enables the Basic (Classic) authentication flow. Default: - Classic Flow not allowed

  • allow_unauthenticated_identities (Optional[bool]) – Whether the Identity Pool supports unauthenticated logins. Default: - false

  • authenticated_role (Optional[IRole]) – The default Role to be assumed by authenticated users. Default: - A default authenticated Role will be added

  • authentication_providers (Union[IdentityPoolAuthenticationProviders, Dict[str, Any], None]) – Authentication Providers for using in Identity Pool. Default: - No Authentication Providers passed directly to Identity Pool

  • identity_pool_name (Optional[str]) – The name of the Identity Pool. Default: - Automatically generated name by CloudFormation at deploy time

  • role_mappings (Optional[Sequence[Union[IdentityPoolRoleMapping, Dict[str, Any]]]]) – Rules for mapping roles to users. Default: - no role mappings

  • unauthenticated_role (Optional[IRole]) – The default Role to be assumed by unauthenticated users. Default: - A default unauthenticated Role will be added

ExampleMetadata:

infused

Example:

# open_id_connect_provider: iam.OpenIdConnectProvider

IdentityPool(self, "myidentitypool",
    identity_pool_name="myidentitypool",
    authentication_providers=IdentityPoolAuthenticationProviders(
        google=IdentityPoolGoogleLoginProvider(
            client_id="12345678012.apps.googleusercontent.com"
        ),
        open_id_connect_providers=[open_id_connect_provider],
        custom_provider="my-custom-provider.example.com"
    )
)

Attributes

allow_classic_flow

Enables the Basic (Classic) authentication flow.

Default:

  • Classic Flow not allowed

allow_unauthenticated_identities

Whether the Identity Pool supports unauthenticated logins.

Default:

  • false

authenticated_role

The default Role to be assumed by authenticated users.

Default:

  • A default authenticated Role will be added

authentication_providers

Authentication Providers for using in Identity Pool.

Default:

  • No Authentication Providers passed directly to Identity Pool

identity_pool_name

The name of the Identity Pool.

Default:

  • Automatically generated name by CloudFormation at deploy time

role_mappings

Rules for mapping roles to users.

Default:

  • no role mappings

unauthenticated_role

The default Role to be assumed by unauthenticated users.

Default:

  • A default unauthenticated Role will be added