Package software.amazon.awscdk.services.cognito

Class UserPoolClientProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolClientProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolClientProps>

Enclosing interface:

UserPoolClientProps

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

A builder for UserPoolClientProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserPoolClientProps.Builder	accessTokenValidity(Duration accessTokenValidity)	Sets the value of UserPoolClientOptions.getAccessTokenValidity()
UserPoolClientProps.Builder	analytics(AnalyticsConfiguration analytics)	Sets the value of UserPoolClientOptions.getAnalytics()
UserPoolClientProps.Builder	authFlows(AuthFlow authFlows)	Sets the value of UserPoolClientOptions.getAuthFlows()
UserPoolClientProps.Builder	authSessionValidity(Duration authSessionValidity)	Sets the value of UserPoolClientOptions.getAuthSessionValidity()
UserPoolClientProps	build()	Builds the configured instance.
UserPoolClientProps.Builder	disableOAuth(Boolean disableOAuth)	Sets the value of UserPoolClientOptions.getDisableOAuth()
UserPoolClientProps.Builder	enablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)	Sets the value of UserPoolClientOptions.getEnablePropagateAdditionalUserContextData()
UserPoolClientProps.Builder	enableTokenRevocation(Boolean enableTokenRevocation)	Sets the value of UserPoolClientOptions.getEnableTokenRevocation()
UserPoolClientProps.Builder	generateSecret(Boolean generateSecret)	Sets the value of UserPoolClientOptions.getGenerateSecret()
UserPoolClientProps.Builder	idTokenValidity(Duration idTokenValidity)	Sets the value of UserPoolClientOptions.getIdTokenValidity()
UserPoolClientProps.Builder	oAuth(OAuthSettings oAuth)	Sets the value of UserPoolClientOptions.getOAuth()
UserPoolClientProps.Builder	preventUserExistenceErrors(Boolean preventUserExistenceErrors)	Sets the value of UserPoolClientOptions.getPreventUserExistenceErrors()
UserPoolClientProps.Builder	readAttributes(ClientAttributes readAttributes)	Sets the value of UserPoolClientOptions.getReadAttributes()
UserPoolClientProps.Builder	refreshTokenRotationGracePeriod(Duration refreshTokenRotationGracePeriod)	Sets the value of UserPoolClientOptions.getRefreshTokenRotationGracePeriod()
UserPoolClientProps.Builder	refreshTokenValidity(Duration refreshTokenValidity)	Sets the value of UserPoolClientOptions.getRefreshTokenValidity()
UserPoolClientProps.Builder	supportedIdentityProviders(List<? extends UserPoolClientIdentityProvider> supportedIdentityProviders)	Sets the value of UserPoolClientOptions.getSupportedIdentityProviders()
UserPoolClientProps.Builder	userPool(IUserPool userPool)	Sets the value of UserPoolClientProps.getUserPool()
UserPoolClientProps.Builder	userPoolClientName(String userPoolClientName)	Sets the value of UserPoolClientOptions.getUserPoolClientName()
UserPoolClientProps.Builder	writeAttributes(ClientAttributes writeAttributes)	Sets the value of UserPoolClientOptions.getWriteAttributes()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

userPool

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

Sets the value of UserPoolClientProps.getUserPool()

Parameters:

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

Returns:

this

accessTokenValidity

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

Sets the value of UserPoolClientOptions.getAccessTokenValidity()

Parameters:

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.

Returns:

this

analytics

@Stability(Stable)
public UserPoolClientProps.Builder analytics(AnalyticsConfiguration analytics)

Sets the value of UserPoolClientOptions.getAnalytics()

Parameters:

analytics - The analytics configuration for this client.

Returns:

this

authFlows

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

Sets the value of UserPoolClientOptions.getAuthFlows()

Parameters:

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

Returns:

this

authSessionValidity

@Stability(Stable)
public UserPoolClientProps.Builder authSessionValidity(Duration authSessionValidity)

Sets the value of UserPoolClientOptions.getAuthSessionValidity()

Parameters:

authSessionValidity - Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, in minutes, of that session token. see defaults in AuthSessionValidity. Valid duration is from 3 to 15 minutes.

Returns:

this

disableOAuth

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

Sets the value of UserPoolClientOptions.getDisableOAuth()

Parameters:

disableOAuth - Turns off all OAuth interactions for this client.

Returns:

this

enablePropagateAdditionalUserContextData

@Stability(Stable)
public UserPoolClientProps.Builder enablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)

Sets the value of UserPoolClientOptions.getEnablePropagateAdditionalUserContextData()

Parameters:

enablePropagateAdditionalUserContextData - Enable the propagation of additional user context data. You can only activate enablePropagateAdditionalUserContextData in an app client that has a client secret.

Returns:

this

enableTokenRevocation

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

Sets the value of UserPoolClientOptions.getEnableTokenRevocation()

Parameters:

enableTokenRevocation - Enable token revocation for this client.

Returns:

this

generateSecret

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

Sets the value of UserPoolClientOptions.getGenerateSecret()

Parameters:

generateSecret - Whether to generate a client secret.

Returns:

this

idTokenValidity

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

Sets the value of UserPoolClientOptions.getIdTokenValidity()

Parameters:

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.

Returns:

this

oAuth

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

Sets the value of UserPoolClientOptions.getOAuth()

Parameters:

oAuth - OAuth settings for this client to interact with the app. An error is thrown when this is specified and disableOAuth is set.

Returns:

this

preventUserExistenceErrors

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

Sets the value of UserPoolClientOptions.getPreventUserExistenceErrors()

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.

Returns:

this

readAttributes

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

Sets the value of UserPoolClientOptions.getReadAttributes()

Parameters:

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

Returns:

this

refreshTokenRotationGracePeriod

@Stability(Stable)
public UserPoolClientProps.Builder refreshTokenRotationGracePeriod(Duration refreshTokenRotationGracePeriod)

Sets the value of UserPoolClientOptions.getRefreshTokenRotationGracePeriod()

Parameters:

refreshTokenRotationGracePeriod - Enables refresh token rotation when set. Defines the grace period for the original refresh token (0-60 seconds).

Returns:

this

refreshTokenValidity

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

Sets the value of UserPoolClientOptions.getRefreshTokenValidity()

Parameters:

refreshTokenValidity - Validity of the refresh token. Values between 60 minutes and 10 years are valid.

Returns:

this

supportedIdentityProviders

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

Sets the value of UserPoolClientOptions.getSupportedIdentityProviders()

Parameters:

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

Returns:

this

userPoolClientName

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

Sets the value of UserPoolClientOptions.getUserPoolClientName()

Parameters:

userPoolClientName - Name of the application client.

Returns:

this

writeAttributes

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

Sets the value of UserPoolClientOptions.getWriteAttributes()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public UserPoolClientProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UserPoolClientProps

Throws:

NullPointerException - if any required attribute was not provided