IdentityPool

class aws_cdk.aws_cognito_identitypool.IdentityPool(scope, id, *, 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: Resource

(experimental) Define a Cognito Identity Pool.

Stability:

experimental

Resource:

AWS::Cognito::IdentityPool

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"
    )
)
Parameters:

  • scope (Construct) –

  • id (str) –

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

  • allow_unauthenticated_identities (Optional[bool]) – (experimental) Wwhether the identity pool supports unauthenticated logins. Default: - false

  • authenticated_role (Optional[IRole]) – (experimental) 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]) – (experimental) Authentication providers for using in identity pool. Default: - No Authentication Providers passed directly to Identity Pool

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

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

  • unauthenticated_role (Optional[IRole]) – (experimental) The Default Role to be assumed by Unauthenticated Users. Default: - A Default Unauthenticated Role will be added

Stability:

experimental

Methods

add_role_mappings(*role_mappings)

(experimental) Adds Role Mappings to Identity Pool.

Parameters:

role_mappings (IdentityPoolRoleMapping) –

Stability:

experimental

Return type:

None

add_user_pool_authentication(user_pool)

(experimental) Add a User Pool to the IdentityPool and configure User Pool Client to handle identities.

Parameters:

user_pool (IUserPoolAuthenticationProvider) –

Stability:

experimental

Return type:

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

authenticated_role

(experimental) Default role for authenticated users.

Stability:

experimental

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

identity_pool_arn

(experimental) The ARN of the Identity Pool.

Stability:

experimental

Attribute:

true

identity_pool_id

GUID.

Stability:

experimental

Attribute:

true

Type:

(experimental) The id of the Identity Pool in the format REGION

identity_pool_name

(experimental) The name of the Identity Pool.

Stability:

experimental

Attribute:

true

node

The construct tree node associated with this construct.

stack

The stack in which this resource is defined.

unauthenticated_role

(experimental) Default role for unauthenticated users.

Stability:

experimental

Static Methods

classmethod from_identity_pool_arn(scope, id, identity_pool_arn)

(experimental) Import an existing Identity Pool from its Arn.

Parameters:

  • scope (Construct) –

  • id (str) –

  • identity_pool_arn (str) –

Stability:

experimental

Return type:

IIdentityPool

classmethod from_identity_pool_id(scope, id, identity_pool_id)

(experimental) Import an existing Identity Pool from its id.

Parameters:

  • scope (Construct) –

  • id (str) –

  • identity_pool_id (str) –

Stability:

experimental

Return type:

IIdentityPool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool