interface IdentityPoolProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.IdentityPool.IdentityPoolProps
Java	software.amazon.awscdk.services.cognito.identitypool.IdentityPoolProps
Python	aws_cdk.aws_cognito_identitypool.IdentityPoolProps
TypeScript (source)	@aws-cdk/aws-cognito-identitypool » IdentityPoolProps

Props for the IdentityPool construct.

Example

declare const openIdConnectProvider: iam.OpenIdConnectProvider;
new IdentityPool(this, 'myidentitypool', {
  identityPoolName: 'myidentitypool',
  authenticationProviders: {
    google: {
      clientId: '12345678012.apps.googleusercontent.com',
    },
    openIdConnectProviders: [openIdConnectProvider],
    customProvider: 'my-custom-provider.example.com',
  },
});

Properties

Name	Type	Description
allowClassicFlow?🔹	boolean	Enables the Basic (Classic) authentication flow.
allowUnauthenticatedIdentities?🔹	boolean	Wwhether the identity pool supports unauthenticated logins.
authenticatedRole?🔹	IRole	The Default Role to be assumed by Authenticated Users.
authenticationProviders?🔹	IdentityPoolAuthenticationProviders	Authentication providers for using in identity pool.
identityPoolName?🔹	string	The name of the Identity Pool.
roleMappings?🔹	IdentityPoolRoleMapping[]	Rules for mapping roles to users.
unauthenticatedRole?🔹	IRole	The Default Role to be assumed by Unauthenticated Users.

---

allowClassicFlow?🔹

Type: boolean (optional, default: Classic Flow not allowed)

Enables the Basic (Classic) authentication flow.

---

allowUnauthenticatedIdentities?🔹

Type: boolean (optional, default: false)

Wwhether the identity pool supports unauthenticated logins.

---

authenticatedRole?🔹

Type: IRole (optional, default: A Default Authenticated Role will be added)

The Default Role to be assumed by Authenticated Users.

---

authenticationProviders?🔹

Type: IdentityPoolAuthenticationProviders (optional, default: No Authentication Providers passed directly to Identity Pool)

Authentication providers for using in identity pool.

---

identityPoolName?🔹

Type: string (optional, default: automatically generated name by CloudFormation at deploy time)

The name of the Identity Pool.

---

roleMappings?🔹

Type: IdentityPoolRoleMapping[] (optional, default: no Role Mappings)

Rules for mapping roles to users.

---

unauthenticatedRole?🔹

Type: IRole (optional, default: A Default Unauthenticated Role will be added)

The Default Role to be assumed by Unauthenticated Users.