@Generated(value="software.amazon.awssdk:codegen") public class CreateUserPoolRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>
Represents the request to create a user pool.
Modifier and Type | Class and Description |
---|---|
static interface |
CreateUserPoolRequest.Builder |
Modifier and Type | Method and Description |
---|---|
AdminCreateUserConfigType |
adminCreateUserConfig()
The configuration for
AdminCreateUser requests. |
List<AliasAttributeType> |
aliasAttributes()
Attributes supported as an alias for this user pool.
|
List<String> |
aliasAttributesStrings()
Attributes supported as an alias for this user pool.
|
List<VerifiedAttributeType> |
autoVerifiedAttributes()
The attributes to be auto-verified.
|
List<String> |
autoVerifiedAttributesStrings()
The attributes to be auto-verified.
|
static CreateUserPoolRequest.Builder |
builder() |
DeviceConfigurationType |
deviceConfiguration()
The device configuration.
|
EmailConfigurationType |
emailConfiguration()
The email configuration.
|
String |
emailVerificationMessage()
A string representing the email verification message.
|
String |
emailVerificationSubject()
A string representing the email verification subject.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
LambdaConfigType |
lambdaConfig()
The Lambda trigger configuration information for the new user pool.
|
UserPoolMfaType |
mfaConfiguration()
Specifies MFA configuration details.
|
String |
mfaConfigurationString()
Specifies MFA configuration details.
|
UserPoolPolicyType |
policies()
The policies associated with the new user pool.
|
String |
poolName()
A string used to name the user pool.
|
List<SchemaAttributeType> |
schema()
An array of schema attributes for the new user pool.
|
static Class<? extends CreateUserPoolRequest.Builder> |
serializableBuilderClass() |
String |
smsAuthenticationMessage()
A string representing the SMS authentication message.
|
SmsConfigurationType |
smsConfiguration()
The SMS configuration.
|
String |
smsVerificationMessage()
A string representing the SMS verification message.
|
CreateUserPoolRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
List<UsernameAttributeType> |
usernameAttributes()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
List<String> |
usernameAttributesStrings()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
|
Map<String,String> |
userPoolTags()
The cost allocation tags for the user pool.
|
VerificationMessageTemplateType |
verificationMessageTemplate()
The template for the verification message that the user sees when the app requests permission to access the
user's information.
|
requestOverrideConfig
copy
public String poolName()
A string used to name the user pool.
public UserPoolPolicyType policies()
The policies associated with the new user pool.
public LambdaConfigType lambdaConfig()
The Lambda trigger configuration information for the new user pool.
public List<VerifiedAttributeType> autoVerifiedAttributes()
The attributes to be auto-verified. Possible values: email, phone_number.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> autoVerifiedAttributesStrings()
The attributes to be auto-verified. Possible values: email, phone_number.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<AliasAttributeType> aliasAttributes()
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> aliasAttributesStrings()
Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<UsernameAttributeType> usernameAttributes()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> usernameAttributesStrings()
Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String smsVerificationMessage()
A string representing the SMS verification message.
public String emailVerificationMessage()
A string representing the email verification message.
public String emailVerificationSubject()
A string representing the email verification subject.
public VerificationMessageTemplateType verificationMessageTemplate()
The template for the verification message that the user sees when the app requests permission to access the user's information.
public String smsAuthenticationMessage()
A string representing the SMS authentication message.
public UserPoolMfaType mfaConfiguration()
Specifies MFA configuration details.
If the service returns an enum value that is not available in the current SDK version, mfaConfiguration
will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from mfaConfigurationString()
.
UserPoolMfaType
public String mfaConfigurationString()
Specifies MFA configuration details.
If the service returns an enum value that is not available in the current SDK version, mfaConfiguration
will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from mfaConfigurationString()
.
UserPoolMfaType
public DeviceConfigurationType deviceConfiguration()
The device configuration.
public EmailConfigurationType emailConfiguration()
The email configuration.
public SmsConfigurationType smsConfiguration()
The SMS configuration.
public Map<String,String> userPoolTags()
The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public AdminCreateUserConfigType adminCreateUserConfig()
The configuration for AdminCreateUser
requests.
AdminCreateUser
requests.public List<SchemaAttributeType> schema()
An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public CreateUserPoolRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>
toBuilder
in class CognitoIdentityProviderRequest
public static CreateUserPoolRequest.Builder builder()
public static Class<? extends CreateUserPoolRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.