AWS CDK Reference

Appearance

v2.274.0

UserPoolClientIdentityProvider Class ​

Identity providers supported by the UserPoolClient.

Source
aws-cognito/lib/user-pool-client.ts

Example ​

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

Properties ​

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

A UserPoolIdentityProviderAmazon must be attached to the user pool.

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

A UserPoolIdentityProviderApple must be attached to the user pool.

COGNITOUserPoolClientIdentityProvidercognitoUserPoolClientIdentityProviderCOGNITOUserPoolClientIdentityProviderCOGNITOUserPoolClientIdentityProviderCOGNITOUserPoolClientIdentityProviderrequiredstatic#
Allow users to sign in directly as a user of the User Pool.
FACEBOOKUserPoolClientIdentityProviderfacebookUserPoolClientIdentityProviderFACEBOOKUserPoolClientIdentityProviderFACEBOOKUserPoolClientIdentityProviderFACEBOOKUserPoolClientIdentityProviderrequiredstatic#
Allow users to sign in using 'Facebook Login'.

A UserPoolIdentityProviderFacebook must be attached to the user pool.

GOOGLEUserPoolClientIdentityProvidergoogleUserPoolClientIdentityProviderGOOGLEUserPoolClientIdentityProviderGOOGLEUserPoolClientIdentityProviderGOOGLEUserPoolClientIdentityProviderrequiredstatic#
Allow users to sign in using 'Google Login'.

A UserPoolIdentityProviderGoogle must be attached to the user pool.

namestringnamestrnameStringNamestringName*stringrequired#
The name of the identity provider as recognized by CloudFormation property `SupportedIdentityProviders`.

Methods ​

custom(name: string): UserPoolClientIdentityProvider // chainable@staticmethod def custom(name: str) -> UserPoolClientIdentityProviderpublic static UserPoolClientIdentityProvider custom(String name)public static UserPoolClientIdentityProvider Custom(string name)func Custom(Name *string) UserPoolClientIdentityProviderstatic#
Specify a provider not yet supported by the CDK.
1 parameter

Parameters

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