Class CreateUserPoolRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the request to create a user pool.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Attributes supported as an alias for this user pool.The attributes to be auto-verified.A string representing the email verification message.A string representing the email verification subject.The Lambda trigger configuration information for the new user pool.Specifies MFA configuration details.The policies associated with the new user pool.A string used to name the user pool.A string representing the SMS authentication message.A string representing the SMS verification message.int
hashCode()
void
setAliasAttributes
(Collection<String> aliasAttributes) Attributes supported as an alias for this user pool.void
setAutoVerifiedAttributes
(Collection<String> autoVerifiedAttributes) The attributes to be auto-verified.void
setEmailVerificationMessage
(String emailVerificationMessage) A string representing the email verification message.void
setEmailVerificationSubject
(String emailVerificationSubject) A string representing the email verification subject.void
setLambdaConfig
(LambdaConfigType lambdaConfig) The Lambda trigger configuration information for the new user pool.void
setMfaConfiguration
(UserPoolMfaType mfaConfiguration) Specifies MFA configuration details.void
setMfaConfiguration
(String mfaConfiguration) Specifies MFA configuration details.void
setPolicies
(UserPoolPolicyType policies) The policies associated with the new user pool.void
setPoolName
(String poolName) A string used to name the user pool.void
setSmsAuthenticationMessage
(String smsAuthenticationMessage) A string representing the SMS authentication message.void
setSmsVerificationMessage
(String smsVerificationMessage) A string representing the SMS verification message.toString()
Returns a string representation of this object; useful for testing and debugging.withAliasAttributes
(AliasAttributeType... aliasAttributes) Attributes supported as an alias for this user pool.withAliasAttributes
(String... aliasAttributes) Attributes supported as an alias for this user pool.withAliasAttributes
(Collection<String> aliasAttributes) Attributes supported as an alias for this user pool.withAutoVerifiedAttributes
(VerifiedAttributeType... autoVerifiedAttributes) The attributes to be auto-verified.withAutoVerifiedAttributes
(String... autoVerifiedAttributes) The attributes to be auto-verified.withAutoVerifiedAttributes
(Collection<String> autoVerifiedAttributes) The attributes to be auto-verified.withEmailVerificationMessage
(String emailVerificationMessage) A string representing the email verification message.withEmailVerificationSubject
(String emailVerificationSubject) A string representing the email verification subject.withLambdaConfig
(LambdaConfigType lambdaConfig) The Lambda trigger configuration information for the new user pool.withMfaConfiguration
(UserPoolMfaType mfaConfiguration) Specifies MFA configuration details.withMfaConfiguration
(String mfaConfiguration) Specifies MFA configuration details.withPolicies
(UserPoolPolicyType policies) The policies associated with the new user pool.withPoolName
(String poolName) A string used to name the user pool.withSmsAuthenticationMessage
(String smsAuthenticationMessage) A string representing the SMS authentication message.withSmsVerificationMessage
(String smsVerificationMessage) A string representing the SMS verification message.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
CreateUserPoolRequest
public CreateUserPoolRequest()
-
-
Method Details
-
setPoolName
A string used to name the user pool.
- Parameters:
poolName
- A string used to name the user pool.
-
getPoolName
A string used to name the user pool.
- Returns:
- A string used to name the user pool.
-
withPoolName
A string used to name the user pool.
- Parameters:
poolName
- A string used to name the user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPolicies
The policies associated with the new user pool.
- Parameters:
policies
- The policies associated with the new user pool.
-
getPolicies
The policies associated with the new user pool.
- Returns:
- The policies associated with the new user pool.
-
withPolicies
The policies associated with the new user pool.
- Parameters:
policies
- The policies associated with the new user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLambdaConfig
The Lambda trigger configuration information for the new user pool.
- Parameters:
lambdaConfig
- The Lambda trigger configuration information for the new user pool.
-
getLambdaConfig
The Lambda trigger configuration information for the new user pool.
- Returns:
- The Lambda trigger configuration information for the new user pool.
-
withLambdaConfig
The Lambda trigger configuration information for the new user pool.
- Parameters:
lambdaConfig
- The Lambda trigger configuration information for the new user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getAutoVerifiedAttributes
The attributes to be auto-verified. Possible values: email, phone_number.
- Returns:
- The attributes to be auto-verified. Possible values: email, phone_number.
- See Also:
-
setAutoVerifiedAttributes
The attributes to be auto-verified. Possible values: email, phone_number.
- Parameters:
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.- See Also:
-
withAutoVerifiedAttributes
The attributes to be auto-verified. Possible values: email, phone_number.
NOTE: This method appends the values to the existing list (if any). Use
setAutoVerifiedAttributes(java.util.Collection)
orwithAutoVerifiedAttributes(java.util.Collection)
if you want to override the existing values.- Parameters:
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withAutoVerifiedAttributes
The attributes to be auto-verified. Possible values: email, phone_number.
- Parameters:
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withAutoVerifiedAttributes
public CreateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes) The attributes to be auto-verified. Possible values: email, phone_number.
- Parameters:
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
getAliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
- Returns:
- Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
- See Also:
-
setAliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
- Parameters:
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.- See Also:
-
withAliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
NOTE: This method appends the values to the existing list (if any). Use
setAliasAttributes(java.util.Collection)
orwithAliasAttributes(java.util.Collection)
if you want to override the existing values.- Parameters:
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withAliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
- Parameters:
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
withAliasAttributes
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
- Parameters:
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setSmsVerificationMessage
A string representing the SMS verification message.
- Parameters:
smsVerificationMessage
- A string representing the SMS verification message.
-
getSmsVerificationMessage
A string representing the SMS verification message.
- Returns:
- A string representing the SMS verification message.
-
withSmsVerificationMessage
A string representing the SMS verification message.
- Parameters:
smsVerificationMessage
- A string representing the SMS verification message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEmailVerificationMessage
A string representing the email verification message.
- Parameters:
emailVerificationMessage
- A string representing the email verification message.
-
getEmailVerificationMessage
A string representing the email verification message.
- Returns:
- A string representing the email verification message.
-
withEmailVerificationMessage
A string representing the email verification message.
- Parameters:
emailVerificationMessage
- A string representing the email verification message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEmailVerificationSubject
A string representing the email verification subject.
- Parameters:
emailVerificationSubject
- A string representing the email verification subject.
-
getEmailVerificationSubject
A string representing the email verification subject.
- Returns:
- A string representing the email verification subject.
-
withEmailVerificationSubject
A string representing the email verification subject.
- Parameters:
emailVerificationSubject
- A string representing the email verification subject.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSmsAuthenticationMessage
A string representing the SMS authentication message.
- Parameters:
smsAuthenticationMessage
- A string representing the SMS authentication message.
-
getSmsAuthenticationMessage
A string representing the SMS authentication message.
- Returns:
- A string representing the SMS authentication message.
-
withSmsAuthenticationMessage
A string representing the SMS authentication message.
- Parameters:
smsAuthenticationMessage
- A string representing the SMS authentication message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMfaConfiguration
Specifies MFA configuration details.
- Parameters:
mfaConfiguration
- Specifies MFA configuration details.- See Also:
-
getMfaConfiguration
Specifies MFA configuration details.
- Returns:
- Specifies MFA configuration details.
- See Also:
-
withMfaConfiguration
Specifies MFA configuration details.
- Parameters:
mfaConfiguration
- Specifies MFA configuration details.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setMfaConfiguration
Specifies MFA configuration details.
- Parameters:
mfaConfiguration
- Specifies MFA configuration details.- See Also:
-
withMfaConfiguration
Specifies MFA configuration details.
- Parameters:
mfaConfiguration
- Specifies MFA configuration details.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-