software.amazon.awssdk.services.cognitoidentityprovider.model

Interface CreateUserPoolRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>, SdkBuilder<CreateUserPoolRequest.Builder,CreateUserPoolRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateUserPoolRequest

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

Method Summary

Modifier and Type	Method and Description
CreateUserPoolRequest.Builder	accountRecoverySetting(AccountRecoverySettingType accountRecoverySetting) Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword.
default CreateUserPoolRequest.Builder	accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> accountRecoverySetting) Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword.
CreateUserPoolRequest.Builder	adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig) The configuration for AdminCreateUser requests.
default CreateUserPoolRequest.Builder	adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig) The configuration for AdminCreateUser requests.
CreateUserPoolRequest.Builder	aliasAttributes(AliasAttributeType... aliasAttributes) Attributes supported as an alias for this user pool.
CreateUserPoolRequest.Builder	aliasAttributes(Collection<AliasAttributeType> aliasAttributes) Attributes supported as an alias for this user pool.
CreateUserPoolRequest.Builder	aliasAttributesWithStrings(Collection<String> aliasAttributes) Attributes supported as an alias for this user pool.
CreateUserPoolRequest.Builder	aliasAttributesWithStrings(String... aliasAttributes) Attributes supported as an alias for this user pool.
CreateUserPoolRequest.Builder	autoVerifiedAttributes(Collection<VerifiedAttributeType> autoVerifiedAttributes) The attributes to be auto-verified.
CreateUserPoolRequest.Builder	autoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes) The attributes to be auto-verified.
CreateUserPoolRequest.Builder	autoVerifiedAttributesWithStrings(Collection<String> autoVerifiedAttributes) The attributes to be auto-verified.
CreateUserPoolRequest.Builder	autoVerifiedAttributesWithStrings(String... autoVerifiedAttributes) The attributes to be auto-verified.
default CreateUserPoolRequest.Builder	deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration) The device configuration.
CreateUserPoolRequest.Builder	deviceConfiguration(DeviceConfigurationType deviceConfiguration) The device configuration.
default CreateUserPoolRequest.Builder	emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration) The email 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.
default CreateUserPoolRequest.Builder	lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig) The Lambda trigger configuration information for the new user pool.
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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateUserPoolRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
default CreateUserPoolRequest.Builder	policies(Consumer<UserPoolPolicyType.Builder> policies) The policies associated with the new user pool.
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(Consumer<SchemaAttributeType.Builder>... 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.
default CreateUserPoolRequest.Builder	smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration) The SMS configuration.
CreateUserPoolRequest.Builder	smsConfiguration(SmsConfigurationType smsConfiguration) The SMS configuration.
CreateUserPoolRequest.Builder	smsVerificationMessage(String smsVerificationMessage) A string representing the SMS verification message.
CreateUserPoolRequest.Builder	usernameAttributes(Collection<UsernameAttributeType> usernameAttributes) Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
CreateUserPoolRequest.Builder	usernameAttributes(UsernameAttributeType... usernameAttributes) Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
CreateUserPoolRequest.Builder	usernameAttributesWithStrings(Collection<String> usernameAttributes) Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
CreateUserPoolRequest.Builder	usernameAttributesWithStrings(String... usernameAttributes) Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
default CreateUserPoolRequest.Builder	usernameConfiguration(Consumer<UsernameConfigurationType.Builder> usernameConfiguration) You can choose to set case sensitivity on the username input for the selected sign-in option.
CreateUserPoolRequest.Builder	usernameConfiguration(UsernameConfigurationType usernameConfiguration) You can choose to set case sensitivity on the username input for the selected sign-in option.
default CreateUserPoolRequest.Builder	userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns) Used to enable advanced security risk detection.
CreateUserPoolRequest.Builder	userPoolAddOns(UserPoolAddOnsType userPoolAddOns) Used to enable advanced security risk detection.
CreateUserPoolRequest.Builder	userPoolTags(Map<String,String> userPoolTags) The tag keys and values to assign to the user pool.
default CreateUserPoolRequest.Builder	verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate) The template for the verification message that the user sees when the app requests permission to access the user's information.
CreateUserPoolRequest.Builder	verificationMessageTemplate(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 interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, 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.

policies

default CreateUserPoolRequest.Builder policies(Consumer<UserPoolPolicyType.Builder> policies)

The policies associated with the new user pool.

This is a convenience that creates an instance of the UserPoolPolicyType.Builder avoiding the need to create one manually via UserPoolPolicyType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to policies(UserPoolPolicyType).

Parameters:

policies - a consumer that will call methods on UserPoolPolicyType.Builder

Returns:

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

See Also:

policies(UserPoolPolicyType)

lambdaConfig

CreateUserPoolRequest.Builder lambdaConfig(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 .

Parameters:

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:

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

lambdaConfig

default CreateUserPoolRequest.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> 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 .

This is a convenience that creates an instance of the LambdaConfigType.Builder avoiding the need to create one manually via LambdaConfigType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lambdaConfig(LambdaConfigType).

Parameters:

lambdaConfig - a consumer that will call methods on LambdaConfigType.Builder

Returns:

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

See Also:

lambdaConfig(LambdaConfigType)

autoVerifiedAttributesWithStrings

CreateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(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.

autoVerifiedAttributesWithStrings

CreateUserPoolRequest.Builder autoVerifiedAttributesWithStrings(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.

autoVerifiedAttributes

CreateUserPoolRequest.Builder autoVerifiedAttributes(Collection<VerifiedAttributeType> 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.

autoVerifiedAttributes

CreateUserPoolRequest.Builder autoVerifiedAttributes(VerifiedAttributeType... 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.

aliasAttributesWithStrings

CreateUserPoolRequest.Builder aliasAttributesWithStrings(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.

aliasAttributesWithStrings

CreateUserPoolRequest.Builder aliasAttributesWithStrings(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.

aliasAttributes

CreateUserPoolRequest.Builder aliasAttributes(Collection<AliasAttributeType> 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.

aliasAttributes

CreateUserPoolRequest.Builder aliasAttributes(AliasAttributeType... 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.

usernameAttributesWithStrings

CreateUserPoolRequest.Builder usernameAttributesWithStrings(Collection<String> usernameAttributes)

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Parameters:

usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Returns:

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

usernameAttributesWithStrings

CreateUserPoolRequest.Builder usernameAttributesWithStrings(String... usernameAttributes)

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Parameters:

usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Returns:

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

usernameAttributes

CreateUserPoolRequest.Builder usernameAttributes(Collection<UsernameAttributeType> usernameAttributes)

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Parameters:

usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Returns:

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

usernameAttributes

CreateUserPoolRequest.Builder usernameAttributes(UsernameAttributeType... usernameAttributes)

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Parameters:

usernameAttributes - Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

Returns:

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

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.

verificationMessageTemplate

CreateUserPoolRequest.Builder verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)

The template for the verification message that the user sees when the app requests permission to access the user's information.

Parameters:

verificationMessageTemplate - The template for the verification message that the user sees when the app requests permission to access the user's information.

Returns:

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

verificationMessageTemplate

default CreateUserPoolRequest.Builder verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate)

The template for the verification message that the user sees when the app requests permission to access the user's information.

This is a convenience that creates an instance of the VerificationMessageTemplateType.Builder avoiding the need to create one manually via VerificationMessageTemplateType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to verificationMessageTemplate(VerificationMessageTemplateType) .

Parameters:

verificationMessageTemplate - a consumer that will call methods on VerificationMessageTemplateType.Builder

Returns:

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

See Also:

verificationMessageTemplate(VerificationMessageTemplateType)

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, 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, 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.

deviceConfiguration

default CreateUserPoolRequest.Builder deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration)

The device configuration.

This is a convenience that creates an instance of the DeviceConfigurationType.Builder avoiding the need to create one manually via DeviceConfigurationType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceConfiguration(DeviceConfigurationType).

Parameters:

deviceConfiguration - a consumer that will call methods on DeviceConfigurationType.Builder

Returns:

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

See Also:

deviceConfiguration(DeviceConfigurationType)

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.

emailConfiguration

default CreateUserPoolRequest.Builder emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration)

The email configuration.

This is a convenience that creates an instance of the EmailConfigurationType.Builder avoiding the need to create one manually via EmailConfigurationType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to emailConfiguration(EmailConfigurationType).

Parameters:

emailConfiguration - a consumer that will call methods on EmailConfigurationType.Builder

Returns:

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

See Also:

emailConfiguration(EmailConfigurationType)

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.

smsConfiguration

default CreateUserPoolRequest.Builder smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration)

The SMS configuration.

This is a convenience that creates an instance of the SmsConfigurationType.Builder avoiding the need to create one manually via SmsConfigurationType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to smsConfiguration(SmsConfigurationType).

Parameters:

smsConfiguration - a consumer that will call methods on SmsConfigurationType.Builder

Returns:

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

See Also:

smsConfiguration(SmsConfigurationType)

userPoolTags

CreateUserPoolRequest.Builder userPoolTags(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.

Parameters:

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.

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.

adminCreateUserConfig

default CreateUserPoolRequest.Builder adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig)

The configuration for AdminCreateUser requests.

This is a convenience that creates an instance of the AdminCreateUserConfigType.Builder avoiding the need to create one manually via AdminCreateUserConfigType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to adminCreateUserConfig(AdminCreateUserConfigType).

Parameters:

adminCreateUserConfig - a consumer that will call methods on AdminCreateUserConfigType.Builder

Returns:

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

See Also:

adminCreateUserConfig(AdminCreateUserConfigType)

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.

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(Consumer<SchemaAttributeType.Builder>... schema)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #schema(List).

Parameters:

schema - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#schema(List)

userPoolAddOns

CreateUserPoolRequest.Builder userPoolAddOns(UserPoolAddOnsType userPoolAddOns)

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Parameters:

userPoolAddOns - Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

Returns:

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

userPoolAddOns

default CreateUserPoolRequest.Builder userPoolAddOns(Consumer<UserPoolAddOnsType.Builder> userPoolAddOns)

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".

This is a convenience that creates an instance of the UserPoolAddOnsType.Builder avoiding the need to create one manually via UserPoolAddOnsType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userPoolAddOns(UserPoolAddOnsType).

Parameters:

userPoolAddOns - a consumer that will call methods on UserPoolAddOnsType.Builder

Returns:

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

See Also:

userPoolAddOns(UserPoolAddOnsType)

usernameConfiguration

CreateUserPoolRequest.Builder usernameConfiguration(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.

Parameters:

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:

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

usernameConfiguration

default CreateUserPoolRequest.Builder usernameConfiguration(Consumer<UsernameConfigurationType.Builder> 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.

This is a convenience that creates an instance of the UsernameConfigurationType.Builder avoiding the need to create one manually via UsernameConfigurationType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to usernameConfiguration(UsernameConfigurationType).

Parameters:

usernameConfiguration - a consumer that will call methods on UsernameConfigurationType.Builder

Returns:

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

See Also:

usernameConfiguration(UsernameConfigurationType)

accountRecoverySetting

CreateUserPoolRequest.Builder accountRecoverySetting(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.

Parameters:

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:

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

accountRecoverySetting

default CreateUserPoolRequest.Builder accountRecoverySetting(Consumer<AccountRecoverySettingType.Builder> 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.

This is a convenience that creates an instance of the AccountRecoverySettingType.Builder avoiding the need to create one manually via AccountRecoverySettingType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accountRecoverySetting(AccountRecoverySettingType).

Parameters:

accountRecoverySetting - a consumer that will call methods on AccountRecoverySettingType.Builder

Returns:

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

See Also:

accountRecoverySetting(AccountRecoverySettingType)

overrideConfiguration

CreateUserPoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateUserPoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder