CreateUserPoolRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.AmazonWebServiceRequest
- - software.amazon.awssdk.services.cognitoidentityprovider.model.CreateUserPoolRequest

All Implemented Interfaces:: Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>

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

Represents the request to create a user pool.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateUserPoolRequest.Builder

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

Field Summary
- Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest
  NOOP

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AdminCreateUserConfigType`	`adminCreateUserConfig()`	The configuration for `AdminCreateUser` requests.
`List<String>`	`aliasAttributes()`	Attributes supported as an alias for this user pool.
`List<String>`	`autoVerifiedAttributes()`	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)`
`int`	`hashCode()`
`LambdaConfigType`	`lambdaConfig()`	The Lambda trigger configuration information for the new user pool.
`String`	`mfaConfiguration()`	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()`
`Map<String,String>`	`userPoolTags()`	The cost allocation tags for the user pool.

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

- 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.
    
    Returns:
    
    The Lambda trigger configuration information for the new user pool.
  - autoVerifiedAttributes
```
public List<String> autoVerifiedAttributes()
```
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    Returns:
    
    The attributes to be auto-verified. Possible values: email, phone_number.
    
    See Also:
    
    VerifiedAttributeType
  - aliasAttributes
```
public List<String> aliasAttributes()
```
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    Returns:
    
    Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    
    See Also:
    
    AliasAttributeType
  - 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.
  - smsAuthenticationMessage
```
public String smsAuthenticationMessage()
```
    A string representing the SMS authentication message.
    
    Returns:
    
    A string representing the SMS authentication message.
  - mfaConfiguration
```
public String mfaConfiguration()
```
    Specifies MFA configuration details.
    
    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.
  - userPoolTags
```
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
    
    Returns:
    
    The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool
  - adminCreateUserConfig
```
public AdminCreateUserConfigType adminCreateUserConfig()
```
    The configuration for AdminCreateUser requests.
    
    Returns:
    
    The configuration for AdminCreateUser requests.
  - schema
```
public List<SchemaAttributeType> schema()
```
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
    
    Returns:
    
    An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
  - toBuilder
```
public CreateUserPoolRequest.Builder 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 interface ToCopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateUserPoolRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateUserPoolRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CreateUserPoolRequest

Nested Class Summary

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

Method Summary

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Method Detail

poolName

policies

lambdaConfig

autoVerifiedAttributes

aliasAttributes

smsVerificationMessage

emailVerificationMessage

emailVerificationSubject

smsAuthenticationMessage

mfaConfiguration

deviceConfiguration

emailConfiguration

smsConfiguration

userPoolTags

adminCreateUserConfig

schema

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString