Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface CreateUserPoolRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>, SdkBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>

Enclosing class:

CreateUserPoolRequest

public static interface CreateUserPoolRequest.Builder
extends CopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>

Method Summary

Modifier and Type	Method	Description
CreateUserPoolRequest.Builder	adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)	The configuration for AdminCreateUser requests.
CreateUserPoolRequest.Builder	aliasAttributes(String... aliasAttributes)	Attributes supported as an alias for this user pool.
CreateUserPoolRequest.Builder	aliasAttributes(Collection<String> aliasAttributes)	Attributes supported as an alias for this user pool.
CreateUserPoolRequest.Builder	aliasAttributes(AliasAttributeType... aliasAttributes)	Attributes supported as an alias for this user pool.
CreateUserPoolRequest.Builder	autoVerifiedAttributes(String... autoVerifiedAttributes)	The attributes to be auto-verified.
CreateUserPoolRequest.Builder	autoVerifiedAttributes(Collection<String> autoVerifiedAttributes)	The attributes to be auto-verified.
CreateUserPoolRequest.Builder	autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)	The attributes to be auto-verified.
CreateUserPoolRequest.Builder	deviceConfiguration(DeviceConfigurationType deviceConfiguration)	The device configuration.
CreateUserPoolRequest.Builder	emailConfiguration(EmailConfigurationType emailConfiguration)	The email configuration.
CreateUserPoolRequest.Builder	emailVerificationMessage(String emailVerificationMessage)	A string representing the email verification message.
CreateUserPoolRequest.Builder	emailVerificationSubject(String emailVerificationSubject)	A string representing the email verification subject.
CreateUserPoolRequest.Builder	lambdaConfig(LambdaConfigType lambdaConfig)	The Lambda trigger configuration information for the new user pool.
CreateUserPoolRequest.Builder	mfaConfiguration(String mfaConfiguration)	Specifies MFA configuration details.
CreateUserPoolRequest.Builder	mfaConfiguration(UserPoolMfaType mfaConfiguration)	Specifies MFA configuration details.
CreateUserPoolRequest.Builder	policies(UserPoolPolicyType policies)	The policies associated with the new user pool.
CreateUserPoolRequest.Builder	poolName(String poolName)	A string used to name the user pool.
CreateUserPoolRequest.Builder	schema(Collection<SchemaAttributeType> schema)	An array of schema attributes for the new user pool.
CreateUserPoolRequest.Builder	schema(SchemaAttributeType... schema)	An array of schema attributes for the new user pool.
CreateUserPoolRequest.Builder	smsAuthenticationMessage(String smsAuthenticationMessage)	A string representing the SMS authentication message.
CreateUserPoolRequest.Builder	smsConfiguration(SmsConfigurationType smsConfiguration)	The SMS configuration.
CreateUserPoolRequest.Builder	smsVerificationMessage(String smsVerificationMessage)	A string representing the SMS verification message.
CreateUserPoolRequest.Builder	userPoolTags(Map<String,String> userPoolTags)	The cost allocation tags for the user pool.

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

copy

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

apply, build

Method Detail

poolName

CreateUserPoolRequest.Builder poolName(String poolName)

A string used to name the user pool.

Parameters:

poolName - A string used to name the user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

policies

CreateUserPoolRequest.Builder policies(UserPoolPolicyType policies)

The policies associated with the new user pool.

Parameters:

policies - The policies associated with the new user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

lambdaConfig

CreateUserPoolRequest.Builder lambdaConfig(LambdaConfigType lambdaConfig)

The Lambda trigger configuration information for the new user pool.

Parameters:

lambdaConfig - The Lambda trigger configuration information for the new user pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

autoVerifiedAttributes

CreateUserPoolRequest.Builder autoVerifiedAttributes(Collection<String> autoVerifiedAttributes)

The attributes to be auto-verified. Possible values: email, phone_number.

Parameters:

autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VerifiedAttributeType

autoVerifiedAttributes

CreateUserPoolRequest.Builder autoVerifiedAttributes(String... autoVerifiedAttributes)

The attributes to be auto-verified. Possible values: email, phone_number.

NOTE: This method appends the values to the existing list (if any). Use #setAutoVerifiedAttributes(java.util.Collection) or #withAutoVerifiedAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VerifiedAttributeType

