Package software.amazon.awscdk.services.cognito.identitypool.alpha

Interface UserPoolAuthenticationProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserPoolAuthenticationProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:25.268Z")
@Stability(Experimental)
public interface UserPoolAuthenticationProviderProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Props for the User Pool Authentication Provider.

Example:

 IdentityPool identityPool;
 UserPool userPool = new UserPool(this, "Pool");
 identityPool.addUserPoolAuthentication(UserPoolAuthenticationProvider.Builder.create()
         .userPool(userPool)
         .disableServerSideTokenCheck(true)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserPoolAuthenticationProviderProps.Builder	A builder for UserPoolAuthenticationProviderProps
static final class	UserPoolAuthenticationProviderProps.Jsii$Proxy	An implementation for UserPoolAuthenticationProviderProps

Method Summary

Modifier and Type	Method	Description
static UserPoolAuthenticationProviderProps.Builder	builder()
default Boolean	getDisableServerSideTokenCheck()	(experimental) Setting this to true turns off identity pool checks for this user pool to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.
IUserPool	getUserPool()	(experimental) The User Pool of the Associated Identity Providers.
default IUserPoolClient	getUserPoolClient()	(experimental) The User Pool Client for the provided User Pool.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserPool

@Stability(Experimental)
@NotNull
IUserPool getUserPool()

(experimental) The User Pool of the Associated Identity Providers.

getDisableServerSideTokenCheck

@Stability(Experimental)
@Nullable
default Boolean getDisableServerSideTokenCheck()

(experimental) Setting this to true turns off identity pool checks for this user pool to make sure the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

Default: false

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitoidentityprovider.html

getUserPoolClient

@Stability(Experimental)
@Nullable
default IUserPoolClient getUserPoolClient()

(experimental) The User Pool Client for the provided User Pool.

Default: - A default user pool client will be added to User Pool

builder

@Stability(Experimental)
static UserPoolAuthenticationProviderProps.Builder builder()

Returns:

a UserPoolAuthenticationProviderProps.Builder of UserPoolAuthenticationProviderProps