Package software.amazon.awscdk.services.cognito

Class UserPoolClientIdentityProvider

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cognito.UserPoolClientIdentityProvider
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2024-09-06T01:36:25.608Z") @Stability(Stable) public class UserPoolClientIdentityProvider extends software.amazon.jsii.JsiiObject
Identity providers supported by the UserPoolClient.

Example: 

 UserPool pool = new UserPool(this, "Pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .supportedIdentityProviders(List.of(UserPoolClientIdentityProvider.AMAZON, UserPoolClientIdentityProvider.COGNITO))
         .build());

  • Field Details

    • AMAZON

      @Stability(Stable) public static final UserPoolClientIdentityProvider AMAZON
      Allow users to sign in using 'Login With Amazon'.

      A UserPoolIdentityProviderAmazon must be attached to the user pool.

    • APPLE

      @Stability(Stable) public static final UserPoolClientIdentityProvider APPLE
      Allow users to sign in using 'Sign In With Apple'.

      A UserPoolIdentityProviderApple must be attached to the user pool.

    • COGNITO

      @Stability(Stable) public static final UserPoolClientIdentityProvider COGNITO
      Allow users to sign in directly as a user of the User Pool.

    • FACEBOOK

      @Stability(Stable) public static final UserPoolClientIdentityProvider FACEBOOK
      Allow users to sign in using 'Facebook Login'.

      A UserPoolIdentityProviderFacebook must be attached to the user pool.

    • GOOGLE

      @Stability(Stable) public static final UserPoolClientIdentityProvider GOOGLE
      Allow users to sign in using 'Google Login'.

      A UserPoolIdentityProviderGoogle must be attached to the user pool.

  • Constructor Details

    • UserPoolClientIdentityProvider

      protected UserPoolClientIdentityProvider(software.amazon.jsii.JsiiObjectRef objRef)

    • UserPoolClientIdentityProvider

      protected UserPoolClientIdentityProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • custom

      @Stability(Stable) @NotNull public static UserPoolClientIdentityProvider custom(@NotNull String name)
      Specify a provider not yet supported by the CDK.

      Parameters:
      name - name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders. This parameter is required.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the identity provider as recognized by CloudFormation property SupportedIdentityProviders.