Package software.amazon.awscdk.services.cognito

Class UserPoolClientOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.UserPoolClientOptions.Jsii$Proxy

All Implemented Interfaces:

UserPoolClientOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

UserPoolClientOptions

@Stability(Stable)
@Internal
public static final class UserPoolClientOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements UserPoolClientOptions

An implementation for UserPoolClientOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.UserPoolClientOptions

UserPoolClientOptions.Builder, UserPoolClientOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(UserPoolClientOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the UserPoolClientOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Duration	getAccessTokenValidity()	Validity of the access token.
final AnalyticsConfiguration	getAnalytics()	The analytics configuration for this client.
final AuthFlow	getAuthFlows()	The set of OAuth authentication flows to enable on the client.
final Duration	getAuthSessionValidity()	Cognito creates a session token for each API request in an authentication flow.
final Boolean	getDisableOAuth()	Turns off all OAuth interactions for this client.
final Boolean	getEnablePropagateAdditionalUserContextData()	Enable the propagation of additional user context data.
final Boolean	getEnableTokenRevocation()	Enable token revocation for this client.
final Boolean	getGenerateSecret()	Whether to generate a client secret.
final Duration	getIdTokenValidity()	Validity of the ID token.
final OAuthSettings	getOAuth()	OAuth settings for this client to interact with the app.
final Boolean	getPreventUserExistenceErrors()	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.
final ClientAttributes	getReadAttributes()	The set of attributes this client will be able to read.
final Duration	getRefreshTokenRotationGracePeriod()	Enables refresh token rotation when set.
final Duration	getRefreshTokenValidity()	Validity of the refresh token.
final List<UserPoolClientIdentityProvider>	getSupportedIdentityProviders()	The list of identity providers that users should be able to use to sign in using this client.
final String	getUserPoolClientName()	Name of the application client.
final ClientAttributes	getWriteAttributes()	The set of attributes this client will be able to write.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(UserPoolClientOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the UserPoolClientOptions.Builder.

Method Details

getAccessTokenValidity

public final Duration getAccessTokenValidity()

Description copied from interface: UserPoolClientOptions

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)

Specified by:

getAccessTokenValidity in interface UserPoolClientOptions

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

getAnalytics

public final AnalyticsConfiguration getAnalytics()

Description copied from interface: UserPoolClientOptions

The analytics configuration for this client.

Default: - no analytics configuration

Specified by:

getAnalytics in interface UserPoolClientOptions

getAuthFlows

public final AuthFlow getAuthFlows()

Description copied from interface: UserPoolClientOptions

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

Default: - If you don't specify a value, your user client supports ALLOW_REFRESH_TOKEN_AUTH, ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.

Specified by:

getAuthFlows in interface UserPoolClientOptions

See Also:

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

getAuthSessionValidity

public final Duration getAuthSessionValidity()

Description copied from interface: UserPoolClientOptions

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.

Default: - Duration.minutes(3)

Specified by:

getAuthSessionValidity in interface UserPoolClientOptions

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html#cfn-cognito-userpoolclient-authsessionvalidity

getDisableOAuth

public final Boolean getDisableOAuth()

Description copied from interface: UserPoolClientOptions

Turns off all OAuth interactions for this client.

Default: false

Specified by:

getDisableOAuth in interface UserPoolClientOptions

getEnablePropagateAdditionalUserContextData

public final Boolean getEnablePropagateAdditionalUserContextData()

Description copied from interface: UserPoolClientOptions

Enable the propagation of additional user context data.

You can only activate enablePropagateAdditionalUserContextData in an app client that has a client secret.

Default: false for new user pool clients

Specified by:

getEnablePropagateAdditionalUserContextData in interface UserPoolClientOptions

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-device-fingerprint

getEnableTokenRevocation

public final Boolean getEnableTokenRevocation()

Description copied from interface: UserPoolClientOptions

Enable token revocation for this client.

Default: true for new user pool clients

Specified by:

getEnableTokenRevocation in interface UserPoolClientOptions

See Also:

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

getGenerateSecret

public final Boolean getGenerateSecret()

Description copied from interface: UserPoolClientOptions

Whether to generate a client secret.

Default: false

Specified by:

getGenerateSecret in interface UserPoolClientOptions

getIdTokenValidity

public final Duration getIdTokenValidity()

Description copied from interface: UserPoolClientOptions

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)

Specified by:

getIdTokenValidity in interface UserPoolClientOptions

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

getOAuth

public final OAuthSettings getOAuth()

Description copied from interface: UserPoolClientOptions

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.

Specified by:

getOAuth in interface UserPoolClientOptions

getPreventUserExistenceErrors

public final Boolean getPreventUserExistenceErrors()

Description copied from interface: UserPoolClientOptions

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

Specified by:

getPreventUserExistenceErrors in interface UserPoolClientOptions

See Also:

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

getReadAttributes

public final ClientAttributes getReadAttributes()

Description copied from interface: UserPoolClientOptions

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

Default: - all standard and custom attributes

Specified by:

getReadAttributes in interface UserPoolClientOptions

See Also:

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

getRefreshTokenRotationGracePeriod

public final Duration getRefreshTokenRotationGracePeriod()

Description copied from interface: UserPoolClientOptions

Enables refresh token rotation when set.

Defines the grace period for the original refresh token (0-60 seconds).

Default: - undefined (refresh token rotation is disabled)

Specified by:

getRefreshTokenRotationGracePeriod in interface UserPoolClientOptions

See Also:

• https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-using-the-refresh-token.html#using-the-refresh-token-rotation

getRefreshTokenValidity

public final Duration getRefreshTokenValidity()

Description copied from interface: UserPoolClientOptions

Validity of the refresh token.

Values between 60 minutes and 10 years are valid.

Default: Duration.days(30)

Specified by:

getRefreshTokenValidity in interface UserPoolClientOptions

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

getSupportedIdentityProviders

public final List<UserPoolClientIdentityProvider> getSupportedIdentityProviders()

Description copied from interface: UserPoolClientOptions

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.

Specified by:

getSupportedIdentityProviders in interface UserPoolClientOptions

getUserPoolClientName

public final String getUserPoolClientName()

Description copied from interface: UserPoolClientOptions

Name of the application client.

Default: - cloudformation generated name

Specified by:

getUserPoolClientName in interface UserPoolClientOptions

getWriteAttributes

public final ClientAttributes getWriteAttributes()

Description copied from interface: UserPoolClientOptions

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

Default: - all standard and custom attributes

Specified by:

getWriteAttributes in interface UserPoolClientOptions

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object