aws-cdk-lib.aws_cognito.UserPoolClientIdentityProvider

class UserPoolClientIdentityProvider

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolClientIdentityProvider
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolClientIdentityProvider
Javasoftware.amazon.awscdk.services.cognito.UserPoolClientIdentityProvider
Pythonaws_cdk.aws_cognito.UserPoolClientIdentityProvider
TypeScript (source)aws-cdk-lib » 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

NameTypeDescription
namestringThe name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.
static AMAZONUserPoolClientIdentityProviderAllow users to sign in using 'Login With Amazon'.
static APPLEUserPoolClientIdentityProviderAllow users to sign in using 'Sign In With Apple'.
static COGNITOUserPoolClientIdentityProviderAllow users to sign in directly as a user of the User Pool.
static FACEBOOKUserPoolClientIdentityProviderAllow users to sign in using 'Facebook Login'.
static GOOGLEUserPoolClientIdentityProviderAllow 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

NameDescription
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.