class UserPoolClientIdentityProvider

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.UserPoolClientIdentityProvider`
Java	`software.amazon.awscdk.services.cognito.UserPoolClientIdentityProvider`
Python	`aws_cdk.aws_cognito.UserPoolClientIdentityProvider`
TypeScript (source)	`@aws-cdk/aws-cognito` » `UserPoolClientIdentityProvider`

Identity providers supported by the UserPoolClient.

Example

const pool = new cognito.UserPool(this, 'Pool');
pool.addClient('app-client', {
  // ...
  supportedIdentityProviders: [
    cognito.UserPoolClientIdentityProvider.AMAZON,
    cognito.UserPoolClientIdentityProvider.COGNITO,
  ],
});

Properties

Name	Type	Description
name	`string`	The name of the identity provider as recognized by CloudFormation property `SupportedIdentityProviders`.
static AMAZON	`UserPoolClientIdentityProvider`	Allow users to sign in using 'Login With Amazon'.
static APPLE	`UserPoolClientIdentityProvider`	Allow users to sign in using 'Sign In With Apple'.
static COGNITO	`UserPoolClientIdentityProvider`	Allow users to sign in directly as a user of the User Pool.
static FACEBOOK	`UserPoolClientIdentityProvider`	Allow users to sign in using 'Facebook Login'.
static GOOGLE	`UserPoolClientIdentityProvider`	Allow users to sign in using 'Google Login'.

name

Type: string

The name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.

static AMAZON

Type: UserPoolClientIdentityProvider

Allow users to sign in using 'Login With Amazon'.

A UserPoolIdentityProviderAmazon must be attached to the user pool.

static APPLE

Type: UserPoolClientIdentityProvider

Allow users to sign in using 'Sign In With Apple'.

A UserPoolIdentityProviderApple must be attached to the user pool.

static COGNITO

Type: UserPoolClientIdentityProvider

Allow users to sign in directly as a user of the User Pool.

static FACEBOOK

Type: UserPoolClientIdentityProvider

Allow users to sign in using 'Facebook Login'.

A UserPoolIdentityProviderFacebook must be attached to the user pool.

static GOOGLE

Type: UserPoolClientIdentityProvider

Allow users to sign in using 'Google Login'.

A UserPoolIdentityProviderGoogle must be attached to the user pool.

Methods

Name	Description
static custom(name)	Specify a provider not yet supported by the CDK.

static custom(name)

public static custom(name: string): UserPoolClientIdentityProvider

Parameters

name string — name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.

Returns

UserPoolClientIdentityProvider

Specify a provider not yet supported by the CDK.