@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to create a user pool client.
NOOP| Constructor and Description | 
|---|
CreateUserPoolClientRequest()  | 
| Modifier and Type | Method and Description | 
|---|---|
CreateUserPoolClientRequest | 
clone()
Creates a shallow clone of this object for all fields except the handler context. 
 | 
boolean | 
equals(Object obj)  | 
Integer | 
getAccessTokenValidity()
 The access token time limit. 
 | 
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 Amazon Cognito user
 pools. 
 | 
List<String> | 
getAllowedOAuthScopes()
 The allowed OAuth scopes. 
 | 
AnalyticsConfigurationType | 
getAnalyticsConfiguration()
 The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. 
 | 
List<String> | 
getCallbackURLs()
 A list of allowed redirect (callback) URLs for the IdPs. 
 | 
String | 
getClientName()
 The client name for the user pool client you would like to create. 
 | 
String | 
getDefaultRedirectURI()
 The default redirect URI. 
 | 
Boolean | 
getEnablePropagateAdditionalUserContextData()
 Activates the propagation of additional user context data. 
 | 
Boolean | 
getEnableTokenRevocation()
 Activates or deactivates token revocation. 
 | 
List<String> | 
getExplicitAuthFlows()
 The authentication flows that are supported by the user pool clients. 
 | 
Boolean | 
getGenerateSecret()
 Boolean to specify whether you want to generate a secret for the user pool client being created. 
 | 
Integer | 
getIdTokenValidity()
 The ID token time limit. 
 | 
List<String> | 
getLogoutURLs()
 A list of allowed logout URLs for the IdPs. 
 | 
String | 
getPreventUserExistenceErrors()
 Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
 password recovery when the user doesn't exist in the user pool. 
 | 
List<String> | 
getReadAttributes()
 The read attributes. 
 | 
Integer | 
getRefreshTokenValidity()
 The refresh token time limit. 
 | 
List<String> | 
getSupportedIdentityProviders()
 A list of provider names for the IdPs that this client supports. 
 | 
TokenValidityUnitsType | 
getTokenValidityUnits()
 The units in which the validity times are represented. 
 | 
String | 
getUserPoolId()
 The user pool ID for the user pool where you want to create a user pool client. 
 | 
List<String> | 
getWriteAttributes()
 The user pool attributes that the app client can write to. 
 | 
int | 
hashCode()  | 
Boolean | 
isAllowedOAuthFlowsUserPoolClient()
 Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
 pools. 
 | 
Boolean | 
isEnablePropagateAdditionalUserContextData()
 Activates the propagation of additional user context data. 
 | 
Boolean | 
isEnableTokenRevocation()
 Activates or deactivates token revocation. 
 | 
Boolean | 
isGenerateSecret()
 Boolean to specify whether you want to generate a secret for the user pool client being created. 
 | 
void | 
setAccessTokenValidity(Integer accessTokenValidity)
 The access token time limit. 
 | 
void | 
setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
 The allowed OAuth flows. 
 | 
void | 
setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
 Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
 pools. 
 | 
void | 
setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
 The allowed OAuth scopes. 
 | 
void | 
setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
 The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. 
 | 
void | 
setCallbackURLs(Collection<String> callbackURLs)
 A list of allowed redirect (callback) URLs for the IdPs. 
 | 
void | 
setClientName(String clientName)
 The client name for the user pool client you would like to create. 
 | 
void | 
setDefaultRedirectURI(String defaultRedirectURI)
 The default redirect URI. 
 | 
void | 
setEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
 Activates the propagation of additional user context data. 
 | 
void | 
setEnableTokenRevocation(Boolean enableTokenRevocation)
 Activates or deactivates token revocation. 
 | 
void | 
setExplicitAuthFlows(Collection<String> explicitAuthFlows)
 The authentication flows that are supported by the user pool clients. 
 | 
void | 
setGenerateSecret(Boolean generateSecret)
 Boolean to specify whether you want to generate a secret for the user pool client being created. 
 | 
void | 
setIdTokenValidity(Integer idTokenValidity)
 The ID token time limit. 
 | 
void | 
setLogoutURLs(Collection<String> logoutURLs)
 A list of allowed logout URLs for the IdPs. 
 | 
void | 
setPreventUserExistenceErrors(String preventUserExistenceErrors)
 Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
 password recovery when the user doesn't exist in the user pool. 
 | 
void | 
setReadAttributes(Collection<String> readAttributes)
 The read attributes. 
 | 
