CreateUserPoolRequest (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.17.187 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()` The available verified 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 of your user pool.
`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()` For responses, this returns true if the service returned a value for the AliasAttributes property.
`boolean`	`hasAutoVerifiedAttributes()` For responses, this returns true if the service returned a value for the AutoVerifiedAttributes property.
`int`	`hashCode()`
`boolean`	`hasSchema()` For responses, this returns true if the service returned a value for the Schema property.
`boolean`	`hasUsernameAttributes()` For responses, this returns true if the service returned a value for the UsernameAttributes property.
`boolean`	`hasUserPoolTags()` For responses, this returns true if the service returned a value for the UserPoolTags property.
`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 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.
`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 a user can use an email address or phone number as a username when they sign up.
`List<String>`	`usernameAttributesAsStrings()` Specifies whether a user can use an email address or phone number as a username when they sign up.
`UsernameConfigurationType`	`usernameConfiguration()` Case sensitivity on the username input for the selected sign-in option.
`UserPoolAddOnsType`	`userPoolAddOns()` Enables 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 final String poolName()
```
    A string used to name the user pool.
    
    Returns:
    
    A string used to name the user pool.
  - policies
```
public final UserPoolPolicyType policies()
```
    The policies associated with the new user pool.
    
    Returns:
    
    The policies associated with the new user pool.
  - lambdaConfig
```
public final 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 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
```
public final 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.
    
    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 the isEmpty() 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
```
public final 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.
    
    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
```
public final 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.
    
    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 the isEmpty() 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
```
public final 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.
    
    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
```
public final List<UsernameAttributeType> 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 the isEmpty() 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
```
public final List<String> 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
```
public final String smsVerificationMessage()
```
    A string representing the SMS verification message.
    
    Returns:
    
    A string representing the SMS verification message.
  - emailVerificationMessage
```
public final String emailVerificationMessage()
```
    A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
    
    Returns:
    
    A string representing the email verification message. EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
  - emailVerificationSubject
```
public final String emailVerificationSubject()
```
    A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
    
    Returns:
    
    A string representing the email verification subject. EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
  - verificationMessageTemplate
```
public final 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 final String smsAuthenticationMessage()
```
    A string representing the SMS authentication message.
    
    Returns:
    
    A string representing the SMS authentication message.
  - mfaConfiguration
```
public final 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 final 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 final DeviceConfigurationType deviceConfiguration()
```
    The device configuration.
    
    Returns:
    
    The device configuration.
  - emailConfiguration
```
public final EmailConfigurationType 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
```
public final SmsConfigurationType 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 the isEmpty() 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
```
public final 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.
    
    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
```
public final AdminCreateUserConfigType 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 the isEmpty() 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
```
public final 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.
    
    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
```
public final UserPoolAddOnsType userPoolAddOns()
```
    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
    
    Returns:
    
    Enables advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
  - usernameConfiguration
```
public final UsernameConfigurationType usernameConfiguration()
```
    Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
    
    Returns:
    
    Case sensitivity on the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.
  - accountRecoverySetting
```
public final AccountRecoverySettingType 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
```
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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final 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