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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.685Z")
 @Stability(value=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());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static UserPoolClientIdentityProvider	AMAZON Allow users to sign in using 'Login With Amazon'.
static UserPoolClientIdentityProvider	APPLE Allow users to sign in using 'Sign In With Apple'.
static UserPoolClientIdentityProvider	COGNITO Allow users to sign in directly as a user of the User Pool.
static UserPoolClientIdentityProvider	FACEBOOK Allow users to sign in using 'Facebook Login'.
static UserPoolClientIdentityProvider	GOOGLE Allow users to sign in using 'Google Login'.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserPoolClientIdentityProvider(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolClientIdentityProvider(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static UserPoolClientIdentityProvider	custom(String name) Specify a provider not yet supported by the CDK.
String	getName() The name of the identity provider as recognized by CloudFormation property `SupportedIdentityProviders`.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

AMAZON

@Stability(value=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(value=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(value=Stable)
public static final UserPoolClientIdentityProvider COGNITO

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

FACEBOOK

@Stability(value=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(value=Stable)
public static final UserPoolClientIdentityProvider GOOGLE

Allow users to sign in using 'Google Login'.

A UserPoolIdentityProviderGoogle must be attached to the user pool.

Constructor Detail

UserPoolClientIdentityProvider

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

UserPoolClientIdentityProvider

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

Method Detail

custom

@Stability(value=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(value=Stable)
 @NotNull
public String getName()

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