Class CreateUserPoolRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateUserPoolRequest.Builder,
CreateUserPoolRequest>
Represents the request to create a user pool.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe available verified method a user can use to recover their password when they callForgotPassword
.The configuration forAdminCreateUser
requests.final List
<AliasAttributeType> Attributes supported as an alias for this user pool.Attributes supported as an alias for this user pool.final List
<VerifiedAttributeType> The attributes to be auto-verified.The attributes to be auto-verified.builder()
final DeletionProtectionType
When active,DeletionProtection
prevents accidental deletion of your user pool.final String
When active,DeletionProtection
prevents accidental deletion of your user pool.final DeviceConfigurationType
The device-remembering configuration for a user pool.final EmailConfigurationType
The email configuration of your user pool.final String
This parameter is no longer used.final String
This parameter is no longer used.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AliasAttributes property.final boolean
For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Schema property.final boolean
For responses, this returns true if the service returned a value for the UsernameAttributes property.final boolean
For responses, this returns true if the service returned a value for the UserPoolTags property.final LambdaConfigType
The Lambda trigger configuration information for the new user pool.final UserPoolMfaType
Specifies MFA configuration details.final String
Specifies MFA configuration details.final UserPoolPolicyType
policies()
The policies associated with the new user pool.final String
poolName()
A string used to name the user pool.final List
<SchemaAttributeType> schema()
An array of schema attributes for the new user pool.static Class
<? extends CreateUserPoolRequest.Builder> final String
A string representing the SMS authentication message.final SmsConfigurationType
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.final String
This parameter is no longer used.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.The settings for updates to user attributes.final List
<UsernameAttributeType> Specifies whether a user can use an email address or phone number as a username when they sign up.Specifies whether a user can use an email address or phone number as a username when they sign up.Case sensitivity on the username input for the selected sign-in option.final UserPoolAddOnsType
User pool add-ons.The tag keys and values to assign to the user pool.The template for the verification message that the user sees when the app requests permission to access the user's information.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
poolName
A string used to name the user pool.
- Returns:
- A string used to name the user pool.
-
policies
The policies associated with the new user pool.
- Returns:
- The policies associated with the new user pool.
-
deletionProtection
When active,
DeletionProtection
prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.When you try to delete a protected user pool in a
DeleteUserPool
API request, Amazon Cognito returns anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request.If the service returns an enum value that is not available in the current SDK version,
deletionProtection
will returnDeletionProtectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeletionProtectionAsString()
.- Returns:
- When active,
DeletionProtection
prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.When you try to delete a protected user pool in a
DeleteUserPool
API request, Amazon Cognito returns anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request. - See Also:
-
deletionProtectionAsString
When active,
DeletionProtection
prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.When you try to delete a protected user pool in a
DeleteUserPool
API request, Amazon Cognito returns anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request.If the service returns an enum value that is not available in the current SDK version,
deletionProtection
will returnDeletionProtectionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeletionProtectionAsString()
.- Returns:
- When active,
DeletionProtection
prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.When you try to delete a protected user pool in a
DeleteUserPool
API request, Amazon Cognito returns anInvalidParameterException
error. To delete a protected user pool, send a newDeleteUserPool
request after you deactivate deletion protection in anUpdateUserPool
API request. - See Also:
-
lambdaConfig
The Lambda trigger configuration information for the new user pool.
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
For more information on using the Lambda API to add permission, see AddPermission .
For adding permission using the CLI, see add-permission .
- Returns:
- The Lambda trigger configuration information for the new user pool.
In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you must make an extra call to add permission for these event sources to invoke your Lambda function.
For more information on using the Lambda API to add permission, see AddPermission .
For adding permission using the CLI, see add-permission .
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAutoVerifiedAttributes()
method.- Returns:
- The attributes to be auto-verified. Possible values: email, phone_number.
-
hasAutoVerifiedAttributes
public final boolean hasAutoVerifiedAttributes()For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
autoVerifiedAttributesAsStrings
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAutoVerifiedAttributes()
method.- Returns:
- The attributes to be auto-verified. Possible values: email, phone_number.
-
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAliasAttributes()
method.- Returns:
- Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
-
hasAliasAttributes
public final boolean hasAliasAttributes()For responses, this returns true if the service returned a value for the AliasAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
aliasAttributesAsStrings
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAliasAttributes()
method.- Returns:
- Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
-
usernameAttributes
Specifies whether a user can use an email address or phone number as a username when they sign up.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUsernameAttributes()
method.- Returns:
- Specifies whether a user can use an email address or phone number as a username when they sign up.
-
hasUsernameAttributes
public final boolean hasUsernameAttributes()For responses, this returns true if the service returned a value for the UsernameAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
usernameAttributesAsStrings
Specifies whether a user can use an email address or phone number as a username when they sign up.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUsernameAttributes()
method.- Returns:
- Specifies whether a user can use an email address or phone number as a username when they sign up.
-
smsVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
- Returns:
- This parameter is no longer used. See VerificationMessageTemplateType.
-
emailVerificationMessage
This parameter is no longer used. See VerificationMessageTemplateType.
- Returns:
- This parameter is no longer used. See VerificationMessageTemplateType.
-
emailVerificationSubject
This parameter is no longer used. See VerificationMessageTemplateType.
- Returns:
- This parameter is no longer used. See VerificationMessageTemplateType.
-
verificationMessageTemplate
The template for the verification message that the user sees when the app requests permission to access the user's information.
- Returns:
- The template for the verification message that the user sees when the app requests permission to access the user's information.
-
smsAuthenticationMessage
A string representing the SMS authentication message.
- Returns:
- A string representing the SMS authentication message.
-
mfaConfiguration
Specifies MFA configuration details.
If the service returns an enum value that is not available in the current SDK version,
mfaConfiguration
will returnUserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommfaConfigurationAsString()
.- Returns:
- Specifies MFA configuration details.
- See Also:
-
mfaConfigurationAsString
Specifies MFA configuration details.
If the service returns an enum value that is not available in the current SDK version,
mfaConfiguration
will returnUserPoolMfaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommfaConfigurationAsString()
.- Returns:
- Specifies MFA configuration details.
- See Also:
-
userAttributeUpdateSettings
The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate
, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.- Returns:
- The settings for updates to user attributes. These settings include the property
AttributesRequireVerificationBeforeUpdate
, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.
-
deviceConfiguration
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
When you provide a value for any
DeviceConfiguration
field, you activate the Amazon Cognito device-remembering feature.- Returns:
- The device-remembering configuration for a user pool. A null value indicates that you have deactivated
device remembering in your user pool.
When you provide a value for any
DeviceConfiguration
field, you activate the Amazon Cognito device-remembering feature.
-
emailConfiguration
The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
- Returns:
- The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for messages from your user pool.
-
smsConfiguration
The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
- Returns:
- The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.
-
hasUserPoolTags
public final boolean hasUserPoolTags()For responses, this returns true if the service returned a value for the UserPoolTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
userPoolTags
The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUserPoolTags()
method.- Returns:
- The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
-
adminCreateUserConfig
The configuration for
AdminCreateUser
requests.- Returns:
- The configuration for
AdminCreateUser
requests.
-
hasSchema
public final boolean hasSchema()For responses, this returns true if the service returned a value for the Schema property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSchema()
method.- Returns:
- An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
-
userPoolAddOns
User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to
AUDIT
. To configure automatic security responses to risky traffic to your user pool, set toENFORCED
.For more information, see Adding advanced security to a user pool.
- Returns:
- User pool add-ons. Contains settings for activation of advanced security features. To log user security
information but take no action, set to
AUDIT
. To configure automatic security responses to risky traffic to your user pool, set toENFORCED
.For more information, see Adding advanced security to a user pool.
-
usernameConfiguration
Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to
False
(case insensitive), users can sign in with any combination of capital and lowercase letters. For example,username
,USERNAME
, orUserName
, or for email,email@example.com
orEMaiL@eXamplE.Com
. For most use cases, set case sensitivity toFalse
(case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
- Returns:
- Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to
False
(case insensitive), users can sign in with any combination of capital and lowercase letters. For example,username
,USERNAME
, orUserName
, or for email,email@example.com
orEMaiL@eXamplE.Com
. For most use cases, set case sensitivity toFalse
(case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.This configuration is immutable after you set it. For more information, see UsernameConfigurationType.
-
accountRecoverySetting
The available verified method a user can use to recover their password when they call
ForgotPassword
. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.- Returns:
- The available verified method a user can use to recover their password when they call
ForgotPassword
. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateUserPoolRequest.Builder,
CreateUserPoolRequest> - Specified by:
toBuilder
in classCognitoIdentityProviderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-