UserPoolClientType (AWS Java SDK for Amazon Cognito Identity Provider Service 1.11.764 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)`
`List<String>`	`getAllowedOAuthFlows()` The allowed OAuth flows.
`Boolean`	`getAllowedOAuthFlowsUserPoolClient()` Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`List<String>`	`getAllowedOAuthScopes()` The allowed OAuth scopes.
`AnalyticsConfigurationType`	`getAnalyticsConfiguration()` The Amazon Pinpoint analytics configuration for the user pool client.
`List<String>`	`getCallbackURLs()` A list of allowed redirect (callback) URLs for the identity providers.
`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 the user pool client was created.
`String`	`getDefaultRedirectURI()` The default redirect URI.
`List<String>`	`getExplicitAuthFlows()` The authentication flows that are supported by the user pool clients.
`Date`	`getLastModifiedDate()` The date the user pool client was last modified.
`List<String>`	`getLogoutURLs()` A list of allowed logout URLs for the identity providers.
`String`	`getPreventUserExistenceErrors()` Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
`List<String>`	`getReadAttributes()` The Read-only attributes.
`Integer`	`getRefreshTokenValidity()` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`List<String>`	`getSupportedIdentityProviders()` A list of provider names for the identity providers that are supported on this client.
`String`	`getUserPoolId()` The user pool ID for the user pool client.
`List<String>`	`getWriteAttributes()` The writeable attributes.
`int`	`hashCode()`
`Boolean`	`isAllowedOAuthFlowsUserPoolClient()` Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)` The allowed OAuth flows.
`void`	`setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)` Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`void`	`setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)` The allowed OAuth scopes.
`void`	`setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)` The Amazon Pinpoint analytics configuration for the user pool client.
`void`	`setCallbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`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 the user pool client was created.
`void`	`setDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`void`	`setExplicitAuthFlows(Collection<String> explicitAuthFlows)` The authentication flows that are supported by the user pool clients.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The date the user pool client was last modified.
`void`	`setLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`void`	`setPreventUserExistenceErrors(String preventUserExistenceErrors)` Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
`void`	`setReadAttributes(Collection<String> readAttributes)` The Read-only attributes.
`void`	`setRefreshTokenValidity(Integer refreshTokenValidity)` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`void`	`setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`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`	`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 if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`UserPoolClientType`	`withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)` The allowed OAuth scopes.
`UserPoolClientType`	`withAllowedOAuthScopes(String... allowedOAuthScopes)` The allowed OAuth scopes.
`UserPoolClientType`	`withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)` The Amazon Pinpoint analytics configuration for the user pool client.
`UserPoolClientType`	`withCallbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`UserPoolClientType`	`withCallbackURLs(String... callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`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 the user pool client was created.
`UserPoolClientType`	`withDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`UserPoolClientType`	`withExplicitAuthFlows(Collection<String> explicitAuthFlows)` The authentication flows that are supported by the user pool clients.
`UserPoolClientType`	`withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)` The authentication flows that are supported by the user pool clients.
`UserPoolClientType`	`withExplicitAuthFlows(String... explicitAuthFlows)` The authentication flows that are supported by the user pool clients.
`UserPoolClientType`	`withLastModifiedDate(Date lastModifiedDate)` The date the user pool client was last modified.
`UserPoolClientType`	`withLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`UserPoolClientType`	`withLogoutURLs(String... logoutURLs)` A list of allowed logout URLs for the identity providers.
`UserPoolClientType`	`withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)` Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
`UserPoolClientType`	`withPreventUserExistenceErrors(String preventUserExistenceErrors)` Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not 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 time limit, in days, after which the refresh token is no longer valid and cannot be used.
`UserPoolClientType`	`withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`UserPoolClientType`	`withSupportedIdentityProviders(String... supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`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 the user pool client was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the user pool client was last modified.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date the user pool client was last modified.
    
    Returns:
    
    The date the user pool client was last modified.
  - withLastModifiedDate
```
public UserPoolClientType withLastModifiedDate(Date lastModifiedDate)
```
    The date the user pool client was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the user pool client was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the user pool client was created.
    
    Parameters:
    
    creationDate - The date the user pool client was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the user pool client was created.
    
    Returns:
    
    The date the user pool client was created.
  - withCreationDate
```
public UserPoolClientType withCreationDate(Date creationDate)
```
    The date the user pool client was created.
    
    Parameters:
    
    creationDate - The date the user pool client was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRefreshTokenValidity
```
public void setRefreshTokenValidity(Integer refreshTokenValidity)
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Parameters:
    
    refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - getRefreshTokenValidity
```
public Integer getRefreshTokenValidity()
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Returns:
    
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - withRefreshTokenValidity
```
public UserPoolClientType withRefreshTokenValidity(Integer refreshTokenValidity)
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Parameters:
    
    refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    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 are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    Returns:
    The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    See Also:
    
    ExplicitAuthFlowsType
  - setExplicitAuthFlows
```
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    Parameters:
    explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(String... explicitAuthFlows)
```
    The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    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 are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    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 are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    Parameters:
    explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    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 are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    Parameters:
    explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    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, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, 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.
    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 identity providers that are supported on this client.
    
    Returns:
    
    A list of provider names for the identity providers that are supported on this client.
  - setSupportedIdentityProviders
```
public void setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
```
    A list of provider names for the identity providers that are supported on this client.
    
    Parameters:
    
    supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.
  - withSupportedIdentityProviders
```
public UserPoolClientType withSupportedIdentityProviders(String... supportedIdentityProviders)
```
    A list of provider names for the identity providers that are supported on this client.
    
    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 identity providers that are supported on this client.
    
    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 identity providers that are supported on this client.
    
    Parameters:
    
    supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.
    
    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 identity providers.
    
    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 identity providers.
    
    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 identity providers.
    
    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 identity providers.
    
    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 identity providers.
    
    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 identity providers.
    
    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 identity providers.
    
    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 identity providers.
    
    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 identity providers.
    
    Returns:
    
    A list of allowed logout URLs for the identity providers.
  - setLogoutURLs
```
public void setLogoutURLs(Collection<String> logoutURLs)
```
    A list of allowed logout URLs for the identity providers.
    
    Parameters:
    
    logoutURLs - A list of allowed logout URLs for the identity providers.
  - withLogoutURLs
```
public UserPoolClientType withLogoutURLs(String... logoutURLs)
```
    A list of allowed logout URLs for the identity providers.
    
    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 identity providers.
    
    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 identity providers.
    
    Parameters:
    
    logoutURLs - A list of allowed logout URLs for the identity providers.
    
    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.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Returns:
    
    The allowed OAuth flows.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    See Also:
    
    OAuthFlowType
  - setAllowedOAuthFlows
```
public void setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    See Also:
    
    OAuthFlowType
  - withAllowedOAuthFlows
```
public UserPoolClientType withAllowedOAuthFlows(String... allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client 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.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client 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.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client 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.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client 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 allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Returns:
    
    The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
  - setAllowedOAuthScopes
```
public void setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
```
    The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Parameters:
    
    allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
  - withAllowedOAuthScopes
```
public UserPoolClientType withAllowedOAuthScopes(String... allowedOAuthScopes)
```
    The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    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 allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowedOAuthScopes
```
public UserPoolClientType withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
```
    The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Parameters:
    
    allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAllowedOAuthFlowsUserPoolClient
```
public void setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
```
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Parameters:
    
    allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - getAllowedOAuthFlowsUserPoolClient
```
public Boolean getAllowedOAuthFlowsUserPoolClient()
```
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns:
    
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - withAllowedOAuthFlowsUserPoolClient
```
public UserPoolClientType withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
```
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Parameters:
    
    allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAllowedOAuthFlowsUserPoolClient
```
public Boolean isAllowedOAuthFlowsUserPoolClient()
```
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns:
    
    Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - setAnalyticsConfiguration
```
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
    
    Parameters:
    
    analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
  - getAnalyticsConfiguration
```
public AnalyticsConfigurationType getAnalyticsConfiguration()
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
    
    Returns:
    
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
  - withAnalyticsConfiguration
```
public UserPoolClientType withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
    
    Parameters:
    
    analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which 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)
```
    Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    This setting affects the behavior of following APIs:
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Parameters:
    preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    
    This setting affects the behavior of following APIs:
    
    AdminInitiateAuth
    
    AdminRespondToAuthChallenge
    
    InitiateAuth
    
    RespondToAuthChallenge
    
    ForgotPassword
    
    ConfirmForgotPassword
    
    ConfirmSignUp
    
    ResendConfirmationCode
    
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    See Also:
    
    PreventUserExistenceErrorTypes
  - getPreventUserExistenceErrors
```
public String getPreventUserExistenceErrors()
```
    Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    This setting affects the behavior of following APIs:
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Returns:
    Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    
    This setting affects the behavior of following APIs:
    
    AdminInitiateAuth
    
    AdminRespondToAuthChallenge
    
    InitiateAuth
    
    RespondToAuthChallenge
    
    ForgotPassword
    
    ConfirmForgotPassword
    
    ConfirmSignUp
    
    ResendConfirmationCode
    
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    See Also:
    
    PreventUserExistenceErrorTypes
  - withPreventUserExistenceErrors
```
public UserPoolClientType withPreventUserExistenceErrors(String preventUserExistenceErrors)
```
    Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    This setting affects the behavior of following APIs:
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Parameters:
    preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    
    This setting affects the behavior of following APIs:
    
    AdminInitiateAuth
    
    AdminRespondToAuthChallenge
    
    InitiateAuth
    
    RespondToAuthChallenge
    
    ForgotPassword
    
    ConfirmForgotPassword
    
    ConfirmSignUp
    
    ResendConfirmationCode
    
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreventUserExistenceErrorTypes
  - withPreventUserExistenceErrors
```
public UserPoolClientType withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
```
    Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    This setting affects the behavior of following APIs:
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Parameters:
    preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    
    This setting affects the behavior of following APIs:
    
    AdminInitiateAuth
    
    AdminRespondToAuthChallenge
    
    InitiateAuth
    
    RespondToAuthChallenge
    
    ForgotPassword
    
    ConfirmForgotPassword
    
    ConfirmSignUp
    
    ResendConfirmationCode
    
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreventUserExistenceErrorTypes
  - 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

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

withAnalyticsConfiguration

setPreventUserExistenceErrors

getPreventUserExistenceErrors

withPreventUserExistenceErrors

withPreventUserExistenceErrors

toString

equals

hashCode

clone