void | 
setRefreshTokenValidity(Integer refreshTokenValidity)
 The refresh token time limit. 
 | 
void | 
setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
 A list of provider names for the IdPs that this client supports. 
 | 
void | 
setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
 The units in which the validity times are represented. 
 | 
void | 
setUserPoolId(String userPoolId)
 The user pool ID for the user pool where you want to create a user pool client. 
 | 
void | 
setWriteAttributes(Collection<String> writeAttributes)
 The user pool attributes that the app client can write to. 
 | 
String | 
toString()
Returns a string representation of this object. 
 | 
CreateUserPoolClientRequest | 
withAccessTokenValidity(Integer accessTokenValidity)
 The access token time limit. 
 | 
CreateUserPoolClientRequest | 
withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
 The allowed OAuth flows. 
 | 
CreateUserPoolClientRequest | 
withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
 The allowed OAuth flows. 
 | 
CreateUserPoolClientRequest | 
withAllowedOAuthFlows(String... allowedOAuthFlows)
 The allowed OAuth flows. 
 | 
CreateUserPoolClientRequest | 
withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
 Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
 pools. 
 | 
CreateUserPoolClientRequest | 
withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
 The allowed OAuth scopes. 
 | 
CreateUserPoolClientRequest | 
withAllowedOAuthScopes(String... allowedOAuthScopes)
 The allowed OAuth scopes. 
 | 
CreateUserPoolClientRequest | 
withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
 The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign. 
 | 
CreateUserPoolClientRequest | 
withCallbackURLs(Collection<String> callbackURLs)
 A list of allowed redirect (callback) URLs for the IdPs. 
 | 
CreateUserPoolClientRequest | 
withCallbackURLs(String... callbackURLs)
 A list of allowed redirect (callback) URLs for the IdPs. 
 | 
CreateUserPoolClientRequest | 
withClientName(String clientName)
 The client name for the user pool client you would like to create. 
 | 
CreateUserPoolClientRequest | 
withDefaultRedirectURI(String defaultRedirectURI)
 The default redirect URI. 
 | 
CreateUserPoolClientRequest | 
withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
 Activates the propagation of additional user context data. 
 | 
CreateUserPoolClientRequest | 
withEnableTokenRevocation(Boolean enableTokenRevocation)
 Activates or deactivates token revocation. 
 | 
CreateUserPoolClientRequest | 
withExplicitAuthFlows(Collection<String> explicitAuthFlows)
 The authentication flows that are supported by the user pool clients. 
 | 
CreateUserPoolClientRequest | 
withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
 The authentication flows that are supported by the user pool clients. 
 | 
CreateUserPoolClientRequest | 
withExplicitAuthFlows(String... explicitAuthFlows)
 The authentication flows that are supported by the user pool clients. 
 | 
CreateUserPoolClientRequest | 
withGenerateSecret(Boolean generateSecret)
 Boolean to specify whether you want to generate a secret for the user pool client being created. 
 | 
CreateUserPoolClientRequest | 
withIdTokenValidity(Integer idTokenValidity)
 The ID token time limit. 
 | 
CreateUserPoolClientRequest | 
withLogoutURLs(Collection<String> logoutURLs)
 A list of allowed logout URLs for the IdPs. 
 | 
CreateUserPoolClientRequest | 
withLogoutURLs(String... logoutURLs)
 A list of allowed logout URLs for the IdPs. 
 | 
CreateUserPoolClientRequest | 
withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
 Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
 password recovery when the user doesn't exist in the user pool. 
 | 
CreateUserPoolClientRequest | 
withPreventUserExistenceErrors(String preventUserExistenceErrors)
 Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
 password recovery when the user doesn't exist in the user pool. 
 | 
CreateUserPoolClientRequest | 
withReadAttributes(Collection<String> readAttributes)
 The read attributes. 
 | 
CreateUserPoolClientRequest | 
withReadAttributes(String... readAttributes)
 The read attributes. 
 | 
CreateUserPoolClientRequest | 
withRefreshTokenValidity(Integer refreshTokenValidity)
 The refresh token time limit. 
 | 
CreateUserPoolClientRequest | 
withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
 A list of provider names for the IdPs that this client supports. 
 | 
CreateUserPoolClientRequest | 
withSupportedIdentityProviders(String... supportedIdentityProviders)
 A list of provider names for the IdPs that this client supports. 
 | 
CreateUserPoolClientRequest | 
withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
 The units in which the validity times are represented. 
 | 
