UserPoolClientType (AWS Java SDK for Amazon Cognito Identity Provider Service 1.12.544 API)

java.lang.Object
- com.amazonaws.services.cognitoidp.model.UserPoolClientType

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserPoolClientType
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains information about a user pool client.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserPoolClientType()

Constructors
Constructor and Description
`UserPoolClientType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserPoolClientType`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getAccessTokenValidity()` The access token time limit.
`List<String>`	`getAllowedOAuthFlows()` The allowed OAuth flows.
`Boolean`	`getAllowedOAuthFlowsUserPoolClient()` Set to `true` to use OAuth 2.0 features in your user pool app client.
`List<String>`	`getAllowedOAuthScopes()` The OAuth scopes that your app client supports.
`AnalyticsConfigurationType`	`getAnalyticsConfiguration()` The Amazon Pinpoint analytics configuration for the user pool client.
`Integer`	`getAuthSessionValidity()` Amazon Cognito creates a session token for each API request in an authentication flow.
`List<String>`	`getCallbackURLs()` A list of allowed redirect (callback) URLs for the IdPs.
`String`	`getClientId()` The ID of the client associated with the user pool.
`String`	`getClientName()` The client name from the user pool request of the client type.
`String`	`getClientSecret()` The client secret from the user pool request of the client type.
`Date`	`getCreationDate()` The date and time, in ISO 8601 format, when the item was created.
`String`	`getDefaultRedirectURI()` The default redirect URI.
`Boolean`	`getEnablePropagateAdditionalUserContextData()` When `EnablePropagateAdditionalUserContextData` is true, Amazon Cognito accepts an `IpAddress` value that you send in the `UserContextData` parameter.
`Boolean`	`getEnableTokenRevocation()` Indicates whether token revocation is activated for the user pool client.
`List<String>`	`getExplicitAuthFlows()` The authentication flows that you want your user pool client to support.
`Integer`	`getIdTokenValidity()` The ID token time limit.
`Date`	`getLastModifiedDate()` The date and time, in ISO 8601 format, when the item was modified.
`List<String>`	`getLogoutURLs()` A list of allowed logout URLs for the IdPs.
`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.
`List<String>`	`getReadAttributes()` The Read-only attributes.
`Integer`	`getRefreshTokenValidity()` The refresh token time limit.
`List<String>`	`getSupportedIdentityProviders()` A list of provider names for the IdPs that this client supports.
`TokenValidityUnitsType`	`getTokenValidityUnits()` The time units used to specify the token validity times of each token type: ID, access, and refresh.
`String`	`getUserPoolId()` The user pool ID for the user pool client.
`List<String>`	`getWriteAttributes()` The writeable attributes.
`int`	`hashCode()`
`Boolean`	`isAllowedOAuthFlowsUserPoolClient()` Set to `true` to use OAuth 2.0 features in your user pool app client.
`Boolean`	`isEnablePropagateAdditionalUserContextData()` When `EnablePropagateAdditionalUserContextData` is true, Amazon Cognito accepts an `IpAddress` value that you send in the `UserContextData` parameter.
`Boolean`	`isEnableTokenRevocation()` Indicates whether token revocation is activated for the user pool client.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAccessTokenValidity(Integer accessTokenValidity)` The access token time limit.
`void`	`setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)` The allowed OAuth flows.
`void`	`setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)` Set to `true` to use OAuth 2.0 features in your user pool app client.
`void`	`setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)` The OAuth scopes that your app client supports.
`void`	`setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)` The Amazon Pinpoint analytics configuration for the user pool client.
`void`	`setAuthSessionValidity(Integer authSessionValidity)` Amazon Cognito creates a session token for each API request in an authentication flow.
`void`	`setCallbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the IdPs.
`void`	`setClientId(String clientId)` The ID of the client associated with the user pool.
`void`	`setClientName(String clientName)` The client name from the user pool request of the client type.
`void`	`setClientSecret(String clientSecret)` The client secret from the user pool request of the client type.
`void`	`setCreationDate(Date creationDate)` The date and time, in ISO 8601 format, when the item was created.
`void`	`setDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`void`	`setEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)` When `EnablePropagateAdditionalUserContextData` is true, Amazon Cognito accepts an `IpAddress` value that you send in the `UserContextData` parameter.
`void`	`setEnableTokenRevocation(Boolean enableTokenRevocation)` Indicates whether token revocation is activated for the user pool client.
`void`	`setExplicitAuthFlows(Collection<String> explicitAuthFlows)` The authentication flows that you want your user pool client to support.
`void`	`setIdTokenValidity(Integer idTokenValidity)` The ID token time limit.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The date and time, in ISO 8601 format, when the item was modified.
`void`	`setLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the IdPs.
`void`	`setPreventUserExistenceErrors(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(Collection<String> readAttributes)` The Read-only attributes.
`void`	`setRefreshTokenValidity(Integer refreshTokenValidity)` The refresh token time limit.
`void`	`setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the IdPs that this client supports.
`void`	`setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)` The time units used to specify the token validity times of each token type: ID, access, and refresh.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool client.
`void`	`setWriteAttributes(Collection<String> writeAttributes)` The writeable attributes.
`String`	`toString()` Returns a string representation of this object.
`UserPoolClientType`	`withAccessTokenValidity(Integer accessTokenValidity)` The access token time limit.
`UserPoolClientType`	`withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)` The allowed OAuth flows.
`UserPoolClientType`	`withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)` The allowed OAuth flows.
`UserPoolClientType`	`withAllowedOAuthFlows(String... allowedOAuthFlows)` The allowed OAuth flows.
`UserPoolClientType`	`withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)` Set to `true` to use OAuth 2.0 features in your user pool app client.
`UserPoolClientType`	`withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)` The OAuth scopes that your app client supports.
`UserPoolClientType`	`withAllowedOAuthScopes(String... allowedOAuthScopes)` The OAuth scopes that your app client supports.
`UserPoolClientType`	`withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)` The Amazon Pinpoint analytics configuration for the user pool client.
`UserPoolClientType`	`withAuthSessionValidity(Integer authSessionValidity)` Amazon Cognito creates a session token for each API request in an authentication flow.
`UserPoolClientType`	`withCallbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the IdPs.
`UserPoolClientType`	`withCallbackURLs(String... callbackURLs)` A list of allowed redirect (callback) URLs for the IdPs.
`UserPoolClientType`	`withClientId(String clientId)` The ID of the client associated with the user pool.
`UserPoolClientType`	`withClientName(String clientName)` The client name from the user pool request of the client type.
`UserPoolClientType`	`withClientSecret(String clientSecret)` The client secret from the user pool request of the client type.
`UserPoolClientType`	`withCreationDate(Date creationDate)` The date and time, in ISO 8601 format, when the item was created.
`UserPoolClientType`	`withDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`UserPoolClientType`	`withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)` When `EnablePropagateAdditionalUserContextData` is true, Amazon Cognito accepts an `IpAddress` value that you send in the `UserContextData` parameter.
`UserPoolClientType`	`withEnableTokenRevocation(Boolean enableTokenRevocation)` Indicates whether token revocation is activated for the user pool client.
`UserPoolClientType`	`withExplicitAuthFlows(Collection<String> explicitAuthFlows)` The authentication flows that you want your user pool client to support.
`UserPoolClientType`	`withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)` The authentication flows that you want your user pool client to support.
`UserPoolClientType`	`withExplicitAuthFlows(String... explicitAuthFlows)` The authentication flows that you want your user pool client to support.
`UserPoolClientType`	`withIdTokenValidity(Integer idTokenValidity)` The ID token time limit.
`UserPoolClientType`	`withLastModifiedDate(Date lastModifiedDate)` The date and time, in ISO 8601 format, when the item was modified.
`UserPoolClientType`	`withLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the IdPs.
`UserPoolClientType`	`withLogoutURLs(String... logoutURLs)` A list of allowed logout URLs for the IdPs.
`UserPoolClientType`	`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.
`UserPoolClientType`	`withPreventUserExistenceErrors(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.
`UserPoolClientType`	`withReadAttributes(Collection<String> readAttributes)` The Read-only attributes.
`UserPoolClientType`	`withReadAttributes(String... readAttributes)` The Read-only attributes.
`UserPoolClientType`	`withRefreshTokenValidity(Integer refreshTokenValidity)` The refresh token time limit.
`UserPoolClientType`	`withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the IdPs that this client supports.
`UserPoolClientType`	`withSupportedIdentityProviders(String... supportedIdentityProviders)` A list of provider names for the IdPs that this client supports.
`UserPoolClientType`	`withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)` The time units used to specify the token validity times of each token type: ID, access, and refresh.
`UserPoolClientType`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool client.
`UserPoolClientType`	`withWriteAttributes(Collection<String> writeAttributes)` The writeable attributes.
`UserPoolClientType`	`withWriteAttributes(String... writeAttributes)` The writeable attributes.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserPoolClientType
```
public UserPoolClientType()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool client.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool client.
    
    Returns:
    
    The user pool ID for the user pool client.
  - withUserPoolId
