@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 time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used.
|
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 identity providers.
|
String |
getClientName()
The client name for the user pool client you would like to create.
|
String |
getDefaultRedirectURI()
The default redirect URI.
|
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 time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used.
|
List<String> |
getLogoutURLs()
A list of allowed logout URLs for the identity providers.
|
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 time limit, in days, after which the refresh token is no longer valid and can't be used.
|
List<String> |
getSupportedIdentityProviders()
A list of provider names for the identity providers that are supported on this client.
|
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 |
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 time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used.
|
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 identity providers.
|
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 |
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 time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used.
|
void |
setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
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 time limit, in days, after which the refresh token is no longer valid and can't be used.
|
void |
setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
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 time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used.
|
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 identity providers.
|
CreateUserPoolClientRequest |
withCallbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
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 |
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 time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used.
|
CreateUserPoolClientRequest |
withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
CreateUserPoolClientRequest |
withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
|
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 time limit, in days, after which the refresh token is no longer valid and can't be used.
|
CreateUserPoolClientRequest |
withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
CreateUserPoolClientRequest |
withSupportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
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, withSdkRequestTimeout
public 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 time limit, in days, after which the refresh token is no longer valid and can't be used.
refreshTokenValidity
- The time limit, in days, after which the refresh token is no longer valid and can't be used.public Integer getRefreshTokenValidity()
The time limit, in days, after which the refresh token is no longer valid and can't be used.
public CreateUserPoolClientRequest withRefreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and can't be used.
refreshTokenValidity
- The time limit, in days, after which the refresh token is no longer valid and can't be used.public void setAccessTokenValidity(Integer accessTokenValidity)
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override the default time unit.
accessTokenValidity
- The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be
used. If you supply a TokenValidityUnits value, you will override the default time unit.public Integer getAccessTokenValidity()
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override the default time unit.
public CreateUserPoolClientRequest withAccessTokenValidity(Integer accessTokenValidity)
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override the default time unit.
accessTokenValidity
- The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be
used. If you supply a TokenValidityUnits value, you will override the default time unit.public void setIdTokenValidity(Integer idTokenValidity)
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override the default time unit.
idTokenValidity
- The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be
used. If you supply a TokenValidityUnits value, you will override the default time unit.public Integer getIdTokenValidity()
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override the default time unit.
public CreateUserPoolClientRequest withIdTokenValidity(Integer idTokenValidity)
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be used. If you supply a TokenValidityUnits value, you will override the default time unit.
idTokenValidity
- The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and can't be
used. If you supply a TokenValidityUnits value, you will override the default time unit.public void setTokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented. Default for RefreshToken is days, and default for ID and access tokens are hours.
tokenValidityUnits
- The units in which the validity times are represented. Default 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. Default 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. Default for RefreshToken is days, and default for ID and access tokens are hours.
tokenValidityUnits
- The units in which the validity times are represented. Default 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 identity provider, this array must include all attributes that you have 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 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 Identity Provider Attribute Mappings for Your user pool.
If your app client allows users to sign in through an identity provider, this array must include all attributes that you have 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 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 Identity Provider 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 identity provider, this array must include all attributes that you have 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 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 Identity Provider 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 identity provider, this array must include all attributes that you have 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 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 Identity Provider 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 identity provider, this array must include all attributes that you have 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 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 Identity Provider 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 identity provider, this array must include all attributes that you have 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 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 Identity Provider 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 identity provider, this array must include all attributes that you have 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 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 Identity Provider 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 identity provider, this array must include all attributes that you have 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 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 Identity Provider 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.
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.
ExplicitAuthFlowsType
public 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.
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.
ExplicitAuthFlowsType
public 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.
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.
ExplicitAuthFlowsType
public 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.
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.
ExplicitAuthFlowsType
public 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.
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.
ExplicitAuthFlowsType
public List<String> getSupportedIdentityProviders()
A list of provider names for the identity providers that are supported on this client. The following are
supported: COGNITO
, Facebook
, Google
and LoginWithAmazon
.
COGNITO
, Facebook
, Google
and
LoginWithAmazon
.public void setSupportedIdentityProviders(Collection<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
.
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
.public CreateUserPoolClientRequest withSupportedIdentityProviders(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
.
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 identity providers that are supported on this client. The following are
supported: COGNITO
, Facebook
, Google
and
LoginWithAmazon
.public CreateUserPoolClientRequest withSupportedIdentityProviders(Collection<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
.
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
.public List<String> getCallbackURLs()
A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
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 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.
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.
public CreateUserPoolClientRequest withCallbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
NOTE: This method appends the values to the existing list (if any). Use
setCallbackURLs(java.util.Collection)
or withCallbackURLs(java.util.Collection)
if you want to
override the existing values.
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.
public CreateUserPoolClientRequest withCallbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
A redirect URI must:
Be an absolute URI.
Be registered with the authorization server.
Not include a fragment component.
See OAuth 2.0 - Redirection Endpoint.
Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
App callback URLs such as myapp://example are also supported.
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.
public List<String> getLogoutURLs()
A list of allowed logout URLs for the identity providers.
public void setLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs
- A list of allowed logout URLs for the identity providers.public CreateUserPoolClientRequest withLogoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
NOTE: This method appends the values to the existing list (if any). Use
setLogoutURLs(java.util.Collection)
or withLogoutURLs(java.util.Collection)
if you want to
override the existing values.
logoutURLs
- A list of allowed logout URLs for the identity providers.public CreateUserPoolClientRequest withLogoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs
- A list of allowed logout URLs for the identity providers.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.
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.
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.
OAuthFlowType
public void setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to implicit
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
Set to client_credentials
to specify that the client should get the access token (and, optionally,
ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
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.
OAuthFlowType
public CreateUserPoolClientRequest withAllowedOAuthFlows(String... allowedOAuthFlows)
The allowed OAuth flows.
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to implicit
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
Set to client_credentials
to specify that the client should get the access token (and, optionally,
ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
NOTE: This method appends the values to the existing list (if any). Use
setAllowedOAuthFlows(java.util.Collection)
or withAllowedOAuthFlows(java.util.Collection)
if
you want to override the existing values.
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.
OAuthFlowType
public CreateUserPoolClientRequest withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to implicit
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
Set to client_credentials
to specify that the client should get the access token (and, optionally,
ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
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.
OAuthFlowType
public CreateUserPoolClientRequest withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
Set to code
to initiate a code grant flow, which provides an authorization code as the response.
This code can be exchanged for access tokens with the token endpoint.
Set to implicit
to specify that the client should get the access token (and, optionally, ID token,
based on scopes) directly.
Set to client_credentials
to specify that the client should get the access token (and, optionally,
ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
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.
OAuthFlowType
public 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.
PreventUserExistenceErrorTypes
public String getPreventUserExistenceErrors()
Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and
password recovery when the user doesn't exist in the user pool. When set to ENABLED
and the user
doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account
confirmation and password recovery return a response indicating a code was sent to a simulated destination. When
set to LEGACY
, those APIs return a UserNotFoundException
exception if the user doesn't
exist in the user pool.
Valid values include:
ENABLED
- This prevents user existence-related errors.
LEGACY
- This represents the 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.
PreventUserExistenceErrorTypes
public 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.
PreventUserExistenceErrorTypes
public 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.
PreventUserExistenceErrorTypes
public 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 String toString()
toString
in class Object
Object.toString()
public CreateUserPoolClientRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()