CreateUserPoolClientRequest | 
withUserPoolId(String userPoolId)
 The user pool ID for the user pool where you want to create a user pool client. 
 | 
CreateUserPoolClientRequest | 
withWriteAttributes(Collection<String> writeAttributes)
 The user pool attributes that the app client can write to. 
 | 
CreateUserPoolClientRequest | 
withWriteAttributes(String... writeAttributes)
 The user pool attributes that the app client can write to. 
 | 
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
userPoolId - The user pool ID for the user pool where you want to create a user pool client.public String getUserPoolId()
The user pool ID for the user pool where you want to create a user pool client.
public CreateUserPoolClientRequest withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
userPoolId - The user pool ID for the user pool where you want to create a user pool client.public void setClientName(String clientName)
The client name for the user pool client you would like to create.
clientName - The client name for the user pool client you would like to create.public String getClientName()
The client name for the user pool client you would like to create.
public CreateUserPoolClientRequest withClientName(String clientName)
The client name for the user pool client you would like to create.
clientName - The client name for the user pool client you would like to create.public void setGenerateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.public Boolean getGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
public CreateUserPoolClientRequest withGenerateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.public Boolean isGenerateSecret()
Boolean to specify whether you want to generate a secret for the user pool client being created.
public void setRefreshTokenValidity(Integer refreshTokenValidity)
 The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the
 time unit for RefreshTokenValidity as seconds, minutes, hours
 , or days, set a TokenValidityUnits value in your API request.
 
 For example, when you set RefreshTokenValidity as 10 and
 TokenValidityUnits as days, your user can refresh their session and retrieve new access
 and ID tokens for 10 days.
 
 The default time unit for RefreshTokenValidity in an API request is days. You can't set
 RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of
 30 days. Valid range is displayed below in seconds.
 
refreshTokenValidity - The refresh token time limit. After this limit expires, your user can't use their refresh token. To
        specify the time unit for RefreshTokenValidity as seconds, minutes,
        hours, or days, set a TokenValidityUnits value in your API
        request.
        
        For example, when you set RefreshTokenValidity as 10 and
        TokenValidityUnits as days, your user can refresh their session and retrieve new
        access and ID tokens for 10 days.
        
        The default time unit for RefreshTokenValidity in an API request is days. You can't set
        RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default
        value of 30 days. Valid range is displayed below in seconds.
public Integer getRefreshTokenValidity()
 The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the
 time unit for RefreshTokenValidity as seconds, minutes, hours
 , or days, set a TokenValidityUnits value in your API request.
 
 For example, when you set RefreshTokenValidity as 10 and
 TokenValidityUnits as days, your user can refresh their session and retrieve new access
 and ID tokens for 10 days.
 
 The default time unit for RefreshTokenValidity in an API request is days. You can't set
 RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of
 30 days. Valid range is displayed below in seconds.
 
RefreshTokenValidity as seconds, minutes
         , hours, or days, set a TokenValidityUnits value in your API
         request.
         
         For example, when you set RefreshTokenValidity as 10 and
         TokenValidityUnits as days, your user can refresh their session and retrieve
         new access and ID tokens for 10 days.
         
         The default time unit for RefreshTokenValidity in an API request is days. You can't set
         RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default
         value of 30 days. Valid range is displayed below in seconds.
public CreateUserPoolClientRequest withRefreshTokenValidity(Integer refreshTokenValidity)
 The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the
 time unit for RefreshTokenValidity as seconds, minutes, hours
 , or days, set a TokenValidityUnits value in your API request.
 
 For example, when you set RefreshTokenValidity as 10 and
 TokenValidityUnits as days, your user can refresh their session and retrieve new access
 and ID tokens for 10 days.
 
 The default time unit for RefreshTokenValidity in an API request is days. You can't set
 RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of
 30 days. Valid range is displayed below in seconds.
 
refreshTokenValidity - The refresh token time limit. After this limit expires, your user can't use their refresh token. To
        specify the time unit for RefreshTokenValidity as seconds, minutes,
        hours, or days, set a TokenValidityUnits value in your API
        request.
        
        For example, when you set RefreshTokenValidity as 10 and
        TokenValidityUnits as days, your user can refresh their session and retrieve new
        access and ID tokens for 10 days.
        
        The default time unit for RefreshTokenValidity in an API request is days. You can't set
        RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default
        value of 30 days. Valid range is displayed below in seconds.
