CreateUserPoolRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.14.0 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.CreateUserPoolRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateUserPoolRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>

Represents the request to create a user pool.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateUserPoolRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateUserPoolRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccountRecoverySettingType`	`accountRecoverySetting()` Use this setting to define which verified available method a user can use to recover their password when they call `ForgotPassword`.
`AdminCreateUserConfigType`	`adminCreateUserConfig()` The configuration for `AdminCreateUser` requests.
`List<AliasAttributeType>`	`aliasAttributes()` Attributes supported as an alias for this user pool.
`List<String>`	`aliasAttributesAsStrings()` Attributes supported as an alias for this user pool.
`List<VerifiedAttributeType>`	`autoVerifiedAttributes()` The attributes to be auto-verified.
`List<String>`	`autoVerifiedAttributesAsStrings()` 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAliasAttributes()` Returns true if the AliasAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasAutoVerifiedAttributes()` Returns true if the AutoVerifiedAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasSchema()` Returns true if the Schema property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUsernameAttributes()` Returns true if the UsernameAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserPoolTags()` Returns true if the UserPoolTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`LambdaConfigType`	`lambdaConfig()` The Lambda trigger configuration information for the new user pool.
`UserPoolMfaType`	`mfaConfiguration()` Specifies MFA configuration details.
`String`	`mfaConfigurationAsString()` 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.
`List<SdkField<?>>`	`sdkFields()`
`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()`
`String`	`toString()` Returns a string representation of this object.
`List<UsernameAttributeType>`	`usernameAttributes()` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`List<String>`	`usernameAttributesAsStrings()` Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
`UsernameConfigurationType`	`usernameConfiguration()` You can choose to set case sensitivity on the username input for the selected sign-in option.
`UserPoolAddOnsType`	`userPoolAddOns()` Used to enable advanced security risk detection.
`Map<String,String>`	`userPoolTags()` The tag keys and values to assign to 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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - poolName
```
public String poolName()
```
    A string used to name the user pool.
    
    Returns:
    
    A string used to name the user pool.
  - policies
```
public UserPoolPolicyType policies()
```
    The policies associated with the new user pool.
    
    Returns:
    
    The policies associated with the new user pool.
  - lambdaConfig
```
public LambdaConfigType 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 will need to 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 AWS 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 will need to 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 AWS CLI, see add-permission .
  - autoVerifiedAttributes
```
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.
    
    You can use hasAutoVerifiedAttributes() to see if a value was sent in this field.
    
    Returns:
    
    The attributes to be auto-verified. Possible values: email, phone_number.
  - hasAutoVerifiedAttributes
```
public boolean hasAutoVerifiedAttributes()
```
    Returns true if the AutoVerifiedAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - autoVerifiedAttributesAsStrings
```
public List<String> 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.
    
    You can use hasAutoVerifiedAttributes() to see if a value was sent in this field.
    
    Returns:
    
    The attributes to be auto-verified. Possible values: email, phone_number.
  - aliasAttributes
```
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.
    
    You can use hasAliasAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
  - hasAliasAttributes
```
public boolean hasAliasAttributes()
```
    Returns true if the AliasAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - aliasAttributesAsStrings
```
public List<String> 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.
    
    You can use hasAliasAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
  - usernameAttributes
```
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.
    
    You can use hasUsernameAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - hasUsernameAttributes
```
public boolean hasUsernameAttributes()
```
    Returns true if the UsernameAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - usernameAttributesAsStrings
```
public List<String> usernameAttributesAsStrings()
```
    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.
    
    You can use hasUsernameAttributes() to see if a value was sent in this field.
    
    Returns:
    
    Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
  - smsVerificationMessage
```
public String smsVerificationMessage()
```
    A string representing the SMS verification message.
    
    Returns:
    
    A string representing the SMS verification message.
  - emailVerificationMessage
```
public String emailVerificationMessage()
```
    A string representing the email verification message.
    
    Returns:
    
    A string representing the email verification message.
  - emailVerificationSubject
```
public String emailVerificationSubject()
```
    A string representing the email verification subject.
    
    Returns:
    
    A string representing the email verification subject.
  - verificationMessageTemplate
```
public 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
```
public String smsAuthenticationMessage()
```
    A string representing the SMS authentication message.
    
    Returns:
    
    A string representing the SMS authentication message.
  - mfaConfiguration
```
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 mfaConfigurationAsString().
    
    Returns:
    
    Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - mfaConfigurationAsString
```
public String mfaConfigurationAsString()
```
    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 mfaConfigurationAsString().
    
    Returns:
    
    Specifies MFA configuration details.
    
    See Also:
    
    UserPoolMfaType
  - deviceConfiguration
```
public DeviceConfigurationType deviceConfiguration()
```
    The device configuration.
    
    Returns:
    
    The device configuration.
  - emailConfiguration
```
public EmailConfigurationType emailConfiguration()
```
    The email configuration.
    
    Returns:
    
    The email configuration.
  - smsConfiguration
```
public SmsConfigurationType smsConfiguration()
```
    The SMS configuration.
    
    Returns:
    
    The SMS configuration.
  - hasUserPoolTags
```
public boolean hasUserPoolTags()
```
    Returns true if the UserPoolTags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userPoolTags
```
public Map<String,String> 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.
    
    You can use hasUserPoolTags() to see if a value was sent in this field.
    
    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
```
public AdminCreateUserConfigType adminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - hasSchema
```
public boolean hasSchema()
```
    Returns true if the Schema property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - schema
```
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.
    
    You can use hasSchema() to see if a value was sent in this field.
    
    Returns:
    
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
  - userPoolAddOns
```
public UserPoolAddOnsType userPoolAddOns()
```
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Returns:
    
    Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
  - usernameConfiguration
```
public UsernameConfigurationType usernameConfiguration()
```
    You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
    
    Returns:
    
    You can choose to set case sensitivity on the username input for the selected sign-in option. For example, when this is set to False, users will be able to sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
  - accountRecoverySetting
```
public AccountRecoverySettingType accountRecoverySetting()
```
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
    
    Returns:
    
    Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.
  - toBuilder
```
public CreateUserPoolRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>
    
    Specified by:
    
    toBuilder in class CognitoIdentityProviderRequest
  - builder
```
public static CreateUserPoolRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateUserPoolRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateUserPoolRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

poolName

policies

lambdaConfig

autoVerifiedAttributes

hasAutoVerifiedAttributes

autoVerifiedAttributesAsStrings

aliasAttributes

hasAliasAttributes

aliasAttributesAsStrings

usernameAttributes

hasUsernameAttributes

usernameAttributesAsStrings

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

verificationMessageTemplate

smsAuthenticationMessage

mfaConfiguration

mfaConfigurationAsString

deviceConfiguration

emailConfiguration

smsConfiguration

hasUserPoolTags

userPoolTags

adminCreateUserConfig

hasSchema

schema

userPoolAddOns

usernameConfiguration

accountRecoverySetting

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields