CreateUserPoolClientRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.14.3 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.CreateUserPoolClientRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateUserPoolClientRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>

Represents the request to create a user pool client.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateUserPoolClientRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateUserPoolClientRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`accessTokenValidity()` The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used.
`List<OAuthFlowType>`	`allowedOAuthFlows()` The allowed OAuth flows.
`List<String>`	`allowedOAuthFlowsAsStrings()` The allowed OAuth flows.
`Boolean`	`allowedOAuthFlowsUserPoolClient()` Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`List<String>`	`allowedOAuthScopes()` The allowed OAuth scopes.
`AnalyticsConfigurationType`	`analyticsConfiguration()` The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
`static CreateUserPoolClientRequest.Builder`	`builder()`
`List<String>`	`callbackURLs()` A list of allowed redirect (callback) URLs for the identity providers.
`String`	`clientName()` The client name for the user pool client you would like to create.
`String`	`defaultRedirectURI()` The default redirect URI.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<ExplicitAuthFlowsType>`	`explicitAuthFlows()` The authentication flows that are supported by the user pool clients.
`List<String>`	`explicitAuthFlowsAsStrings()` The authentication flows that are supported by the user pool clients.
`Boolean`	`generateSecret()` Boolean to specify whether you want to generate a secret for the user pool client being created.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowedOAuthFlows()` Returns true if the AllowedOAuthFlows property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasAllowedOAuthScopes()` Returns true if the AllowedOAuthScopes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasCallbackURLs()` Returns true if the CallbackURLs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasExplicitAuthFlows()` Returns true if the ExplicitAuthFlows property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasLogoutURLs()` Returns true if the LogoutURLs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasReadAttributes()` Returns true if the ReadAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasSupportedIdentityProviders()` Returns true if the SupportedIdentityProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasWriteAttributes()` Returns true if the WriteAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`idTokenValidity()` The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used.
`List<String>`	`logoutURLs()` A list of allowed logout URLs for the identity providers.
`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.
`String`	`preventUserExistenceErrorsAsString()` 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>`	`readAttributes()` The read attributes.
`Integer`	`refreshTokenValidity()` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateUserPoolClientRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`supportedIdentityProviders()` A list of provider names for the identity providers that are supported on this client.
`CreateUserPoolClientRequest.Builder`	`toBuilder()`
`TokenValidityUnitsType`	`tokenValidityUnits()` The units in which the validity times are represented in.
`String`	`toString()` Returns a string representation of this object.
`String`	`userPoolId()` The user pool ID for the user pool where you want to create a user pool client.
`List<String>`	`writeAttributes()` The user pool attributes that the app client can write to.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - userPoolId
```
public String userPoolId()
```
    The user pool ID for the user pool where you want to create a user pool client.
    
    Returns:
    
    The user pool ID for the user pool where you want to create a user pool client.
  - clientName
```
public String clientName()
```
    The client name for the user pool client you would like to create.
    
    Returns:
    
    The client name for the user pool client you would like to create.
  - generateSecret
```
public Boolean generateSecret()
```
    Boolean to specify whether you want to generate a secret for the user pool client being created.
    
    Returns:
    
    Boolean to specify whether you want to generate a secret for the user pool client being created.
  - refreshTokenValidity
```
public Integer refreshTokenValidity()
```
    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.
  - accessTokenValidity
```
public Integer accessTokenValidity()
```
    The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
    
    Returns:
    
    The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
  - idTokenValidity
```
public Integer idTokenValidity()
```
    The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
    
    Returns:
    
    The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
  - tokenValidityUnits
```
public TokenValidityUnitsType tokenValidityUnits()
```
    The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.
    
    Returns:
    
    The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.
  - hasReadAttributes
```
public boolean hasReadAttributes()
```
    Returns true if the ReadAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - readAttributes
```
public List<String> readAttributes()
```
    The read attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasReadAttributes() to see if a value was sent in this field.
    
    Returns:
    
    The read attributes.
  - hasWriteAttributes
```
public boolean hasWriteAttributes()
```
    Returns true if the WriteAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - writeAttributes
```
public List<String> writeAttributes()
```
    The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasWriteAttributes() to see if a value was sent in this field.
    
    Returns:
    
    The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
  - explicitAuthFlows
```
public List<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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExplicitAuthFlows() to see if a value was sent in this field.
    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.
  - hasExplicitAuthFlows