public void setAccessTokenValidity(Integer accessTokenValidity)
 The access token time limit. After this limit expires, your user can't use their access token. To specify the
 time unit for AccessTokenValidity as seconds, minutes, hours,
 or days, set a TokenValidityUnits value in your API request.
 
 For example, when you set AccessTokenValidity to 10 and TokenValidityUnits
 to hours, your user can authorize access with their access token for 10 hours.
 
 The default time unit for AccessTokenValidity in an API request is hours. Valid range is
 displayed below in seconds.
 
accessTokenValidity - The access token time limit. After this limit expires, your user can't use their access token. To specify
        the time unit for AccessTokenValidity as seconds, minutes,
        hours, or days, set a TokenValidityUnits value in your API
        request.
        
        For example, when you set AccessTokenValidity to 10 and
        TokenValidityUnits to hours, your user can authorize access with their access
        token for 10 hours.
        
        The default time unit for AccessTokenValidity in an API request is hours. Valid range
        is displayed below in seconds.
public Integer getAccessTokenValidity()
 The access token time limit. After this limit expires, your user can't use their access token. To specify the
 time unit for AccessTokenValidity as seconds, minutes, hours,
 or days, set a TokenValidityUnits value in your API request.
 
 For example, when you set AccessTokenValidity to 10 and TokenValidityUnits
 to hours, your user can authorize access with their access token for 10 hours.
 
 The default time unit for AccessTokenValidity in an API request is hours. Valid range is
 displayed below in seconds.
 
AccessTokenValidity as seconds, minutes,
         hours, or days, set a TokenValidityUnits value in your API
         request.
         
         For example, when you set AccessTokenValidity to 10 and
         TokenValidityUnits to hours, your user can authorize access with their access
         token for 10 hours.
         
         The default time unit for AccessTokenValidity in an API request is hours. Valid range
         is displayed below in seconds.
public CreateUserPoolClientRequest withAccessTokenValidity(Integer accessTokenValidity)
 The access token time limit. After this limit expires, your user can't use their access token. To specify the
 time unit for AccessTokenValidity as seconds, minutes, hours,
 or days, set a TokenValidityUnits value in your API request.
 
 For example, when you set AccessTokenValidity to 10 and TokenValidityUnits
 to hours, your user can authorize access with their access token for 10 hours.
 
 The default time unit for AccessTokenValidity in an API request is hours. Valid range is
 displayed below in seconds.
 
accessTokenValidity - The access token time limit. After this limit expires, your user can't use their access token. To specify
        the time unit for AccessTokenValidity as seconds, minutes,
        hours, or days, set a TokenValidityUnits value in your API
        request.
        
        For example, when you set AccessTokenValidity to 10 and
        TokenValidityUnits to hours, your user can authorize access with their access
        token for 10 hours.
        
        The default time unit for AccessTokenValidity in an API request is hours. Valid range
        is displayed below in seconds.
public void setIdTokenValidity(Integer idTokenValidity)
 The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit
 for IdTokenValidity as seconds, minutes, hours, or
 days, set a TokenValidityUnits value in your API request.
 
 For example, when you set IdTokenValidity as 10 and TokenValidityUnits as
 hours, your user can authenticate their session with their ID token for 10 hours.
 
 The default time unit for AccessTokenValidity in an API request is hours. Valid range is
 displayed below in seconds.
 
idTokenValidity - The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time
        unit for IdTokenValidity as seconds, minutes, hours,
        or days, set a TokenValidityUnits value in your API request.
        
        For example, when you set IdTokenValidity as 10 and
        TokenValidityUnits as hours, your user can authenticate their session with their
        ID token for 10 hours.
        
        The default time unit for AccessTokenValidity in an API request is hours. Valid range
        is displayed below in seconds.
public Integer getIdTokenValidity()
 The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit
 for IdTokenValidity as seconds, minutes, hours, or
 days, set a TokenValidityUnits value in your API request.
 
 For example, when you set IdTokenValidity as 10 and TokenValidityUnits as
 hours, your user can authenticate their session with their ID token for 10 hours.
 
 The default time unit for AccessTokenValidity in an API request is hours. Valid range is
 displayed below in seconds.
 
IdTokenValidity as seconds, minutes,
         hours, or days, set a TokenValidityUnits value in your API
         request.
         
         For example, when you set IdTokenValidity as 10 and
         TokenValidityUnits as hours, your user can authenticate their session with
         their ID token for 10 hours.
         
         The default time unit for AccessTokenValidity in an API request is hours. Valid range
         is displayed below in seconds.
