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

Class UserPoolAuthenticationProvider.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.identitypool.UserPoolAuthenticationProvider.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolAuthenticationProvider>

Enclosing class:

UserPoolAuthenticationProvider

@Stability(Experimental)
public static final class UserPoolAuthenticationProvider.Builder
extends Object
implements software.amazon.jsii.Builder<UserPoolAuthenticationProvider>

(experimental) A fluent builder for UserPoolAuthenticationProvider.

Method Summary

Modifier and Type	Method	Description
UserPoolAuthenticationProvider	build()
static UserPoolAuthenticationProvider.Builder	create()
UserPoolAuthenticationProvider.Builder	disableServerSideTokenCheck(Boolean disableServerSideTokenCheck)	(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.
UserPoolAuthenticationProvider.Builder	userPool(IUserPool userPool)	(experimental) The User Pool of the Associated Identity Providers.
UserPoolAuthenticationProvider.Builder	userPoolClient(IUserPoolClient userPoolClient)	(experimental) The User Pool Client for the provided User Pool.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static UserPoolAuthenticationProvider.Builder create()

Returns:

a new instance of UserPoolAuthenticationProvider.Builder.

userPool

@Stability(Experimental)
public UserPoolAuthenticationProvider.Builder userPool(IUserPool userPool)

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

Parameters:

userPool - The User Pool of the Associated Identity Providers. This parameter is required.

Returns:

this

disableServerSideTokenCheck

@Stability(Experimental)
public UserPoolAuthenticationProvider.Builder disableServerSideTokenCheck(Boolean disableServerSideTokenCheck)

(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

Parameters:

disableServerSideTokenCheck - 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. This parameter is required.

Returns:

this

See Also:

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

userPoolClient

@Stability(Experimental)
public UserPoolAuthenticationProvider.Builder userPoolClient(IUserPoolClient userPoolClient)

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

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

Parameters:

userPoolClient - The User Pool Client for the provided User Pool. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public UserPoolAuthenticationProvider build()

Specified by:

build in interface software.amazon.jsii.Builder<UserPoolAuthenticationProvider>

Returns:

a newly built instance of UserPoolAuthenticationProvider.