autoVerifiedAttributes

CreateUserPoolRequest.Builder autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)

The attributes to be auto-verified. Possible values: email, phone_number.

NOTE: This method appends the values to the existing list (if any). Use #setAutoVerifiedAttributes(java.util.Collection) or #withAutoVerifiedAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

autoVerifiedAttributes - The attributes to be auto-verified. Possible values: email, phone_number.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

VerifiedAttributeType

aliasAttributes

CreateUserPoolRequest.Builder aliasAttributes(Collection<String> aliasAttributes)

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Parameters:

aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AliasAttributeType

aliasAttributes

CreateUserPoolRequest.Builder aliasAttributes(String... aliasAttributes)

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

NOTE: This method appends the values to the existing list (if any). Use #setAliasAttributes(java.util.Collection) or #withAliasAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AliasAttributeType

aliasAttributes

CreateUserPoolRequest.Builder aliasAttributes(AliasAttributeType... aliasAttributes)

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

NOTE: This method appends the values to the existing list (if any). Use #setAliasAttributes(java.util.Collection) or #withAliasAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

aliasAttributes - Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AliasAttributeType

smsVerificationMessage

CreateUserPoolRequest.Builder smsVerificationMessage(String smsVerificationMessage)

A string representing the SMS verification message.

Parameters:

smsVerificationMessage - A string representing the SMS verification message.

Returns:

Returns a reference to this object so that method calls can be chained together.

emailVerificationMessage

CreateUserPoolRequest.Builder emailVerificationMessage(String emailVerificationMessage)

A string representing the email verification message.

Parameters:

emailVerificationMessage - A string representing the email verification message.

Returns:

Returns a reference to this object so that method calls can be chained together.

emailVerificationSubject

CreateUserPoolRequest.Builder emailVerificationSubject(String emailVerificationSubject)

A string representing the email verification subject.

Parameters:

emailVerificationSubject - A string representing the email verification subject.

Returns:

Returns a reference to this object so that method calls can be chained together.

smsAuthenticationMessage

CreateUserPoolRequest.Builder smsAuthenticationMessage(String smsAuthenticationMessage)

A string representing the SMS authentication message.

Parameters:

smsAuthenticationMessage - A string representing the SMS authentication message.

Returns:

Returns a reference to this object so that method calls can be chained together.

mfaConfiguration

CreateUserPoolRequest.Builder mfaConfiguration(String mfaConfiguration)

Specifies MFA configuration details.

Parameters:

mfaConfiguration - Specifies MFA configuration details.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserPoolMfaType

mfaConfiguration

CreateUserPoolRequest.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)

Specifies MFA configuration details.

Parameters:

mfaConfiguration - Specifies MFA configuration details.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserPoolMfaType

deviceConfiguration

CreateUserPoolRequest.Builder deviceConfiguration(DeviceConfigurationType deviceConfiguration)

The device configuration.

Parameters:

deviceConfiguration - The device configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

emailConfiguration

CreateUserPoolRequest.Builder emailConfiguration(EmailConfigurationType emailConfiguration)

The email configuration.

Parameters:

emailConfiguration - The email configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

smsConfiguration

CreateUserPoolRequest.Builder smsConfiguration(SmsConfigurationType smsConfiguration)

The SMS configuration.

Parameters:

smsConfiguration - The SMS configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

userPoolTags

CreateUserPoolRequest.Builder userPoolTags(Map<String,String> userPoolTags)

The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

Parameters:

userPoolTags - The cost allocation tags for the user pool. For more information, see Adding Cost Allocation Tags to Your User Pool

Returns:

Returns a reference to this object so that method calls can be chained together.

adminCreateUserConfig

CreateUserPoolRequest.Builder adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig)

The configuration for AdminCreateUser requests.

Parameters:

adminCreateUserConfig - The configuration for AdminCreateUser requests.

Returns:

Returns a reference to this object so that method calls can be chained together.

schema

CreateUserPoolRequest.Builder schema(Collection<SchemaAttributeType> schema)

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Parameters:

schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

schema

CreateUserPoolRequest.Builder schema(SchemaAttributeType... schema)

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

NOTE: This method appends the values to the existing list (if any). Use #setSchema(java.util.Collection) or #withSchema(java.util.Collection) if you want to override the existing values.

Parameters:

schema - An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.