@aws-cdk_aws-cognito-identitypool-alpha.IdentityPoolProps

interface IdentityPoolProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Cognito.IdentityPool.Alpha.IdentityPoolProps
Gogithub.com/aws/aws-cdk-go/awscdkcognitoidentitypoolalpha/v2#IdentityPoolProps
Javasoftware.amazon.awscdk.services.cognito.identitypool.alpha.IdentityPoolProps
Pythonaws_cdk.aws_cognito_identitypool_alpha.IdentityPoolProps
TypeScript (source)@aws-cdk/aws-cognito-identitypool-alpha ยป 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

NameTypeDescription
allowClassicFlow?๐Ÿ”นbooleanEnables the Basic (Classic) authentication flow.
allowUnauthenticatedIdentities?๐Ÿ”นbooleanWwhether the identity pool supports unauthenticated logins.
authenticatedRole?๐Ÿ”นIRoleThe Default Role to be assumed by Authenticated Users.
authenticationProviders?๐Ÿ”นIdentityPoolAuthenticationProvidersAuthentication providers for using in identity pool.
identityPoolName?๐Ÿ”นstringThe name of the Identity Pool.
roleMappings?๐Ÿ”นIdentityPoolRoleMapping[]Rules for mapping roles to users.
unauthenticatedRole?๐Ÿ”นIRoleThe 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.