```
public UserPoolClientType withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool client.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientName
```
public void setClientName(String clientName)
```
    The client name from the user pool request of the client type.
    
    Parameters:
    
    clientName - The client name from the user pool request of the client type.
  - getClientName
```
public String getClientName()
```
    The client name from the user pool request of the client type.
    
    Returns:
    
    The client name from the user pool request of the client type.
  - withClientName
```
public UserPoolClientType withClientName(String clientName)
```
    The client name from the user pool request of the client type.
    
    Parameters:
    
    clientName - The client name from the user pool request of the client type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientId
```
public void setClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Parameters:
    
    clientId - The ID of the client associated with the user pool.
  - getClientId
```
public String getClientId()
```
    The ID of the client associated with the user pool.
    
    Returns:
    
    The ID of the client associated with the user pool.
  - withClientId
```
public UserPoolClientType withClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Parameters:
    
    clientId - The ID of the client associated with the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    The client secret from the user pool request of the client type.
    
    Parameters:
    
    clientSecret - The client secret from the user pool request of the client type.
  - getClientSecret
```
public String getClientSecret()
```
    The client secret from the user pool request of the client type.
    
    Returns:
    
    The client secret from the user pool request of the client type.
  - withClientSecret
```
public UserPoolClientType withClientSecret(String clientSecret)
```
    The client secret from the user pool request of the client type.
    
    Parameters:
    
    clientSecret - The client secret from the user pool request of the client type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Parameters:
    
    lastModifiedDate - The date and time, in ISO 8601 format, when the item was modified.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Returns:
    
    The date and time, in ISO 8601 format, when the item was modified.
  - withLastModifiedDate
```
public UserPoolClientType withLastModifiedDate(Date lastModifiedDate)
```
    The date and time, in ISO 8601 format, when the item was modified.
    
    Parameters:
    
    lastModifiedDate - The date and time, in ISO 8601 format, when the item was modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date and time, in ISO 8601 format, when the item was created.
    
    Parameters:
    
    creationDate - The date and time, in ISO 8601 format, when the item was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date and time, in ISO 8601 format, when the item was created.
    
    Returns:
    
    The date and time, in ISO 8601 format, when the item was created.
  - withCreationDate
```
public UserPoolClientType withCreationDate(Date creationDate)
```
    The date and time, in ISO 8601 format, when the item was created.
    
    Parameters:
    
    creationDate - The date and time, in ISO 8601 format, when the item was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRefreshTokenValidity
```
public void setRefreshTokenValidity(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.
    
    Parameters:
    
    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.
  - getRefreshTokenValidity
```
public 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.
    
    Returns:
    
    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.
  - withRefreshTokenValidity
```
public UserPoolClientType withRefreshTokenValidity(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessTokenValidity
```
public void setAccessTokenValidity(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.
    
    Parameters:
    
    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.
  - getAccessTokenValidity
```
public 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.
    
    Returns:
    
    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.
  - withAccessTokenValidity
```
public UserPoolClientType withAccessTokenValidity(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdTokenValidity
```
public void setIdTokenValidity(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.
    
    Parameters:
    
    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.
  - getIdTokenValidity
```
public 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.
    
    Returns:
    
    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.
  - withIdTokenValidity
```
public UserPoolClientType withIdTokenValidity(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTokenValidityUnits
```
public void setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
```
    The time units used to specify the token validity times of each token type: ID, access, and refresh.
    
    Parameters:
    
    tokenValidityUnits - The time units used to specify the token validity times of each token type: ID, access, and refresh.
  - getTokenValidityUnits
```
public TokenValidityUnitsType getTokenValidityUnits()
```
    The time units used to specify the token validity times of each token type: ID, access, and refresh.
    
    Returns:
    
    The time units used to specify the token validity times of each token type: ID, access, and refresh.
  - withTokenValidityUnits
```
public UserPoolClientType withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
```
    The time units used to specify the token validity times of each token type: ID, access, and refresh.
    
    Parameters:
    
    tokenValidityUnits - The time units used to specify the token validity times of each token type: ID, access, and refresh.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReadAttributes
```
public List<String> getReadAttributes()
```
    The Read-only attributes.
    
    Returns:
    
    The Read-only attributes.
  - setReadAttributes
```
public void setReadAttributes(Collection<String> readAttributes)
```
    The Read-only attributes.
    
    Parameters:
    
    readAttributes - The Read-only attributes.
  - withReadAttributes
```
public UserPoolClientType withReadAttributes(String... readAttributes)
```
    The Read-only attributes.
    
    NOTE: This method appends the values to the existing list (if any). Use setReadAttributes(java.util.Collection) or withReadAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    readAttributes - The Read-only attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReadAttributes
```
public UserPoolClientType withReadAttributes(Collection<String> readAttributes)
```
    The Read-only attributes.
    
    Parameters:
    
    readAttributes - The Read-only attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWriteAttributes
```
public List<String> getWriteAttributes()
```
    The writeable attributes.
    
    Returns:
    
    The writeable attributes.
  - setWriteAttributes
```
public void setWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes.
    
    Parameters:
    
    writeAttributes - The writeable attributes.
  - withWriteAttributes
```
public UserPoolClientType withWriteAttributes(String... writeAttributes)
```
    The writeable attributes.
    
    NOTE: This method appends the values to the existing list (if any). Use setWriteAttributes(java.util.Collection) or withWriteAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    writeAttributes - The writeable attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWriteAttributes
```
public UserPoolClientType withWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes.
    
    Parameters:
    
    writeAttributes - The writeable attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExplicitAuthFlows
```
public List<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.
    Returns:
    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.
    See Also:
    
    ExplicitAuthFlowsType
  - setExplicitAuthFlows
```
public void setExplicitAuthFlows(Collection<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.
    Parameters:
    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.
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setExplicitAuthFlows(java.util.Collection) or withExplicitAuthFlows(java.util.Collection) if you want to override the existing values.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(Collection<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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(ExplicitAuthFlowsType... 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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - getSupportedIdentityProviders
```
public List<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.
    
    Returns:
    
    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.
  - setSupportedIdentityProviders
```
public void setSupportedIdentityProviders(Collection<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.
    
    Parameters:
    
    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.
  - withSupportedIdentityProviders
```
public UserPoolClientType withSupportedIdentityProviders(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setSupportedIdentityProviders(java.util.Collection) or withSupportedIdentityProviders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSupportedIdentityProviders
```
public UserPoolClientType withSupportedIdentityProviders(Collection<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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCallbackURLs
```
public List<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.
    Returns:
    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.
  - setCallbackURLs
```
public void setCallbackURLs(Collection<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.
    Parameters:
    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.
  - withCallbackURLs
```
public UserPoolClientType withCallbackURLs(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCallbackURLs(java.util.Collection) or withCallbackURLs(java.util.Collection) if you want to override the existing values.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCallbackURLs
```
public UserPoolClientType withCallbackURLs(Collection<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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLogoutURLs
```
public List<String> getLogoutURLs()
```
    A list of allowed logout URLs for the IdPs.
    
    Returns:
    
    A list of allowed logout URLs for the IdPs.
  - setLogoutURLs
```
public void setLogoutURLs(Collection<String> logoutURLs)
```
    A list of allowed logout URLs for the IdPs.
    
    Parameters:
    
    logoutURLs - A list of allowed logout URLs for the IdPs.
  - withLogoutURLs
```
public UserPoolClientType withLogoutURLs(String... logoutURLs)
```
    A list of allowed logout URLs for the IdPs.
    
    NOTE: This method appends the values to the existing list (if any). Use setLogoutURLs(java.util.Collection) or withLogoutURLs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    logoutURLs - A list of allowed logout URLs for the IdPs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLogoutURLs
```
public UserPoolClientType withLogoutURLs(Collection<String> logoutURLs)
```
    A list of allowed logout URLs for the IdPs.
    
    Parameters:
    
    logoutURLs - A list of allowed logout URLs for the IdPs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultRedirectURI
```
public void setDefaultRedirectURI(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.
    Parameters:
    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.
  - getDefaultRedirectURI
```
public 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.
    Returns:
    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.
  - withDefaultRedirectURI
```
public UserPoolClientType withDefaultRedirectURI(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAllowedOAuthFlows
```
public List<String> getAllowedOAuthFlows()
```
    The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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:
    
    The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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.
    
    See Also:
    
    OAuthFlowType
  - setAllowedOAuthFlows
```
public void setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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.
    
    See Also:
    
    OAuthFlowType
  - withAllowedOAuthFlows
```
public UserPoolClientType withAllowedOAuthFlows(String... allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowedOAuthFlows(java.util.Collection) or withAllowedOAuthFlows(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthFlowType
  - withAllowedOAuthFlows
```
public UserPoolClientType withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthFlowType
  - withAllowedOAuthFlows
```
public UserPoolClientType withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    code
    
    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.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthFlowType
  - getAllowedOAuthScopes
```
public List<String> getAllowedOAuthScopes()
```
    The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    Returns:
    
    The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
  - setAllowedOAuthScopes
```
public void setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
```
    The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    Parameters:
    
    allowedOAuthScopes - The OAuth scopes that your app client supports. Possible values that OAuth provides are phone , email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
  - withAllowedOAuthScopes
```
public UserPoolClientType withAllowedOAuthScopes(String... allowedOAuthScopes)
```
    The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowedOAuthScopes(java.util.Collection) or withAllowedOAuthScopes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    allowedOAuthScopes - The OAuth scopes that your app client supports. Possible values that OAuth provides are phone , email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowedOAuthScopes
```
public UserPoolClientType withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
```
    The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    Parameters:
    
    allowedOAuthScopes - The OAuth scopes that your app client supports. Possible values that OAuth provides are phone , email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllowedOAuthFlowsUserPoolClient
```
public void setAllowedOAuthFlowsUserPoolClient(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 .
    Parameters:
    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.
  - getAllowedOAuthFlowsUserPoolClient
```
public 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 .
    Returns:
    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.
  - withAllowedOAuthFlowsUserPoolClient
```
public UserPoolClientType withAllowedOAuthFlowsUserPoolClient(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 .
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAllowedOAuthFlowsUserPoolClient
```
public 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 .
    Returns:
    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.
  - setAnalyticsConfiguration
```
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
    
    Parameters:
    
    analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
  - getAnalyticsConfiguration
```
public AnalyticsConfigurationType getAnalyticsConfiguration()
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
    
    Returns:
    
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
  - withAnalyticsConfiguration
```
public UserPoolClientType withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
    
    Parameters:
    
    analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreventUserExistenceErrors
```
public void setPreventUserExistenceErrors(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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Parameters:
    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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
    See Also:
    
    PreventUserExistenceErrorTypes
  - getPreventUserExistenceErrors
```
public 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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Returns:
    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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
    See Also:
    
    PreventUserExistenceErrorTypes
  - withPreventUserExistenceErrors
```
public UserPoolClientType withPreventUserExistenceErrors(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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Parameters:
    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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreventUserExistenceErrorTypes
  - withPreventUserExistenceErrors
```
public UserPoolClientType 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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Parameters:
    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 old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreventUserExistenceErrorTypes
  - setEnableTokenRevocation
```
public void setEnableTokenRevocation(Boolean enableTokenRevocation)
```
    Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
    
    Parameters:
    
    enableTokenRevocation - Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
  - getEnableTokenRevocation
```
public Boolean getEnableTokenRevocation()
```
    Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
    
    Returns:
    
    Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
  - withEnableTokenRevocation
```
public UserPoolClientType withEnableTokenRevocation(Boolean enableTokenRevocation)
```
    Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
    
    Parameters:
    
    enableTokenRevocation - Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableTokenRevocation
```
public Boolean isEnableTokenRevocation()
```
    Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
    
    Returns:
    
    Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
  - setEnablePropagateAdditionalUserContextData
```
public void setEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
```
    When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
    
    Parameters:
    
    enablePropagateAdditionalUserContextData - When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
  - getEnablePropagateAdditionalUserContextData
```
public Boolean getEnablePropagateAdditionalUserContextData()
```
    When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
    
    Returns:
    
    When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
  - withEnablePropagateAdditionalUserContextData
```
public UserPoolClientType withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
```
    When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
    
    Parameters:
    
    enablePropagateAdditionalUserContextData - When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnablePropagateAdditionalUserContextData
```
public Boolean isEnablePropagateAdditionalUserContextData()
```
    When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
    
    Returns:
    
    When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
  - setAuthSessionValidity
```
public void setAuthSessionValidity(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.
    
    Parameters:
    
    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.
  - getAuthSessionValidity
```
public 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.
    
    Returns:
    
    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.
  - withAuthSessionValidity
```
public UserPoolClientType withAuthSessionValidity(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserPoolClientType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class UserPoolClientType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserPoolClientType

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setClientName

getClientName

withClientName

setClientId

getClientId

withClientId

setClientSecret

getClientSecret

withClientSecret

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setCreationDate

getCreationDate

withCreationDate

setRefreshTokenValidity

getRefreshTokenValidity

withRefreshTokenValidity

setAccessTokenValidity

getAccessTokenValidity

withAccessTokenValidity

setIdTokenValidity

getIdTokenValidity

withIdTokenValidity

setTokenValidityUnits

getTokenValidityUnits

withTokenValidityUnits

getReadAttributes

setReadAttributes

withReadAttributes

withReadAttributes

getWriteAttributes

setWriteAttributes

withWriteAttributes

withWriteAttributes

getExplicitAuthFlows

setExplicitAuthFlows

withExplicitAuthFlows

withExplicitAuthFlows

withExplicitAuthFlows

getSupportedIdentityProviders

setSupportedIdentityProviders

withSupportedIdentityProviders

withSupportedIdentityProviders

getCallbackURLs

setCallbackURLs

withCallbackURLs

withCallbackURLs

getLogoutURLs

setLogoutURLs

withLogoutURLs

withLogoutURLs

setDefaultRedirectURI

getDefaultRedirectURI

withDefaultRedirectURI

getAllowedOAuthFlows

setAllowedOAuthFlows

withAllowedOAuthFlows

withAllowedOAuthFlows

withAllowedOAuthFlows

getAllowedOAuthScopes

setAllowedOAuthScopes

withAllowedOAuthScopes

withAllowedOAuthScopes

setAllowedOAuthFlowsUserPoolClient

getAllowedOAuthFlowsUserPoolClient

withAllowedOAuthFlowsUserPoolClient

isAllowedOAuthFlowsUserPoolClient

setAnalyticsConfiguration

getAnalyticsConfiguration