public CreateUserPoolClientRequest withIdTokenValidity(Integer idTokenValidity)
 The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit
 for IdTokenValidity as seconds, minutes, hours, or
 days, set a TokenValidityUnits value in your API request.
 
 For example, when you set IdTokenValidity as 10 and TokenValidityUnits as
 hours, your user can authenticate their session with their ID token for 10 hours.
 
 The default time unit for AccessTokenValidity in an API request is hours. Valid range is
 displayed below in seconds.
 
idTokenValidity - The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time
        unit for IdTokenValidity as seconds, minutes, hours,
        or days, set a TokenValidityUnits value in your API request.
        
        For example, when you set IdTokenValidity as 10 and
        TokenValidityUnits as hours, your user can authenticate their session with their
        ID token for 10 hours.
        
        The default time unit for AccessTokenValidity in an API request is hours. Valid range
        is displayed below in seconds.
public void setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
tokenValidityUnits - The units in which the validity times are represented. The default unit for RefreshToken is days, and
        default for ID and access tokens are hours.public TokenValidityUnitsType getTokenValidityUnits()
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
public CreateUserPoolClientRequest withTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
tokenValidityUnits - The units in which the validity times are represented. The default unit for RefreshToken is days, and
        default for ID and access tokens are hours.public List<String> getReadAttributes()
The read attributes.
public void setReadAttributes(Collection<String> readAttributes)
The read attributes.
readAttributes - The read attributes.public CreateUserPoolClientRequest withReadAttributes(String... readAttributes)
The read 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.
 
readAttributes - The read attributes.public CreateUserPoolClientRequest withReadAttributes(Collection<String> readAttributes)
The read attributes.
readAttributes - The read attributes.public List<String> getWriteAttributes()
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
public void setWriteAttributes(Collection<String> writeAttributes)
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
writeAttributes - The user pool attributes that the app client can write to.
        If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
public CreateUserPoolClientRequest withWriteAttributes(String... writeAttributes)
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
 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.
 
writeAttributes - The user pool attributes that the app client can write to.
        If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
public CreateUserPoolClientRequest withWriteAttributes(Collection<String> writeAttributes)
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
writeAttributes - The user pool attributes that the app client can write to.
        If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
public List<String> getExplicitAuthFlows()
 The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
 prefix are no longer supported, in favor of new names with the ALLOW_ prefix.
 
 Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote
 Password (SRP) protocol to verify passwords.
 
 ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
 
 ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito
 receives the password in the request instead of using the SRP protocol to verify passwords.
 
 ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
 
 ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
 
 If you don't specify a value for ExplicitAuthFlows, your app client activates the
 ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
 
ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_
         prefix. 
         Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the
         Secure Remote Password (SRP) protocol to verify passwords.
         
         ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
         
         ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon
         Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
         
         ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
         
         ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
         
         If you don't specify a value for ExplicitAuthFlows, your app client activates the
         ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
ExplicitAuthFlowsTypepublic void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
 The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
 prefix are no longer supported, in favor of new names with the ALLOW_ prefix.
 
 Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote
 Password (SRP) protocol to verify passwords.
 
 ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
 
 ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito
 receives the password in the request instead of using the SRP protocol to verify passwords.
 
 ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
 
 ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
 
 If you don't specify a value for ExplicitAuthFlows, your app client activates the
 ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
 
explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the
        ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_
        prefix. 
        Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the
        Secure Remote Password (SRP) protocol to verify passwords.
        
        ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
        
        ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon
        Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
        
        ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
        
        ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
        
        If you don't specify a value for ExplicitAuthFlows, your app client activates the
        ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
ExplicitAuthFlowsTypepublic CreateUserPoolClientRequest withExplicitAuthFlows(String... explicitAuthFlows)
 The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
 prefix are no longer supported, in favor of new names with the ALLOW_ prefix.
 
 Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote
 Password (SRP) protocol to verify passwords.
 
 ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
 
 ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito
 receives the password in the request instead of using the SRP protocol to verify passwords.
 
 ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
 
 ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
 
 If you don't specify a value for ExplicitAuthFlows, your app client activates the
 ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
 
 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.
 
explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the
        ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_
        prefix. 
        Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the
        Secure Remote Password (SRP) protocol to verify passwords.
        
        ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
        
        ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon
        Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
        
        ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
        
        ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
        
        If you don't specify a value for ExplicitAuthFlows, your app client activates the
        ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
