Class UserPoolClientOptions.Jsii$Proxy
- All Implemented Interfaces:
UserPoolClientOptions
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
UserPoolClientOptions
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
ModifierConstructorDescriptionprotected
Jsii$Proxy
(UserPoolClientOptions.Builder builder) Constructor that initializes the object based on literal property values passed by theUserPoolClientOptions.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Duration
Validity of the access token.final AuthFlow
The set of OAuth authentication flows to enable on the client.final Duration
Cognito creates a session token for each API request in an authentication flow.final Boolean
Turns off all OAuth interactions for this client.final Boolean
Enable the propagation of additional user context data.final Boolean
Enable token revocation for this client.final Boolean
Whether to generate a client secret.final Duration
Validity of the ID token.final OAuthSettings
getOAuth()
OAuth settings for this client to interact with the app.final Boolean
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
The set of attributes this client will be able to read.final Duration
Validity of the refresh token.The list of identity providers that users should be able to use to sign in using this client.final String
Name of the application client.final ClientAttributes
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
-
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
Constructor that initializes the object based on literal property values passed by theUserPoolClientOptions.Builder
.
-
-
Method Details
-
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 interfaceUserPoolClientOptions
- See Also:
-
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 interfaceUserPoolClientOptions
- See Also:
-
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 interfaceUserPoolClientOptions
- See Also:
-
getDisableOAuth
Description copied from interface:UserPoolClientOptions
Turns off all OAuth interactions for this client.Default: false
- Specified by:
getDisableOAuth
in interfaceUserPoolClientOptions
-
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 interfaceUserPoolClientOptions
- See Also:
-
getEnableTokenRevocation
Description copied from interface:UserPoolClientOptions
Enable token revocation for this client.Default: true for new user pool clients
- Specified by:
getEnableTokenRevocation
in interfaceUserPoolClientOptions
- See Also:
-
getGenerateSecret
Description copied from interface:UserPoolClientOptions
Whether to generate a client secret.Default: false
- Specified by:
getGenerateSecret
in interfaceUserPoolClientOptions
-
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 interfaceUserPoolClientOptions
- See Also:
-
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 interfaceUserPoolClientOptions
-
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 interfaceUserPoolClientOptions
- See Also:
-
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 interfaceUserPoolClientOptions
- See Also:
-
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 interfaceUserPoolClientOptions
- See Also:
-
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 interfaceUserPoolClientOptions
-
getUserPoolClientName
Description copied from interface:UserPoolClientOptions
Name of the application client.Default: - cloudformation generated name
- Specified by:
getUserPoolClientName
in interfaceUserPoolClientOptions
-
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 interfaceUserPoolClientOptions
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-