Package software.amazon.awscdk.services.cognito

Class UserPoolClient.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolClient.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolClient>

Enclosing class:

UserPoolClient

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

A fluent builder for UserPoolClient.

Method Summary

Modifier and Type	Method	Description
UserPoolClient.Builder	accessTokenValidity(Duration accessTokenValidity)	Validity of the access token.
UserPoolClient.Builder	authFlows(AuthFlow authFlows)	The set of OAuth authentication flows to enable on the client.
UserPoolClient	build()
static UserPoolClient.Builder	create(software.constructs.Construct scope, String id)
UserPoolClient.Builder	disableOAuth(Boolean disableOAuth)	Turns off all OAuth interactions for this client.
UserPoolClient.Builder	enableTokenRevocation(Boolean enableTokenRevocation)	Enable token revocation for this client.
UserPoolClient.Builder	generateSecret(Boolean generateSecret)	Whether to generate a client secret.
UserPoolClient.Builder	idTokenValidity(Duration idTokenValidity)	Validity of the ID token.
UserPoolClient.Builder	oAuth(OAuthSettings oAuth)	OAuth settings for this client to interact with the app.
UserPoolClient.Builder	preventUserExistenceErrors(Boolean preventUserExistenceErrors)	Whether Cognito returns a UserNotFoundException exception when the user does not exist in the user pool (false), or whether it returns another type of error that doesn't reveal the user's absence.
UserPoolClient.Builder	readAttributes(ClientAttributes readAttributes)	The set of attributes this client will be able to read.
UserPoolClient.Builder	refreshTokenValidity(Duration refreshTokenValidity)	Validity of the refresh token.
UserPoolClient.Builder	supportedIdentityProviders(List<? extends UserPoolClientIdentityProvider> supportedIdentityProviders)	The list of identity providers that users should be able to use to sign in using this client.
UserPoolClient.Builder	userPool(IUserPool userPool)	The UserPool resource this client will have access to.
UserPoolClient.Builder	userPoolClientName(String userPoolClientName)	Name of the application client.
UserPoolClient.Builder	writeAttributes(ClientAttributes writeAttributes)	The set of attributes this client will be able to write.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static UserPoolClient.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of UserPoolClient.Builder.

accessTokenValidity

@Stability(Stable)
public UserPoolClient.Builder accessTokenValidity(Duration accessTokenValidity)

Validity of the access token.

Values between 5 minutes and 1 day are valid. The duration can not be longer than the refresh token validity.

Default: Duration.minutes(60)

Parameters:

accessTokenValidity - Validity of the access token. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/en_us/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html#amazon-cognito-user-pools-using-the-access-token

authFlows

@Stability(Stable)
public UserPoolClient.Builder authFlows(AuthFlow authFlows)

The set of OAuth authentication flows to enable on the client.

Default: - all auth flows disabled

Parameters:

authFlows - The set of OAuth authentication flows to enable on the client. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html

disableOAuth

@Stability(Stable)
public UserPoolClient.Builder disableOAuth(Boolean disableOAuth)

Turns off all OAuth interactions for this client.

Default: false

Parameters:

disableOAuth - Turns off all OAuth interactions for this client. This parameter is required.

Returns:

this

enableTokenRevocation

@Stability(Stable)
public UserPoolClient.Builder enableTokenRevocation(Boolean enableTokenRevocation)

Enable token revocation for this client.

Default: true for new user pool clients

Parameters:

enableTokenRevocation - Enable token revocation for this client. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html#enable-token-revocation

generateSecret

@Stability(Stable)
public UserPoolClient.Builder generateSecret(Boolean generateSecret)

Whether to generate a client secret.

Default: false

Parameters:

generateSecret - Whether to generate a client secret. This parameter is required.

Returns:

this

idTokenValidity

@Stability(Stable)
public UserPoolClient.Builder idTokenValidity(Duration idTokenValidity)

Validity of the ID token.

Values between 5 minutes and 1 day are valid. The duration can not be longer than the refresh token validity.

Default: Duration.minutes(60)

Parameters:

idTokenValidity - Validity of the ID token. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/en_us/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html#amazon-cognito-user-pools-using-the-id-token

oAuth

@Stability(Stable)
public UserPoolClient.Builder oAuth(OAuthSettings oAuth)

OAuth settings for this client to interact with the app.

An error is thrown when this is specified and disableOAuth is set.

Default: - see defaults in `OAuthSettings`. meaningless if `disableOAuth` is set.

Parameters:

oAuth - OAuth settings for this client to interact with the app. This parameter is required.

Returns:

this

preventUserExistenceErrors

@Stability(Stable)
public UserPoolClient.Builder preventUserExistenceErrors(Boolean preventUserExistenceErrors)

Whether Cognito returns a UserNotFoundException exception when the user does not exist in the user pool (false), or whether it returns another type of error that doesn't reveal the user's absence.

Default: false

Parameters:

preventUserExistenceErrors - Whether Cognito returns a UserNotFoundException exception when the user does not exist in the user pool (false), or whether it returns another type of error that doesn't reveal the user's absence. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-managing-errors.html

readAttributes

@Stability(Stable)
public UserPoolClient.Builder readAttributes(ClientAttributes readAttributes)

The set of attributes this client will be able to read.

Default: - all standard and custom attributes

Parameters:

readAttributes - The set of attributes this client will be able to read. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-attribute-permissions-and-scopes

refreshTokenValidity

@Stability(Stable)
public UserPoolClient.Builder refreshTokenValidity(Duration refreshTokenValidity)

Validity of the refresh token.

Values between 60 minutes and 10 years are valid.

Default: Duration.days(30)

Parameters:

refreshTokenValidity - Validity of the refresh token. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/en_us/cognito/latest/developerguide/amazon-cognito-user-pools-using-tokens-with-identity-providers.html#amazon-cognito-user-pools-using-the-refresh-token

supportedIdentityProviders

@Stability(Stable)
public UserPoolClient.Builder supportedIdentityProviders(List<? extends UserPoolClientIdentityProvider> supportedIdentityProviders)

The list of identity providers that users should be able to use to sign in using this client.

Default: - supports all identity providers that are registered with the user pool. If the user pool and/or identity providers are imported, either specify this option explicitly or ensure that the identity providers are registered with the user pool using the `UserPool.registerIdentityProvider()` API.

Parameters:

supportedIdentityProviders - The list of identity providers that users should be able to use to sign in using this client. This parameter is required.

Returns:

this

userPoolClientName

@Stability(Stable)
public UserPoolClient.Builder userPoolClientName(String userPoolClientName)

Name of the application client.

Default: - cloudformation generated name

Parameters:

userPoolClientName - Name of the application client. This parameter is required.

Returns:

this

writeAttributes

@Stability(Stable)
public UserPoolClient.Builder writeAttributes(ClientAttributes writeAttributes)

The set of attributes this client will be able to write.

Default: - all standard and custom attributes

Parameters:

writeAttributes - The set of attributes this client will be able to write. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#user-pool-settings-attribute-permissions-and-scopes

userPool

@Stability(Stable)
public UserPoolClient.Builder userPool(IUserPool userPool)

The UserPool resource this client will have access to.

Parameters:

userPool - The UserPool resource this client will have access to. This parameter is required.

Returns:

this

build

@Stability(Stable)
public UserPoolClient build()

Specified by:

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

Returns:

a newly built instance of UserPoolClient.