ExplicitAuthFlowsTypepublic CreateUserPoolClientRequest withExplicitAuthFlows(Collection<String> explicitAuthFlows)
 The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
 prefix are no longer supported, in favor of new names with the ALLOW_ prefix.
 
 Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote
 Password (SRP) protocol to verify passwords.
 
 ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
 
 ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito
 receives the password in the request instead of using the SRP protocol to verify passwords.
 
 ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
 
 ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
 
 If you don't specify a value for ExplicitAuthFlows, your app client activates the
 ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
 
explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the
        ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_
        prefix. 
        Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the
        Secure Remote Password (SRP) protocol to verify passwords.
        
        ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
        
        ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon
        Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
        
        ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
        
        ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
        
        If you don't specify a value for ExplicitAuthFlows, your app client activates the
        ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
ExplicitAuthFlowsTypepublic CreateUserPoolClientRequest withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
 The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
 prefix are no longer supported, in favor of new names with the ALLOW_ prefix.
 
 Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote
 Password (SRP) protocol to verify passwords.
 
 ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
 
 ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon Cognito
 receives the password in the request instead of using the SRP protocol to verify passwords.
 
 ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
 
 ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
 
 If you don't specify a value for ExplicitAuthFlows, your app client activates the
 ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
 
explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the
        ALLOW_ prefix are no longer supported, in favor of new names with the ALLOW_
        prefix. 
        Values with ALLOW_ prefix must be used only along with the 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, Amazon Cognito receives the password in the request instead of using the
        Secure Remote Password (SRP) protocol to verify passwords.
        
        ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
        
        ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon
        Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
        
        ALLOW_USER_SRP_AUTH: Enable SRP-based authentication.
        
        ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
        
        If you don't specify a value for ExplicitAuthFlows, your app client activates the
        ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
ExplicitAuthFlowsTypepublic List<String> getSupportedIdentityProviders()
 A list of provider names for the IdPs that this client supports. The following are supported:
 COGNITO, Facebook, Google LoginWithAmazon, and the names of
 your own SAML and OIDC providers.
 
COGNITO, Facebook, Google LoginWithAmazon, and the
         names of your own SAML and OIDC providers.public void setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
 A list of provider names for the IdPs that this client supports. The following are supported:
 COGNITO, Facebook, Google LoginWithAmazon, and the names of
 your own SAML and OIDC providers.
 
supportedIdentityProviders - A list of provider names for the IdPs that this client supports. The following are supported:
        COGNITO, Facebook, Google LoginWithAmazon, and the
        names of your own SAML and OIDC providers.public CreateUserPoolClientRequest withSupportedIdentityProviders(String... supportedIdentityProviders)
 A list of provider names for the IdPs that this client supports. The following are supported:
 COGNITO, Facebook, Google LoginWithAmazon, and the names of
 your own SAML and OIDC providers.
 
 NOTE: This method appends the values to the existing list (if any). Use
 setSupportedIdentityProviders(java.util.Collection) or
 withSupportedIdentityProviders(java.util.Collection) if you want to override the existing values.
 
supportedIdentityProviders - A list of provider names for the IdPs that this client supports. The following are supported:
        COGNITO, Facebook, Google LoginWithAmazon, and the
        names of your own SAML and OIDC providers.public CreateUserPoolClientRequest withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
 A list of provider names for the IdPs that this client supports. The following are supported:
 COGNITO, Facebook, Google LoginWithAmazon, and the names of
 your own SAML and OIDC providers.
 
supportedIdentityProviders - A list of provider names for the IdPs that this client supports. The following are supported:
        COGNITO, Facebook, Google LoginWithAmazon, and the
        names of your own SAML and OIDC providers.public List<String> getCallbackURLs()
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public void setCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
        A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public CreateUserPoolClientRequest withCallbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
 NOTE: This method appends the values to the existing list (if any). Use
 setCallbackURLs(java.util.Collection) or withCallbackURLs(java.util.Collection) if you want to
 override the existing values.
 
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
        A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public CreateUserPoolClientRequest withCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
callbackURLs - A list of allowed redirect (callback) URLs for the IdPs.
        A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public List<String> getLogoutURLs()
A list of allowed logout URLs for the IdPs.
public void setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
logoutURLs - A list of allowed logout URLs for the IdPs.public CreateUserPoolClientRequest withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the IdPs.
 NOTE: This method appends the values to the existing list (if any). Use
 setLogoutURLs(java.util.Collection) or withLogoutURLs(java.util.Collection) if you want to
 override the existing values.
 
logoutURLs - A list of allowed logout URLs for the IdPs.public CreateUserPoolClientRequest withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
logoutURLs - A list of allowed logout URLs for the IdPs.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.
defaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
        A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public 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.
