public class UpdateUserPoolClientRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings using DescribeUserPoolClient.
If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
You can also use this operation to enable token revocation for user pool clients. For more information about revoking tokens, see RevokeToken.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
| Constructor and Description |
|---|
UpdateUserPoolClientRequest() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.Integer |
getAccessTokenValidity()
The access token time limit.
|
java.util.List<java.lang.String> |
getAllowedOAuthFlows()
The allowed OAuth flows.
|
java.lang.Boolean |
getAllowedOAuthFlowsUserPoolClient()
Set to
true to use OAuth 2.0 features in your user pool app
client. |
java.util.List<java.lang.String> |
getAllowedOAuthScopes()
The allowed OAuth scopes.
|
AnalyticsConfigurationType |
getAnalyticsConfiguration()
The Amazon Pinpoint analytics configuration necessary to collect metrics
for this user pool.
|
java.lang.Integer |
getAuthSessionValidity()
Amazon Cognito creates a session token for each API request in an
authentication flow.
|
java.util.List<java.lang.String> |
getCallbackURLs()
A list of allowed redirect (callback) URLs for the IdPs.
|
java.lang.String |
getClientId()
The ID of the client associated with the user pool.
|
java.lang.String |
getClientName()
The client name from the update user pool client request.
|
java.lang.String |
getDefaultRedirectURI()
The default redirect URI.
|
java.lang.Boolean |
getEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data.
|
java.lang.Boolean |
getEnableTokenRevocation()
Activates or deactivates token revocation.
|
java.util.List<java.lang.String> |
getExplicitAuthFlows()
The authentication flows that you want your user pool client to support.
|
java.lang.Integer |
getIdTokenValidity()
The ID token time limit.
|
java.util.List<java.lang.String> |
getLogoutURLs()
A list of allowed logout URLs for the IdPs.
|
java.lang.String |
getPreventUserExistenceErrors()
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
java.util.List<java.lang.String> |
getReadAttributes()
The read-only attributes of the user pool.
|
java.lang.Integer |
getRefreshTokenValidity()
The refresh token time limit.
|
java.util.List<java.lang.String> |
getSupportedIdentityProviders()
A list of provider names for the IdPs that this client supports.
|
TokenValidityUnitsType |
getTokenValidityUnits()
The time units you use when you set the duration of ID, access, and
refresh tokens.
|
java.lang.String |
getUserPoolId()
The user pool ID for the user pool where you want to update the user pool
client.
|
java.util.List<java.lang.String> |
getWriteAttributes()
The writeable attributes of the user pool.
|
int |
hashCode() |
java.lang.Boolean |
isAllowedOAuthFlowsUserPoolClient()
Set to
true to use OAuth 2.0 features in your user pool app
client. |
java.lang.Boolean |
isEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data.
|
java.lang.Boolean |
isEnableTokenRevocation()
Activates or deactivates token revocation.
|
void |
setAccessTokenValidity(java.lang.Integer accessTokenValidity)
The access token time limit.
|
void |
setAllowedOAuthFlows(java.util.Collection<java.lang.String> allowedOAuthFlows)
The allowed OAuth flows.
|
void |
setAllowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)
Set to
true to use OAuth 2.0 features in your user pool app
client. |
void |
setAllowedOAuthScopes(java.util.Collection<java.lang.String> allowedOAuthScopes)
The allowed OAuth scopes.
|
void |
setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration necessary to collect metrics
for this user pool.
|
void |
setAuthSessionValidity(java.lang.Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an
authentication flow.
|
void |
setCallbackURLs(java.util.Collection<java.lang.String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
void |
setClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
|
void |
setClientName(java.lang.String clientName)
The client name from the update user pool client request.
|
void |
setDefaultRedirectURI(java.lang.String defaultRedirectURI)
The default redirect URI.
|
void |
setEnablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data.
|
void |
setEnableTokenRevocation(java.lang.Boolean enableTokenRevocation)
Activates or deactivates token revocation.
|
void |
setExplicitAuthFlows(java.util.Collection<java.lang.String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
void |
setIdTokenValidity(java.lang.Integer idTokenValidity)
The ID token time limit.
|
void |
setLogoutURLs(java.util.Collection<java.lang.String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
void |
setPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
void |
setPreventUserExistenceErrors(java.lang.String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
void |
setReadAttributes(java.util.Collection<java.lang.String> readAttributes)
The read-only attributes of the user pool.
|
void |
setRefreshTokenValidity(java.lang.Integer refreshTokenValidity)
The refresh token time limit.
|
void |
setSupportedIdentityProviders(java.util.Collection<java.lang.String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
void |
setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The time units you use when you set the duration of ID, access, and
refresh tokens.
|
void |
setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where you want to update the user pool
client.
|
void |
setWriteAttributes(java.util.Collection<java.lang.String> writeAttributes)
The writeable attributes of the user pool.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateUserPoolClientRequest |
withAccessTokenValidity(java.lang.Integer accessTokenValidity)
The access token time limit.
|
UpdateUserPoolClientRequest |
withAllowedOAuthFlows(java.util.Collection<java.lang.String> allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest |
withAllowedOAuthFlows(java.lang.String... allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest |
withAllowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)
Set to
true to use OAuth 2.0 features in your user pool app
client. |
UpdateUserPoolClientRequest |
withAllowedOAuthScopes(java.util.Collection<java.lang.String> allowedOAuthScopes)
The allowed OAuth scopes.
|
UpdateUserPoolClientRequest |
withAllowedOAuthScopes(java.lang.String... allowedOAuthScopes)
The allowed OAuth scopes.
|
UpdateUserPoolClientRequest |
withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration necessary to collect metrics
for this user pool.
|
UpdateUserPoolClientRequest |
withAuthSessionValidity(java.lang.Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an
authentication flow.
|
UpdateUserPoolClientRequest |
withCallbackURLs(java.util.Collection<java.lang.String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
UpdateUserPoolClientRequest |
withCallbackURLs(java.lang.String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
UpdateUserPoolClientRequest |
withClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
|
UpdateUserPoolClientRequest |
withClientName(java.lang.String clientName)
The client name from the update user pool client request.
|
UpdateUserPoolClientRequest |
withDefaultRedirectURI(java.lang.String defaultRedirectURI)
The default redirect URI.
|
UpdateUserPoolClientRequest |
withEnablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data.
|
UpdateUserPoolClientRequest |
withEnableTokenRevocation(java.lang.Boolean enableTokenRevocation)
Activates or deactivates token revocation.
|
UpdateUserPoolClientRequest |
withExplicitAuthFlows(java.util.Collection<java.lang.String> explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
UpdateUserPoolClientRequest |
withExplicitAuthFlows(java.lang.String... explicitAuthFlows)
The authentication flows that you want your user pool client to support.
|
UpdateUserPoolClientRequest |
withIdTokenValidity(java.lang.Integer idTokenValidity)
The ID token time limit.
|
UpdateUserPoolClientRequest |
withLogoutURLs(java.util.Collection<java.lang.String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
UpdateUserPoolClientRequest |
withLogoutURLs(java.lang.String... logoutURLs)
A list of allowed logout URLs for the IdPs.
|
UpdateUserPoolClientRequest |
withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
UpdateUserPoolClientRequest |
withPreventUserExistenceErrors(java.lang.String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool.
|
UpdateUserPoolClientRequest |
withReadAttributes(java.util.Collection<java.lang.String> readAttributes)
The read-only attributes of the user pool.
|
UpdateUserPoolClientRequest |
withReadAttributes(java.lang.String... readAttributes)
The read-only attributes of the user pool.
|
UpdateUserPoolClientRequest |
withRefreshTokenValidity(java.lang.Integer refreshTokenValidity)
The refresh token time limit.
|
UpdateUserPoolClientRequest |
withSupportedIdentityProviders(java.util.Collection<java.lang.String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
UpdateUserPoolClientRequest |
withSupportedIdentityProviders(java.lang.String... supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
UpdateUserPoolClientRequest |
withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The time units you use when you set the duration of ID, access, and
refresh tokens.
|
UpdateUserPoolClientRequest |
withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where you want to update the user pool
client.
|
UpdateUserPoolClientRequest |
withWriteAttributes(java.util.Collection<java.lang.String> writeAttributes)
The writeable attributes of the user pool.
|
UpdateUserPoolClientRequest |
withWriteAttributes(java.lang.String... writeAttributes)
The writeable attributes of the user pool.
|
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollectorpublic java.lang.String getUserPoolId()
The user pool ID for the user pool where you want to update the user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
The user pool ID for the user pool where you want to update the user pool client.
public void setUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool where you want to update the user pool client.
public UpdateUserPoolClientRequest withUserPoolId(java.lang.String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+
userPoolId - The user pool ID for the user pool where you want to update the user pool client.
public java.lang.String getClientId()
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
The ID of the client associated with the user pool.
public void setClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
clientId - The ID of the client associated with the user pool.
public UpdateUserPoolClientRequest withClientId(java.lang.String clientId)
The ID of the client associated with the user pool.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w+]+
clientId - The ID of the client associated with the user pool.
public java.lang.String getClientName()
The client name from the update user pool client request.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
The client name from the update user pool client request.
public void setClientName(java.lang.String clientName)
The client name from the update user pool client request.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
clientName - The client name from the update user pool client request.
public UpdateUserPoolClientRequest withClientName(java.lang.String clientName)
The client name from the update user pool client request.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w\s+=,.@-]+
clientName - The client name from the update user pool client request.
public java.lang.Integer getRefreshTokenValidity()
The refresh token time limit. After this limit expires, your user can't
use their refresh token. To specify the time unit for
RefreshTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as days,
your user can refresh their session and retrieve new access and ID tokens
for 10 days.
The default time unit for RefreshTokenValidity in an API
request is days. You can't set RefreshTokenValidity to 0. If
you do, Amazon Cognito overrides the value with the default value of 30
days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Constraints:
Range: 0 - 315360000
The refresh token time limit. After this limit expires, your user
can't use their refresh token. To specify the time unit for
RefreshTokenValidity as seconds,
minutes, hours, or days,
set a TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as
days, your user can refresh their session and
retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in an
API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon Cognito
overrides the value with the default value of 30 days. Valid
range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
public void setRefreshTokenValidity(java.lang.Integer refreshTokenValidity)
The refresh token time limit. After this limit expires, your user can't
use their refresh token. To specify the time unit for
RefreshTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as days,
your user can refresh their session and retrieve new access and ID tokens
for 10 days.
The default time unit for RefreshTokenValidity in an API
request is days. You can't set RefreshTokenValidity to 0. If
you do, Amazon Cognito overrides the value with the default value of 30
days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Constraints:
Range: 0 - 315360000
refreshTokenValidity -
The refresh token time limit. After this limit expires, your
user can't use their refresh token. To specify the time unit
for RefreshTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as
days, your user can refresh their session and
retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in
an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon
Cognito overrides the value with the default value of 30 days.
Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
public UpdateUserPoolClientRequest withRefreshTokenValidity(java.lang.Integer refreshTokenValidity)
The refresh token time limit. After this limit expires, your user can't
use their refresh token. To specify the time unit for
RefreshTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as days,
your user can refresh their session and retrieve new access and ID tokens
for 10 days.
The default time unit for RefreshTokenValidity in an API
request is days. You can't set RefreshTokenValidity to 0. If
you do, Amazon Cognito overrides the value with the default value of 30
days. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 0 - 315360000
refreshTokenValidity -
The refresh token time limit. After this limit expires, your
user can't use their refresh token. To specify the time unit
for RefreshTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set RefreshTokenValidity as
10 and TokenValidityUnits as
days, your user can refresh their session and
retrieve new access and ID tokens for 10 days.
The default time unit for RefreshTokenValidity in
an API request is days. You can't set
RefreshTokenValidity to 0. If you do, Amazon
Cognito overrides the value with the default value of 30 days.
Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your refresh tokens are valid for 30 days.
public java.lang.Integer getAccessTokenValidity()
The access token time limit. After this limit expires, your user can't
use their access token. To specify the time unit for
AccessTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API
request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Constraints:
Range: 1 - 86400
The access token time limit. After this limit expires, your user
can't use their access token. To specify the time unit for
AccessTokenValidity as seconds,
minutes, hours, or days,
set a TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to
hours, your user can authorize access with their
access token for 10 hours.
The default time unit for AccessTokenValidity in an
API request is hours. Valid range is displayed below in
seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
public void setAccessTokenValidity(java.lang.Integer accessTokenValidity)
The access token time limit. After this limit expires, your user can't
use their access token. To specify the time unit for
AccessTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API
request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Constraints:
Range: 1 - 86400
accessTokenValidity -
The access token time limit. After this limit expires, your
user can't use their access token. To specify the time unit
for AccessTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to
hours, your user can authorize access with their
access token for 10 hours.
The default time unit for AccessTokenValidity in
an API request is hours. Valid range is displayed below
in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
public UpdateUserPoolClientRequest withAccessTokenValidity(java.lang.Integer accessTokenValidity)
The access token time limit. After this limit expires, your user can't
use their access token. To specify the time unit for
AccessTokenValidity as seconds,
minutes, hours, or days, set a
TokenValidityUnits value in your API request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to hours
, your user can authorize access with their access token for 10 hours.
The default time unit for AccessTokenValidity in an API
request is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 86400
accessTokenValidity -
The access token time limit. After this limit expires, your
user can't use their access token. To specify the time unit
for AccessTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set AccessTokenValidity to
10 and TokenValidityUnits to
hours, your user can authorize access with their
access token for 10 hours.
The default time unit for AccessTokenValidity in
an API request is hours. Valid range is displayed below
in seconds.
If you don't specify otherwise in the configuration of your app client, your access tokens are valid for one hour.
public java.lang.Integer getIdTokenValidity()
The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for IdTokenValidity
as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your
API request.
For example, when you set IdTokenValidity as 10
and TokenValidityUnits as hours, your user can
authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request
is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
Constraints:
Range: 1 - 86400
The ID token time limit. After this limit expires, your user
can't use their ID token. To specify the time unit for
IdTokenValidity as seconds,
minutes, hours, or days,
set a TokenValidityUnits value in your API request.
For example, when you set IdTokenValidity as
10 and TokenValidityUnits as
hours, your user can authenticate their session with
their ID token for 10 hours.
The default time unit for IdTokenValidity in an API
request is hours. Valid range is displayed below in
seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
public void setIdTokenValidity(java.lang.Integer idTokenValidity)
The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for IdTokenValidity
as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your
API request.
For example, when you set IdTokenValidity as 10
and TokenValidityUnits as hours, your user can
authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request
is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
Constraints:
Range: 1 - 86400
idTokenValidity -
The ID token time limit. After this limit expires, your user
can't use their ID token. To specify the time unit for
IdTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set IdTokenValidity as
10 and TokenValidityUnits as
hours, your user can authenticate their session
with their ID token for 10 hours.
The default time unit for IdTokenValidity in an
API request is hours. Valid range is displayed below in
seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
public UpdateUserPoolClientRequest withIdTokenValidity(java.lang.Integer idTokenValidity)
The ID token time limit. After this limit expires, your user can't use
their ID token. To specify the time unit for IdTokenValidity
as seconds, minutes, hours, or
days, set a TokenValidityUnits value in your
API request.
For example, when you set IdTokenValidity as 10
and TokenValidityUnits as hours, your user can
authenticate their session with their ID token for 10 hours.
The default time unit for IdTokenValidity in an API request
is hours. Valid range is displayed below in seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 - 86400
idTokenValidity -
The ID token time limit. After this limit expires, your user
can't use their ID token. To specify the time unit for
IdTokenValidity as seconds,
minutes, hours, or days
, set a TokenValidityUnits value in your API
request.
For example, when you set IdTokenValidity as
10 and TokenValidityUnits as
hours, your user can authenticate their session
with their ID token for 10 hours.
The default time unit for IdTokenValidity in an
API request is hours. Valid range is displayed below in
seconds.
If you don't specify otherwise in the configuration of your app client, your ID tokens are valid for one hour.
public TokenValidityUnitsType getTokenValidityUnits()
The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
public void setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
tokenValidityUnits - The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
public UpdateUserPoolClientRequest withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
Returns a reference to this object so that method calls can be chained together.
tokenValidityUnits - The time units you use when you set the duration of ID, access, and refresh tokens. The default unit for RefreshToken is days, and the default for ID and access tokens is hours.
public java.util.List<java.lang.String> getReadAttributes()
The read-only attributes of the user pool.
The read-only attributes of the user pool.
public void setReadAttributes(java.util.Collection<java.lang.String> readAttributes)
The read-only attributes of the user pool.
readAttributes - The read-only attributes of the user pool.
public UpdateUserPoolClientRequest withReadAttributes(java.lang.String... readAttributes)
The read-only attributes of the user pool.
Returns a reference to this object so that method calls can be chained together.
readAttributes - The read-only attributes of the user pool.
public UpdateUserPoolClientRequest withReadAttributes(java.util.Collection<java.lang.String> readAttributes)
The read-only attributes of the user pool.
Returns a reference to this object so that method calls can be chained together.
readAttributes - The read-only attributes of the user pool.
public java.util.List<java.lang.String> getWriteAttributes()
The writeable attributes of the user pool.
The writeable attributes of the user pool.
public void setWriteAttributes(java.util.Collection<java.lang.String> writeAttributes)
The writeable attributes of the user pool.
writeAttributes - The writeable attributes of the user pool.
public UpdateUserPoolClientRequest withWriteAttributes(java.lang.String... writeAttributes)
The writeable attributes of the user pool.
Returns a reference to this object so that method calls can be chained together.
writeAttributes - The writeable attributes of the user pool.
public UpdateUserPoolClientRequest withWriteAttributes(java.util.Collection<java.lang.String> writeAttributes)
The writeable attributes of the user pool.
Returns a reference to this object so that method calls can be chained together.
writeAttributes - The writeable attributes of the user pool.
public java.util.List<java.lang.String> getExplicitAuthFlows()
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your
user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the same
time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows,
your user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and
ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based
user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces the
ADMIN_NO_SRP_AUTH setting. With this authentication
flow, your app passes a user name and password to Amazon Cognito
in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the
password in the request instead of using the SRP protocol to
verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based
authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh
tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,
CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the
same time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
public void setExplicitAuthFlows(java.util.Collection<java.lang.String> explicitAuthFlows)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your
user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the same
time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
explicitAuthFlows - The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for
ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and
ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password
to Amazon Cognito in the request, instead of using the Secure
Remote Password (SRP) protocol to securely transmit the
password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, Amazon Cognito
receives the password in the request instead of using the SRP
protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based
authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to
refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,
CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at
the same time as values that begin with ALLOW_,
like ALLOW_USER_SRP_AUTH.
public UpdateUserPoolClientRequest withExplicitAuthFlows(java.lang.String... explicitAuthFlows)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your
user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the same
time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
Returns a reference to this object so that method calls can be chained together.
explicitAuthFlows - The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for
ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and
ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password
to Amazon Cognito in the request, instead of using the Secure
Remote Password (SRP) protocol to securely transmit the
password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, Amazon Cognito
receives the password in the request instead of using the SRP
protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based
authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to
refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,
CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at
the same time as values that begin with ALLOW_,
like ALLOW_USER_SRP_AUTH.
public UpdateUserPoolClientRequest withExplicitAuthFlows(java.util.Collection<java.lang.String> explicitAuthFlows)
The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for ExplicitAuthFlows, your
user client supports ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user
password authentication flow ADMIN_USER_PASSWORD_AUTH. This
setting replaces the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password to Amazon
Cognito in the request, instead of using the Secure Remote Password (SRP)
protocol to securely transmit the password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user password-based
authentication. In this flow, Amazon Cognito receives the password in the
request instead of using the SRP protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH, CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at the same
time as values that begin with ALLOW_, like
ALLOW_USER_SRP_AUTH.
Returns a reference to this object so that method calls can be chained together.
explicitAuthFlows - The authentication flows that you want your user pool client to support. For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.
If you don't specify a value for
ExplicitAuthFlows, your user client supports
ALLOW_REFRESH_TOKEN_AUTH,
ALLOW_USER_SRP_AUTH, and
ALLOW_CUSTOM_AUTH.
Valid values include:
ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin
based user password authentication flow
ADMIN_USER_PASSWORD_AUTH. This setting replaces
the ADMIN_NO_SRP_AUTH setting. With this
authentication flow, your app passes a user name and password
to Amazon Cognito in the request, instead of using the Secure
Remote Password (SRP) protocol to securely transmit the
password.
ALLOW_CUSTOM_AUTH: Enable Lambda trigger based
authentication.
ALLOW_USER_PASSWORD_AUTH: Enable user
password-based authentication. In this flow, Amazon Cognito
receives the password in the request instead of using the SRP
protocol to verify passwords.
ALLOW_USER_SRP_AUTH: Enable SRP-based
authentication.
ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to
refresh tokens.
In some environments, you will see the values
ADMIN_NO_SRP_AUTH,
CUSTOM_AUTH_FLOW_ONLY, or
USER_PASSWORD_AUTH. You can't assign these legacy
ExplicitAuthFlows values to user pool clients at
the same time as values that begin with ALLOW_,
like ALLOW_USER_SRP_AUTH.
public java.util.List<java.lang.String> getSupportedIdentityProviders()
A list of provider names for the IdPs that this client supports. The
following are supported: COGNITO, Facebook,
Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC
providers.
A list of provider names for the IdPs that this client supports.
The following are supported: COGNITO,
Facebook, Google,
SignInWithApple, LoginWithAmazon, and
the names of your own SAML and OIDC providers.
public void setSupportedIdentityProviders(java.util.Collection<java.lang.String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports. The
following are supported: COGNITO, Facebook,
Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC
providers.
supportedIdentityProviders -
A list of provider names for the IdPs that this client
supports. The following are supported: COGNITO,
Facebook, Google,
SignInWithApple, LoginWithAmazon,
and the names of your own SAML and OIDC providers.
public UpdateUserPoolClientRequest withSupportedIdentityProviders(java.lang.String... supportedIdentityProviders)
A list of provider names for the IdPs that this client supports. The
following are supported: COGNITO, Facebook,
Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC
providers.
Returns a reference to this object so that method calls can be chained together.
supportedIdentityProviders -
A list of provider names for the IdPs that this client
supports. The following are supported: COGNITO,
Facebook, Google,
SignInWithApple, LoginWithAmazon,
and the names of your own SAML and OIDC providers.
public UpdateUserPoolClientRequest withSupportedIdentityProviders(java.util.Collection<java.lang.String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports. The
following are supported: COGNITO, Facebook,
Google, SignInWithApple,
LoginWithAmazon, and the names of your own SAML and OIDC
providers.
Returns a reference to this object so that method calls can be chained together.
supportedIdentityProviders -
A list of provider names for the IdPs that this client
supports. The following are supported: COGNITO,
Facebook, Google,
SignInWithApple, LoginWithAmazon,
and the names of your own SAML and OIDC providers.
public java.util.List<java.lang.String> getCallbackURLs()
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
public void setCallbackURLs(java.util.Collection<java.lang.String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are
also supported.
public UpdateUserPoolClientRequest withCallbackURLs(java.lang.String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
Returns a reference to this object so that method calls can be chained together.
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are
also supported.
public UpdateUserPoolClientRequest withCallbackURLs(java.util.Collection<java.lang.String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
Returns a reference to this object so that method calls can be chained together.
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are
also supported.
public java.util.List<java.lang.String> getLogoutURLs()
A list of allowed logout URLs for the IdPs.
A list of allowed logout URLs for the IdPs.
public void setLogoutURLs(java.util.Collection<java.lang.String> logoutURLs)
A list of allowed logout URLs for the IdPs.
logoutURLs - A list of allowed logout URLs for the IdPs.
public UpdateUserPoolClientRequest withLogoutURLs(java.lang.String... logoutURLs)
A list of allowed logout URLs for the IdPs.
Returns a reference to this object so that method calls can be chained together.
logoutURLs - A list of allowed logout URLs for the IdPs.
public UpdateUserPoolClientRequest withLogoutURLs(java.util.Collection<java.lang.String> logoutURLs)
A list of allowed logout URLs for the IdPs.
Returns a reference to this object so that method calls can be chained together.
logoutURLs - A list of allowed logout URLs for the IdPs.
public java.lang.String getDefaultRedirectURI()
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for
http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for
http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
public void setDefaultRedirectURI(java.lang.String defaultRedirectURI)
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for
http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
defaultRedirectURI -
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for
http://localhost for testing purposes only.
App callback URLs such as myapp://example are
also supported.
public UpdateUserPoolClientRequest withDefaultRedirectURI(java.lang.String defaultRedirectURI)
The default redirect URI. Must be in the CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for
http://localhost for testing purposes only.
App callback URLs such as myapp://example are also
supported.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1024
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
defaultRedirectURI -
The default redirect URI. Must be in the
CallbackURLs list.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for
http://localhost for testing purposes only.
App callback URLs such as myapp://example are
also supported.
public java.util.List<java.lang.String> getAllowedOAuthFlows()
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
/oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint
directly to a non-person user using a combination of the client ID and
client secret.
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as
the response. This code can be exchanged for access tokens with
the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token
endpoint directly to a non-person user using a combination of the
client ID and client secret.
public void setAllowedOAuthFlows(java.util.Collection<java.lang.String> allowedOAuthFlows)
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
/oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint
directly to a non-person user using a combination of the client ID and
client secret.
allowedOAuthFlows - The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as
the response. This code can be exchanged for access tokens
with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token
endpoint directly to a non-person user using a combination of
the client ID and client secret.
public UpdateUserPoolClientRequest withAllowedOAuthFlows(java.lang.String... allowedOAuthFlows)
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
/oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint
directly to a non-person user using a combination of the client ID and
client secret.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlows - The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as
the response. This code can be exchanged for access tokens
with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token
endpoint directly to a non-person user using a combination of
the client ID and client secret.
public UpdateUserPoolClientRequest withAllowedOAuthFlows(java.util.Collection<java.lang.String> allowedOAuthFlows)
The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as the
response. This code can be exchanged for access tokens with the
/oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token endpoint
directly to a non-person user using a combination of the client ID and
client secret.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlows - The allowed OAuth flows.
Use a code grant flow, which provides an authorization code as
the response. This code can be exchanged for access tokens
with the /oauth2/token endpoint.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
Issue the access token from the /oauth2/token
endpoint directly to a non-person user using a combination of
the client ID and client secret.
public java.util.List<java.lang.String> getAllowedOAuthScopes()
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web
Services are aws.cognito.signin.user.admin. Custom
scopes created in Resource Servers are also supported.
public void setAllowedOAuthScopes(java.util.Collection<java.lang.String> allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are phone, email,
openid, and profile. Possible values
provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public UpdateUserPoolClientRequest withAllowedOAuthScopes(java.lang.String... allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are phone, email,
openid, and profile. Possible values
provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public UpdateUserPoolClientRequest withAllowedOAuthScopes(java.util.Collection<java.lang.String> allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are
phone, email, openid, and
profile. Possible values provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in
Resource Servers are also supported.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthScopes -
The allowed OAuth scopes. Possible values provided by OAuth
are phone, email,
openid, and profile. Possible values
provided by Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes
created in Resource Servers are also supported.
public java.lang.Boolean isAllowedOAuthFlowsUserPoolClient()
Set to true to use OAuth 2.0 features in your user pool app
client.
AllowedOAuthFlowsUserPoolClient must be true
before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit,
and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a value
for AllowedOAuthFlowsUserPoolClient in a request with the
CLI or SDKs, it defaults to false.
Set to true to use OAuth 2.0 features in your user
pool app client.
AllowedOAuthFlowsUserPoolClient must be
true before you can configure the following features
in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code,
implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the
Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to true
in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a
value for AllowedOAuthFlowsUserPoolClient in a
request with the CLI or SDKs, it defaults to false.
public java.lang.Boolean getAllowedOAuthFlowsUserPoolClient()
Set to true to use OAuth 2.0 features in your user pool app
client.
AllowedOAuthFlowsUserPoolClient must be true
before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit,
and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a value
for AllowedOAuthFlowsUserPoolClient in a request with the
CLI or SDKs, it defaults to false.
Set to true to use OAuth 2.0 features in your user
pool app client.
AllowedOAuthFlowsUserPoolClient must be
true before you can configure the following features
in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code,
implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the
Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to true
in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a
value for AllowedOAuthFlowsUserPoolClient in a
request with the CLI or SDKs, it defaults to false.
public void setAllowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)
Set to true to use OAuth 2.0 features in your user pool app
client.
AllowedOAuthFlowsUserPoolClient must be true
before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit,
and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a value
for AllowedOAuthFlowsUserPoolClient in a request with the
CLI or SDKs, it defaults to false.
allowedOAuthFlowsUserPoolClient -
Set to true to use OAuth 2.0 features in your
user pool app client.
AllowedOAuthFlowsUserPoolClient must be
true before you can configure the following
features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization
code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in
the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't
set a value for AllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults to
false.
public UpdateUserPoolClientRequest withAllowedOAuthFlowsUserPoolClient(java.lang.Boolean allowedOAuthFlowsUserPoolClient)
Set to true to use OAuth 2.0 features in your user pool app
client.
AllowedOAuthFlowsUserPoolClient must be true
before you can configure the following features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization code, implicit,
and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in the Amazon
Cognito console or set AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't set a value
for AllowedOAuthFlowsUserPoolClient in a request with the
CLI or SDKs, it defaults to false.
Returns a reference to this object so that method calls can be chained together.
allowedOAuthFlowsUserPoolClient -
Set to true to use OAuth 2.0 features in your
user pool app client.
AllowedOAuthFlowsUserPoolClient must be
true before you can configure the following
features in your app client.
CallBackURLs: Callback URLs.
LogoutURLs: Sign-out redirect URLs.
AllowedOAuthScopes: OAuth 2.0 scopes.
AllowedOAuthFlows: Support for authorization
code, implicit, and client credentials OAuth 2.0 grants.
To use OAuth 2.0 features, configure one of these features in
the Amazon Cognito console or set
AllowedOAuthFlowsUserPoolClient to
true in a CreateUserPoolClient or
UpdateUserPoolClient API request. If you don't
set a value for AllowedOAuthFlowsUserPoolClient
in a request with the CLI or SDKs, it defaults to
false.
public AnalyticsConfigurationType getAnalyticsConfiguration()
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
analyticsConfiguration - The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public UpdateUserPoolClientRequest withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
Returns a reference to this object so that method calls can be chained together.
analyticsConfiguration - The Amazon Pinpoint analytics configuration necessary to collect metrics for this user pool.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public java.lang.String getPreventUserExistenceErrors()
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Constraints:
Allowed Values: LEGACY, ENABLED
Errors and responses that you want Amazon Cognito APIs to return
during authentication, account confirmation, and password
recovery when the user doesn't exist in the user pool. When set
to ENABLED and the user doesn't exist,
authentication returns an error indicating either the username or
password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a
simulated destination. When set to LEGACY, those
APIs return a UserNotFoundException exception if the
user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic void setPreventUserExistenceErrors(java.lang.String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user
pool. When set to ENABLED and the user doesn't
exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and
password recovery return a response indicating a code was sent
to a simulated destination. When set to LEGACY,
those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic UpdateUserPoolClientRequest withPreventUserExistenceErrors(java.lang.String preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user
pool. When set to ENABLED and the user doesn't
exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and
password recovery return a response indicating a code was sent
to a simulated destination. When set to LEGACY,
those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic void setPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user
pool. When set to ENABLED and the user doesn't
exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and
password recovery return a response indicating a code was sent
to a simulated destination. When set to LEGACY,
those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic UpdateUserPoolClientRequest withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
Errors and responses that you want Amazon Cognito APIs to return during
authentication, account confirmation, and password recovery when the user
doesn't exist in the user pool. When set to ENABLED and the
user doesn't exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and password
recovery return a response indicating a code was sent to a simulated
destination. When set to LEGACY, those APIs return a
UserNotFoundException exception if the user doesn't exist in
the user pool.
Valid values include:
ENABLED - This prevents user existence-related errors.
LEGACY - This represents the early behavior of Amazon
Cognito where user existence related errors aren't prevented.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: LEGACY, ENABLED
preventUserExistenceErrors -
Errors and responses that you want Amazon Cognito APIs to
return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user
pool. When set to ENABLED and the user doesn't
exist, authentication returns an error indicating either the
username or password was incorrect. Account confirmation and
password recovery return a response indicating a code was sent
to a simulated destination. When set to LEGACY,
those APIs return a UserNotFoundException
exception if the user doesn't exist in the user pool.
Valid values include:
ENABLED - This prevents user existence-related
errors.
LEGACY - This represents the early behavior of
Amazon Cognito where user existence related errors aren't
prevented.
PreventUserExistenceErrorTypespublic java.lang.Boolean isEnableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
public java.lang.Boolean getEnableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
public void setEnableTokenRevocation(java.lang.Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
enableTokenRevocation - Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
public UpdateUserPoolClientRequest withEnableTokenRevocation(java.lang.Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
Returns a reference to this object so that method calls can be chained together.
enableTokenRevocation - Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
public java.lang.Boolean isEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data. For more
information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
parameter, you can't send device fingerprint information, including
source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
Activates the propagation of additional user context data. For
more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t
include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito
advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
public java.lang.Boolean getEnablePropagateAdditionalUserContextData()
Activates the propagation of additional user context data. For more
information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
parameter, you can't send device fingerprint information, including
source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
Activates the propagation of additional user context data. For
more information about propagation of user context data, see Adding advanced security to a user pool. If you don’t
include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito
advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
public void setEnablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data. For more
information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
parameter, you can't send device fingerprint information, including
source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
enablePropagateAdditionalUserContextData -
Activates the propagation of additional user context data. For
more information about propagation of user context data, see
Adding advanced security to a user pool. If you don’t
include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito
advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an
app client that has a client secret.
public UpdateUserPoolClientRequest withEnablePropagateAdditionalUserContextData(java.lang.Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data. For more
information about propagation of user context data, see Adding advanced security to a user pool. If you don’t include this
parameter, you can't send device fingerprint information, including
source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app
client that has a client secret.
Returns a reference to this object so that method calls can be chained together.
enablePropagateAdditionalUserContextData -
Activates the propagation of additional user context data. For
more information about propagation of user context data, see
Adding advanced security to a user pool. If you don’t
include this parameter, you can't send device fingerprint
information, including source IP address, to Amazon Cognito
advanced security. You can only activate
EnablePropagateAdditionalUserContextData in an
app client that has a client secret.
public java.lang.Integer getAuthSessionValidity()
Amazon Cognito creates a session token for each API request in an
authentication flow. AuthSessionValidity is the duration, in
minutes, of that session token. Your user pool native user must respond
to each authentication challenge before the session expires.
Constraints:
Range: 3 - 15
Amazon Cognito creates a session token for each API request in an
authentication flow. AuthSessionValidity is the
duration, in minutes, of that session token. Your user pool
native user must respond to each authentication challenge before
the session expires.
public void setAuthSessionValidity(java.lang.Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an
authentication flow. AuthSessionValidity is the duration, in
minutes, of that session token. Your user pool native user must respond
to each authentication challenge before the session expires.
Constraints:
Range: 3 - 15
authSessionValidity -
Amazon Cognito creates a session token for each API request in
an authentication flow. AuthSessionValidity is
the duration, in minutes, of that session token. Your user
pool native user must respond to each authentication challenge
before the session expires.
public UpdateUserPoolClientRequest withAuthSessionValidity(java.lang.Integer authSessionValidity)
Amazon Cognito creates a session token for each API request in an
authentication flow. AuthSessionValidity is the duration, in
minutes, of that session token. Your user pool native user must respond
to each authentication challenge before the session expires.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 3 - 15
authSessionValidity -
Amazon Cognito creates a session token for each API request in
an authentication flow. AuthSessionValidity is
the duration, in minutes, of that session token. Your user
pool native user must respond to each authentication challenge
before the session expires.
public java.lang.String toString()
toString in class java.lang.ObjectObject.toString()public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object obj)
equals in class java.lang.Object