@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateUserPoolRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to create a user pool.
NOOP
Constructor and Description |
---|
CreateUserPoolRequest() |
Modifier and Type | Method and Description |
---|---|
CreateUserPoolRequest |
addUserPoolTagsEntry(String key,
String value) |
CreateUserPoolRequest |
clearUserPoolTagsEntries()
Removes all the entries added into UserPoolTags.
|
CreateUserPoolRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
AdminCreateUserConfigType |
getAdminCreateUserConfig()
The configuration for
AdminCreateUser requests. |
List<String> |
getAliasAttributes()
Attributes supported as an alias for this user pool.
|
List<String> |
getAutoVerifiedAttributes()
The attributes to be auto-verified.
|
DeviceConfigurationType |
getDeviceConfiguration()
The device configuration.
|
EmailConfigurationType |
getEmailConfiguration()
The email configuration.
|
String |
getEmailVerificationMessage()
A string representing the email verification message.
|
String |
getEmailVerificationSubject()
A string representing the email verification subject.
|
LambdaConfigType |
getLambdaConfig()
The Lambda trigger configuration information for the new user pool.
|
String |
getMfaConfiguration()
Specifies MFA configuration details.
|
UserPoolPolicyType |
getPolicies()
The policies associated with the new user pool.
|
String |
getPoolName()
A string used to name the user pool.
|
List<SchemaAttributeType> |
getSchema()
An array of schema attributes for the new user pool.
|
String |
getSmsAuthenticationMessage()
A string representing the SMS authentication message.
|
SmsConfigurationType |
getSmsConfiguration()
The SMS configuration.
|
String |
getSmsVerificationMessage()
A string representing the SMS verification message.
|
List<String> |
getUsernameAttributes()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
Map<String,String> |
getUserPoolTags()
The cost allocation tags for the user pool.
|
VerificationMessageTemplateType |
getVerificationMessageTemplate()
The template for the verification message that the user sees when the app requests permission to access the
user's information.
|
int |
hashCode() |
void |
setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
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 |
setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
|
void |
setEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
|
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(String mfaConfiguration)
Specifies MFA configuration details.
|
void |
setMfaConfiguration(UserPoolMfaType 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 |
setSchema(Collection<SchemaAttributeType> schema)
An array of schema attributes for the new user pool.
|
void |
setSmsAuthenticationMessage(String smsAuthenticationMessage)
A string representing the SMS authentication message.
|
void |
setSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
|
void |
setSmsVerificationMessage(String smsVerificationMessage)
A string representing the SMS verification message.
|
void |
setUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
void |
setUserPoolTags(Map<String,String> userPoolTags)
The cost allocation tags for the user pool.
|
void |
setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for the verification message that the user sees when the app requests permission to access the
user's information.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
CreateUserPoolRequest |
withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for
AdminCreateUser requests. |
CreateUserPoolRequest |
withAliasAttributes(AliasAttributeType... aliasAttributes)
Attributes supported as an alias for this user pool.
|
CreateUserPoolRequest |
withAliasAttributes(Collection<String> aliasAttributes)
Attributes supported as an alias for this user pool.
|
CreateUserPoolRequest |
withAliasAttributes(String... aliasAttributes)
Attributes supported as an alias for this user pool.
|
CreateUserPoolRequest |
withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes to be auto-verified.
|
CreateUserPoolRequest |
withAutoVerifiedAttributes(String... autoVerifiedAttributes)
The attributes to be auto-verified.
|
CreateUserPoolRequest |
withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes to be auto-verified.
|
CreateUserPoolRequest |
withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
|
CreateUserPoolRequest |
withEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
|
CreateUserPoolRequest |
withEmailVerificationMessage(String emailVerificationMessage)
A string representing the email verification message.
|
CreateUserPoolRequest |
withEmailVerificationSubject(String emailVerificationSubject)
A string representing the email verification subject.
|
CreateUserPoolRequest |
withLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda trigger configuration information for the new user pool.
|
CreateUserPoolRequest |
withMfaConfiguration(String mfaConfiguration)
Specifies MFA configuration details.
|
CreateUserPoolRequest |
withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
|
CreateUserPoolRequest |
withPolicies(UserPoolPolicyType policies)
The policies associated with the new user pool.
|
CreateUserPoolRequest |
withPoolName(String poolName)
A string used to name the user pool.
|
CreateUserPoolRequest |
withSchema(Collection<SchemaAttributeType> schema)
An array of schema attributes for the new user pool.
|
CreateUserPoolRequest |
withSchema(SchemaAttributeType... schema)
An array of schema attributes for the new user pool.
|
CreateUserPoolRequest |
withSmsAuthenticationMessage(String smsAuthenticationMessage)
A string representing the SMS authentication message.
|
CreateUserPoolRequest |
withSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
|
CreateUserPoolRequest |
withSmsVerificationMessage(String smsVerificationMessage)
A string representing the SMS verification message.
|
CreateUserPoolRequest |
withUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
CreateUserPoolRequest |
withUsernameAttributes(String... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
CreateUserPoolRequest |
withUsernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
CreateUserPoolRequest |
withUserPoolTags(Map<String,String> userPoolTags)
The cost allocation tags for the user pool.
|
CreateUserPoolRequest |
withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for the verification message that the user sees when the app requests permission to access the
user's information.
|
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 setPoolName(String poolName)
A string used to name the user pool.
poolName
- A string used to name the user pool.public String getPoolName()
A string used to name the user pool.
public CreateUserPoolRequest withPoolName(String poolName)
A string used to name the user pool.
poolName
- A string used to name the user pool.public void setPolicies(UserPoolPolicyType policies)
The policies associated with the new user pool.
policies
- The policies associated with the new user pool.public UserPoolPolicyType getPolicies()
The policies associated with the new user pool.
public CreateUserPoolRequest withPolicies(UserPoolPolicyType policies)
The policies associated with the new user pool.
policies
- The policies associated with the new user pool.public void setLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda trigger configuration information for the new user pool.
lambdaConfig
- The Lambda trigger configuration information for the new user pool.public LambdaConfigType getLambdaConfig()
The Lambda trigger configuration information for the new user pool.
public CreateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)
The Lambda trigger configuration information for the new user pool.
lambdaConfig
- The Lambda trigger configuration information for the new user pool.public List<String> getAutoVerifiedAttributes()
The attributes to be auto-verified. Possible values: email, phone_number.
VerifiedAttributeType
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes to be auto-verified. Possible values: email, phone_number.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.VerifiedAttributeType
public CreateUserPoolRequest withAutoVerifiedAttributes(String... autoVerifiedAttributes)
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)
or
withAutoVerifiedAttributes(java.util.Collection)
if you want to override the existing values.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.VerifiedAttributeType
public CreateUserPoolRequest withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
The attributes to be auto-verified. Possible values: email, phone_number.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.VerifiedAttributeType
public CreateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
The attributes to be auto-verified. Possible values: email, phone_number.
autoVerifiedAttributes
- The attributes to be auto-verified. Possible values: email, phone_number.VerifiedAttributeType
public List<String> getAliasAttributes()
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
AliasAttributeType
public void setAliasAttributes(Collection<String> aliasAttributes)
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number, email,
or preferred_username.AliasAttributeType
public CreateUserPoolRequest withAliasAttributes(String... aliasAttributes)
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)
or withAliasAttributes(java.util.Collection)
if you
want to override the existing values.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number, email,
or preferred_username.AliasAttributeType
public CreateUserPoolRequest withAliasAttributes(Collection<String> aliasAttributes)
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number, email,
or preferred_username.AliasAttributeType
public CreateUserPoolRequest withAliasAttributes(AliasAttributeType... aliasAttributes)
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
aliasAttributes
- Attributes supported as an alias for this user pool. Possible values: phone_number, email,
or preferred_username.AliasAttributeType
public List<String> getUsernameAttributes()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
UsernameAttributeType
public void setUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes
- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UsernameAttributeType
public CreateUserPoolRequest withUsernameAttributes(String... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
NOTE: This method appends the values to the existing list (if any). Use
setUsernameAttributes(java.util.Collection)
or withUsernameAttributes(java.util.Collection)
if
you want to override the existing values.
usernameAttributes
- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UsernameAttributeType
public CreateUserPoolRequest withUsernameAttributes(Collection<String> usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes
- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UsernameAttributeType
public CreateUserPoolRequest withUsernameAttributes(UsernameAttributeType... usernameAttributes)
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
usernameAttributes
- Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.UsernameAttributeType
public void setSmsVerificationMessage(String smsVerificationMessage)
A string representing the SMS verification message.
smsVerificationMessage
- A string representing the SMS verification message.public String getSmsVerificationMessage()
A string representing the SMS verification message.
public CreateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)
A string representing the SMS verification message.
smsVerificationMessage
- A string representing the SMS verification message.public void setEmailVerificationMessage(String emailVerificationMessage)
A string representing the email verification message.
emailVerificationMessage
- A string representing the email verification message.public String getEmailVerificationMessage()
A string representing the email verification message.
public CreateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)
A string representing the email verification message.
emailVerificationMessage
- A string representing the email verification message.public void setEmailVerificationSubject(String emailVerificationSubject)
A string representing the email verification subject.
emailVerificationSubject
- A string representing the email verification subject.public String getEmailVerificationSubject()
A string representing the email verification subject.
public CreateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)
A string representing the email verification subject.
emailVerificationSubject
- A string representing the email verification subject.public void setVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for the verification message that the user sees when the app requests permission to access the user's information.
verificationMessageTemplate
- The template for the verification message that the user sees when the app requests permission to access
the user's information.public VerificationMessageTemplateType getVerificationMessageTemplate()
The template for the verification message that the user sees when the app requests permission to access the user's information.
public CreateUserPoolRequest withVerificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)
The template for the verification message that the user sees when the app requests permission to access the user's information.
verificationMessageTemplate
- The template for the verification message that the user sees when the app requests permission to access
the user's information.public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
A string representing the SMS authentication message.
smsAuthenticationMessage
- A string representing the SMS authentication message.public String getSmsAuthenticationMessage()
A string representing the SMS authentication message.
public CreateUserPoolRequest withSmsAuthenticationMessage(String smsAuthenticationMessage)
A string representing the SMS authentication message.
smsAuthenticationMessage
- A string representing the SMS authentication message.public void setMfaConfiguration(String mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
public String getMfaConfiguration()
Specifies MFA configuration details.
UserPoolMfaType
public CreateUserPoolRequest withMfaConfiguration(String mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
public CreateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
Specifies MFA configuration details.
mfaConfiguration
- Specifies MFA configuration details.UserPoolMfaType
public void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
deviceConfiguration
- The device configuration.public DeviceConfigurationType getDeviceConfiguration()
The device configuration.
public CreateUserPoolRequest withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
The device configuration.
deviceConfiguration
- The device configuration.public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
emailConfiguration
- The email configuration.public EmailConfigurationType getEmailConfiguration()
The email configuration.
public CreateUserPoolRequest withEmailConfiguration(EmailConfigurationType emailConfiguration)
The email configuration.
emailConfiguration
- The email configuration.public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
smsConfiguration
- The SMS configuration.public SmsConfigurationType getSmsConfiguration()
The SMS configuration.
public CreateUserPoolRequest withSmsConfiguration(SmsConfigurationType smsConfiguration)
The SMS configuration.
smsConfiguration
- The SMS configuration.public Map<String,String> getUserPoolTags()
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
public void setUserPoolTags(Map<String,String> userPoolTags)
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
userPoolTags
- The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Poolpublic CreateUserPoolRequest withUserPoolTags(Map<String,String> userPoolTags)
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
userPoolTags
- The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Poolpublic CreateUserPoolRequest addUserPoolTagsEntry(String key, String value)
public CreateUserPoolRequest clearUserPoolTagsEntries()
public void setAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser
requests.
adminCreateUserConfig
- The configuration for AdminCreateUser
requests.public AdminCreateUserConfigType getAdminCreateUserConfig()
The configuration for AdminCreateUser
requests.
AdminCreateUser
requests.public CreateUserPoolRequest withAdminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)
The configuration for AdminCreateUser
requests.
adminCreateUserConfig
- The configuration for AdminCreateUser
requests.public List<SchemaAttributeType> getSchema()
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
public void setSchema(Collection<SchemaAttributeType> schema)
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
schema
- An array of schema attributes for the new user pool. These attributes can be standard or custom
attributes.public CreateUserPoolRequest withSchema(SchemaAttributeType... schema)
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
NOTE: This method appends the values to the existing list (if any). Use
setSchema(java.util.Collection)
or withSchema(java.util.Collection)
if you want to override the
existing values.
schema
- An array of schema attributes for the new user pool. These attributes can be standard or custom
attributes.public CreateUserPoolRequest withSchema(Collection<SchemaAttributeType> schema)
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
schema
- An array of schema attributes for the new user pool. These attributes can be standard or custom
attributes.public String toString()
toString
in class Object
Object.toString()
public CreateUserPoolRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.