CallbackURLs list.
         A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public CreateUserPoolClientRequest 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.
defaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
        A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
public List<String> getAllowedOAuthFlows()
The allowed OAuth flows.
 Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for
 access tokens with the /oauth2/token endpoint.
 
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
 Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
 combination of the client ID and client secret.
 
         Use a code grant flow, which provides an authorization code as the response. This code can be exchanged
         for access tokens with the /oauth2/token endpoint.
         
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
         Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
         combination of the client ID and client secret.
         
OAuthFlowTypepublic void setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
 Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for
 access tokens with the /oauth2/token endpoint.
 
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
 Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
 combination of the client ID and client secret.
 
allowedOAuthFlows - The allowed OAuth flows.
        
        Use a code grant flow, which provides an authorization code as the response. This code can be exchanged
        for access tokens with the /oauth2/token endpoint.
        
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
        Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
        combination of the client ID and client secret.
        
OAuthFlowTypepublic CreateUserPoolClientRequest withAllowedOAuthFlows(String... allowedOAuthFlows)
The allowed OAuth flows.
 Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for
 access tokens with the /oauth2/token endpoint.
 
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
 Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
 combination of the client ID and client secret.
 
 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.
 
allowedOAuthFlows - The allowed OAuth flows.
        
        Use a code grant flow, which provides an authorization code as the response. This code can be exchanged
        for access tokens with the /oauth2/token endpoint.
        
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
        Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
        combination of the client ID and client secret.
        
OAuthFlowTypepublic CreateUserPoolClientRequest withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
 Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for
 access tokens with the /oauth2/token endpoint.
 
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
 Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
 combination of the client ID and client secret.
 
allowedOAuthFlows - The allowed OAuth flows.
        
        Use a code grant flow, which provides an authorization code as the response. This code can be exchanged
        for access tokens with the /oauth2/token endpoint.
        
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
        Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
        combination of the client ID and client secret.
        
OAuthFlowTypepublic CreateUserPoolClientRequest withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
 Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for
 access tokens with the /oauth2/token endpoint.
 
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
 Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
 combination of the client ID and client secret.
 
allowedOAuthFlows - The allowed OAuth flows.
        
        Use a code grant flow, which provides an authorization code as the response. This code can be exchanged
        for access tokens with the /oauth2/token endpoint.
        
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
        Issue the access token from the /oauth2/token endpoint directly to a non-person user using a
        combination of the client ID and client secret.
        
OAuthFlowTypepublic List<String> getAllowedOAuthScopes()
 The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
 openid, and profile. Possible values provided by Amazon Web Services are
 aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
 
phone, email,
         openid, and profile. Possible values provided by Amazon Web Services are
         aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.public void setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
 The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
 openid, and profile. Possible values provided by Amazon Web Services are
 aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
 
allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
        openid, and profile. Possible values provided by Amazon Web Services are
        aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.public CreateUserPoolClientRequest withAllowedOAuthScopes(String... allowedOAuthScopes)
 The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
 openid, and profile. Possible values provided by Amazon Web Services are
 aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
 
 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.
 
allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
        openid, and profile. Possible values provided by Amazon Web Services are
        aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.public CreateUserPoolClientRequest withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
 The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
 openid, and profile. Possible values provided by Amazon Web Services are
 aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
 
allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
        openid, and profile. Possible values provided by Amazon Web Services are
        aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.public void setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito
        user pools.public Boolean getAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
public CreateUserPoolClientRequest withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito
        user pools.public Boolean isAllowedOAuthFlowsUserPoolClient()
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
analyticsConfiguration - The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint
        campaign. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public AnalyticsConfigurationType getAnalyticsConfiguration()
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public CreateUserPoolClientRequest withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
analyticsConfiguration - The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint
        campaign. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
public void setPreventUserExistenceErrors(String preventUserExistenceErrors)
 Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
 password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
 doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
 confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
 set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
 exist in the user pool.
 
Valid values include:
 ENABLED - This prevents user existence-related errors.
 
 LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors
 aren't prevented.
 
preventUserExistenceErrors - Errors and responses that you want Amazon Cognito APIs to return during authentication, account
        confirmation, and password recovery when the user doesn't exist in the user pool. When set to
        ENABLED and the user doesn't exist, authentication returns an error indicating either the
        username or password was incorrect. Account confirmation and password recovery return a response
        indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return
        a UserNotFoundException exception if the user doesn't exist in the user pool.
        Valid values include:
        ENABLED - This prevents user existence-related errors.
        
        LEGACY - This represents the early behavior of Amazon Cognito where user existence related
        errors aren't prevented.
        