```
public boolean hasExplicitAuthFlows()
```
    Returns true if the ExplicitAuthFlows property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - explicitAuthFlowsAsStrings
```
public List<String> explicitAuthFlowsAsStrings()
```
    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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExplicitAuthFlows() to see if a value was sent in this field.
    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.
  - hasSupportedIdentityProviders
```
public boolean hasSupportedIdentityProviders()
```
    Returns true if the SupportedIdentityProviders property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - supportedIdentityProviders
```
public List<String> supportedIdentityProviders()
```
    A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSupportedIdentityProviders() to see if a value was sent in this field.
    
    Returns:
    
    A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.
  - hasCallbackURLs
```
public boolean hasCallbackURLs()
```
    Returns true if the CallbackURLs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - callbackURLs
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCallbackURLs() to see if a value was sent in this field.
    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.
  - hasLogoutURLs
```
public boolean hasLogoutURLs()
```
    Returns true if the LogoutURLs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - logoutURLs
```
public List<String> logoutURLs()
```
    A list of allowed logout URLs for the identity providers.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasLogoutURLs() to see if a value was sent in this field.
    
    Returns:
    
    A list of allowed logout URLs for the identity providers.
  - defaultRedirectURI
```
public String defaultRedirectURI()
```
    The default redirect URI. Must be in the CallbackURLs list.
    
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    Returns:
    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.
  - allowedOAuthFlows
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAllowedOAuthFlows() to see if a value was sent in this field.
    
    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.
  - hasAllowedOAuthFlows
```
public boolean hasAllowedOAuthFlows()
```
    Returns true if the AllowedOAuthFlows property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - allowedOAuthFlowsAsStrings
```
public List<String> allowedOAuthFlowsAsStrings()
```
    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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAllowedOAuthFlows() to see if a value was sent in this field.
    
    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.
  - hasAllowedOAuthScopes
```
public boolean hasAllowedOAuthScopes()
```
    Returns true if the AllowedOAuthScopes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - allowedOAuthScopes
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAllowedOAuthScopes() to see if a value was sent in this field.
    
    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.
  - allowedOAuthFlowsUserPoolClient
```
public Boolean allowedOAuthFlowsUserPoolClient()
```
    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.
  - analyticsConfiguration
```
public AnalyticsConfigurationType analyticsConfiguration()
```
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
    
    In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
    
    Returns:
    
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
    
    In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
  - preventUserExistenceErrors
```
public 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.
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    
    If the service returns an enum value that is not available in the current SDK version, preventUserExistenceErrors will return PreventUserExistenceErrorTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preventUserExistenceErrorsAsString().
    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.
    
    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
  - preventUserExistenceErrorsAsString
```
public String preventUserExistenceErrorsAsString()
```
    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.
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    
    If the service returns an enum value that is not available in the current SDK version, preventUserExistenceErrors will return PreventUserExistenceErrorTypes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preventUserExistenceErrorsAsString().
    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.
    
    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
  - toBuilder
```
public CreateUserPoolClientRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static CreateUserPoolClientRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateUserPoolClientRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateUserPoolClientRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

userPoolId

clientName

generateSecret

refreshTokenValidity

accessTokenValidity

idTokenValidity

tokenValidityUnits

hasReadAttributes

readAttributes

hasWriteAttributes

writeAttributes

explicitAuthFlows

hasExplicitAuthFlows

explicitAuthFlowsAsStrings

hasSupportedIdentityProviders

supportedIdentityProviders

hasCallbackURLs

callbackURLs

hasLogoutURLs

logoutURLs

defaultRedirectURI

allowedOAuthFlows

hasAllowedOAuthFlows

allowedOAuthFlowsAsStrings

hasAllowedOAuthScopes

allowedOAuthScopes

allowedOAuthFlowsUserPoolClient

analyticsConfiguration

preventUserExistenceErrors

preventUserExistenceErrorsAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields