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());
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final UserPoolClientIdentityProvider
Allow users to sign in using 'Login With Amazon'.static final UserPoolClientIdentityProvider
Allow users to sign in using 'Sign In With Apple'.static final UserPoolClientIdentityProvider
Allow users to sign in directly as a user of the User Pool.static final UserPoolClientIdentityProvider
Allow users to sign in using 'Facebook Login'.static final UserPoolClientIdentityProvider
Allow users to sign in using 'Google Login'. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
UserPoolClientIdentityProvider
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
UserPoolClientIdentityProvider
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionSpecify a provider not yet supported by the CDK.getName()
The name of the identity provider as recognized by CloudFormation propertySupportedIdentityProviders
.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 Details
-
AMAZON
Allow users to sign in using 'Login With Amazon'.A
UserPoolIdentityProviderAmazon
must be attached to the user pool. -
APPLE
Allow users to sign in using 'Sign In With Apple'.A
UserPoolIdentityProviderApple
must be attached to the user pool. -
COGNITO
Allow users to sign in directly as a user of the User Pool. -
FACEBOOK
Allow users to sign in using 'Facebook Login'.A
UserPoolIdentityProviderFacebook
must be attached to the user pool. -
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 propertySupportedIdentityProviders
. This parameter is required.
-
getName
The name of the identity provider as recognized by CloudFormation propertySupportedIdentityProviders
.
-