PreventUserExistenceErrorTypespublic String getPreventUserExistenceErrors()
 Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
 password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
 doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
 confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
 set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
 exist in the user pool.
 
Valid values include:
 ENABLED - This prevents user existence-related errors.
 
 LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors
 aren't prevented.
 
ENABLED and the user doesn't exist, authentication returns an error indicating either the
         username or password was incorrect. Account confirmation and password recovery return a response
         indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return
         a UserNotFoundException exception if the user doesn't exist in the user pool.
         Valid values include:
         ENABLED - This prevents user existence-related errors.
         
         LEGACY - This represents the early behavior of Amazon Cognito where user existence related
         errors aren't prevented.
         
PreventUserExistenceErrorTypespublic CreateUserPoolClientRequest withPreventUserExistenceErrors(String preventUserExistenceErrors)
 Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
 password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
 doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
 confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
 set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
 exist in the user pool.
 
Valid values include:
 ENABLED - This prevents user existence-related errors.
 
 LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors
 aren't prevented.
 
preventUserExistenceErrors - Errors and responses that you want Amazon Cognito APIs to return during authentication, account
        confirmation, and password recovery when the user doesn't exist in the user pool. When set to
        ENABLED and the user doesn't exist, authentication returns an error indicating either the
        username or password was incorrect. Account confirmation and password recovery return a response
        indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return
        a UserNotFoundException exception if the user doesn't exist in the user pool.
        Valid values include:
        ENABLED - This prevents user existence-related errors.
        
        LEGACY - This represents the early behavior of Amazon Cognito where user existence related
        errors aren't prevented.
        
PreventUserExistenceErrorTypespublic CreateUserPoolClientRequest withPreventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
 Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
 password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user
 doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
 confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
 set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't
 exist in the user pool.
 
Valid values include:
 ENABLED - This prevents user existence-related errors.
 
 LEGACY - This represents the early behavior of Amazon Cognito where user existence related errors
 aren't prevented.
 
preventUserExistenceErrors - Errors and responses that you want Amazon Cognito APIs to return during authentication, account
        confirmation, and password recovery when the user doesn't exist in the user pool. When set to
        ENABLED and the user doesn't exist, authentication returns an error indicating either the
        username or password was incorrect. Account confirmation and password recovery return a response
        indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return
        a UserNotFoundException exception if the user doesn't exist in the user pool.
        Valid values include:
        ENABLED - This prevents user existence-related errors.
        
        LEGACY - This represents the early behavior of Amazon Cognito where user existence related
        errors aren't prevented.
        
PreventUserExistenceErrorTypespublic void setEnableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
enableTokenRevocation - Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
        If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public Boolean getEnableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public CreateUserPoolClientRequest withEnableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
enableTokenRevocation - Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
        If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public Boolean isEnableTokenRevocation()
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
public void setEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
 Activates the propagation of additional user context data. For more information about propagation of user context
 data, see 
 Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
 fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate
 EnablePropagateAdditionalUserContextData in an app client that has a client secret.
 
enablePropagateAdditionalUserContextData - Activates the propagation of additional user context data. For more information about propagation of user
        context data, see  Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
        fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only
        activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.public Boolean getEnablePropagateAdditionalUserContextData()
 Activates the propagation of additional user context data. For more information about propagation of user context
 data, see 
 Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
 fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate
 EnablePropagateAdditionalUserContextData in an app client that has a client secret.
 
EnablePropagateAdditionalUserContextData in an app client that has a client secret.public CreateUserPoolClientRequest withEnablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
 Activates the propagation of additional user context data. For more information about propagation of user context
 data, see 
 Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
 fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate
 EnablePropagateAdditionalUserContextData in an app client that has a client secret.
 
enablePropagateAdditionalUserContextData - Activates the propagation of additional user context data. For more information about propagation of user
        context data, see  Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
        fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only
        activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.public Boolean isEnablePropagateAdditionalUserContextData()
 Activates the propagation of additional user context data. For more information about propagation of user context
 data, see 
 Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
 fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only activate
 EnablePropagateAdditionalUserContextData in an app client that has a client secret.
 
EnablePropagateAdditionalUserContextData in an app client that has a client secret.public String toString()
toString in class ObjectObject.toString()public CreateUserPoolClientRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()