IdentityPoolProps
- class aws_cdk.aws_cognito_identitypool_alpha.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
(experimental) Props for the IdentityPool construct.
- Parameters:
allow_classic_flow (
Optional
[bool
]) – (experimental) Enables the Basic (Classic) authentication flow. Default: - Classic Flow not allowedallow_unauthenticated_identities (
Optional
[bool
]) – (experimental) Wwhether the identity pool supports unauthenticated logins. Default: - falseauthenticated_role (
Optional
[IRole
]) – (experimental) The Default Role to be assumed by Authenticated Users. Default: - A Default Authenticated Role will be addedauthentication_providers (
Union
[IdentityPoolAuthenticationProviders
,Dict
[str
,Any
],None
]) – (experimental) Authentication providers for using in identity pool. Default: - No Authentication Providers passed directly to Identity Poolidentity_pool_name (
Optional
[str
]) – (experimental) The name of the Identity Pool. Default: - automatically generated name by CloudFormation at deploy timerole_mappings (
Optional
[Sequence
[Union
[IdentityPoolRoleMapping
,Dict
[str
,Any
]]]]) – (experimental) Rules for mapping roles to users. Default: - no Role Mappingsunauthenticated_role (
Optional
[IRole
]) – (experimental) The Default Role to be assumed by Unauthenticated Users. Default: - A Default Unauthenticated Role will be added
- Stability:
experimental
- 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
(experimental) Enables the Basic (Classic) authentication flow.
- Default:
Classic Flow not allowed
- Stability:
experimental
- allow_unauthenticated_identities
(experimental) Wwhether the identity pool supports unauthenticated logins.
- Default:
false
- Stability:
experimental
- authenticated_role
(experimental) The Default Role to be assumed by Authenticated Users.
- Default:
A Default Authenticated Role will be added
- Stability:
experimental
- authentication_providers
(experimental) Authentication providers for using in identity pool.
- Default:
No Authentication Providers passed directly to Identity Pool
- Stability:
experimental
- identity_pool_name
(experimental) The name of the Identity Pool.
- Default:
automatically generated name by CloudFormation at deploy time
- Stability:
experimental
- role_mappings
(experimental) Rules for mapping roles to users.
- Default:
no Role Mappings
- Stability:
experimental
- unauthenticated_role
(experimental) The Default Role to be assumed by Unauthenticated Users.
- Default:
A Default Unauthenticated Role will be added
- Stability:
experimental