software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UserPoolType.Builder

All Superinterfaces:

CopyableBuilder<UserPoolType.Builder,UserPoolType>, SdkBuilder<UserPoolType.Builder,UserPoolType>

Enclosing class:

UserPoolType

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

Method Summary

Modifier and Type	Method and Description
UserPoolType.Builder	adminCreateUserConfig(AdminCreateUserConfigType adminCreateUserConfig) The configuration for AdminCreateUser requests.
default UserPoolType.Builder	adminCreateUserConfig(Consumer<AdminCreateUserConfigType.Builder> adminCreateUserConfig) The configuration for AdminCreateUser requests.
UserPoolType.Builder	aliasAttributes(Collection<String> aliasAttributes) Specifies the attributes that are aliased in a user pool.
UserPoolType.Builder	aliasAttributes(String... aliasAttributes) Specifies the attributes that are aliased in a user pool.
UserPoolType.Builder	autoVerifiedAttributes(Collection<String> autoVerifiedAttributes) Specifies the attributes that are auto-verified in a user pool.
UserPoolType.Builder	autoVerifiedAttributes(String... autoVerifiedAttributes) Specifies the attributes that are auto-verified in a user pool.
UserPoolType.Builder	creationDate(Instant creationDate) The date the user pool was created.
default UserPoolType.Builder	deviceConfiguration(Consumer<DeviceConfigurationType.Builder> deviceConfiguration) The device configuration.
UserPoolType.Builder	deviceConfiguration(DeviceConfigurationType deviceConfiguration) The device configuration.
default UserPoolType.Builder	emailConfiguration(Consumer<EmailConfigurationType.Builder> emailConfiguration) The email configuration.
UserPoolType.Builder	emailConfiguration(EmailConfigurationType emailConfiguration) The email configuration.
UserPoolType.Builder	emailConfigurationFailure(String emailConfigurationFailure) The reason why the email configuration cannot send the messages to your users.
UserPoolType.Builder	emailVerificationMessage(String emailVerificationMessage) The contents of the email verification message.
UserPoolType.Builder	emailVerificationSubject(String emailVerificationSubject) The subject of the email verification message.
UserPoolType.Builder	estimatedNumberOfUsers(Integer estimatedNumberOfUsers) A number estimating the size of the user pool.
UserPoolType.Builder	id(String id) The ID of the user pool.
default UserPoolType.Builder	lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig) A container for the AWS Lambda triggers associated with a user pool.
UserPoolType.Builder	lambdaConfig(LambdaConfigType lambdaConfig) A container for the AWS Lambda triggers associated with a user pool.
UserPoolType.Builder	lastModifiedDate(Instant lastModifiedDate) The date the user pool was last modified.
UserPoolType.Builder	mfaConfiguration(String mfaConfiguration) Can be one of the following values:
UserPoolType.Builder	mfaConfiguration(UserPoolMfaType mfaConfiguration) Can be one of the following values:
UserPoolType.Builder	name(String name) The name of the user pool.
default UserPoolType.Builder	policies(Consumer<UserPoolPolicyType.Builder> policies) A container for the policies associated with a user pool.
UserPoolType.Builder	policies(UserPoolPolicyType policies) A container for the policies associated with a user pool.
UserPoolType.Builder	schemaAttributes(Collection<SchemaAttributeType> schemaAttributes) A container with the schema attributes of a user pool.
UserPoolType.Builder	schemaAttributes(Consumer<SchemaAttributeType.Builder>... schemaAttributes) A container with the schema attributes of a user pool.
UserPoolType.Builder	schemaAttributes(SchemaAttributeType... schemaAttributes) A container with the schema attributes of a user pool.
UserPoolType.Builder	smsAuthenticationMessage(String smsAuthenticationMessage) The contents of the SMS authentication message.
default UserPoolType.Builder	smsConfiguration(Consumer<SmsConfigurationType.Builder> smsConfiguration) The SMS configuration.
UserPoolType.Builder	smsConfiguration(SmsConfigurationType smsConfiguration) The SMS configuration.
UserPoolType.Builder	smsConfigurationFailure(String smsConfigurationFailure) The reason why the SMS configuration cannot send the messages to your users.
UserPoolType.Builder	smsVerificationMessage(String smsVerificationMessage) The contents of the SMS verification message.
UserPoolType.Builder	status(StatusType status) The status of a user pool.
UserPoolType.Builder	status(String status) The status of a user pool.
UserPoolType.Builder	usernameAttributes(Collection<String> usernameAttributes) Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
UserPoolType.Builder	usernameAttributes(String... usernameAttributes) Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
UserPoolType.Builder	userPoolTags(Map<String,String> userPoolTags) The cost allocation tags for the user pool.
default UserPoolType.Builder	verificationMessageTemplate(Consumer<VerificationMessageTemplateType.Builder> verificationMessageTemplate) The template for verification messages.
UserPoolType.Builder	verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate) The template for verification messages.

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

id

UserPoolType.Builder id(String id)

The ID of the user pool.

Parameters:

id - The ID of the user pool.

Returns:

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

name

UserPoolType.Builder name(String name)

The name of the user pool.

Parameters:

name - The name of the user pool.

Returns:

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

policies

UserPoolType.Builder policies(UserPoolPolicyType policies)

A container for the policies associated with a user pool.

Parameters:

policies - A container for the policies associated with a user pool.

Returns:

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

policies

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

A container for the policies associated with a 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

UserPoolType.Builder lambdaConfig(LambdaConfigType lambdaConfig)

A container for the AWS Lambda triggers associated with a user pool.

Parameters:

lambdaConfig - A container for the AWS Lambda triggers associated with a user pool.

Returns:

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

lambdaConfig

default UserPoolType.Builder lambdaConfig(Consumer<LambdaConfigType.Builder> lambdaConfig)

A container for the AWS Lambda triggers associated with a user pool.

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)

status

UserPoolType.Builder status(String status)

The status of a user pool.

Parameters:

status - The status of a user pool.

Returns:

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

See Also:

StatusType, StatusType

status

UserPoolType.Builder status(StatusType status)

The status of a user pool.

Parameters:

status - The status of a user pool.

Returns:

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

See Also:

StatusType, StatusType

lastModifiedDate

UserPoolType.Builder lastModifiedDate(Instant lastModifiedDate)

The date the user pool was last modified.

Parameters:

lastModifiedDate - The date the user pool was last modified.

Returns:

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

creationDate

UserPoolType.Builder creationDate(Instant creationDate)

The date the user pool was created.

Parameters:

creationDate - The date the user pool was created.

Returns:

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

schemaAttributes

UserPoolType.Builder schemaAttributes(Collection<SchemaAttributeType> schemaAttributes)

A container with the schema attributes of a user pool.

Parameters:

schemaAttributes - A container with the schema attributes of a user pool.

Returns:

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

schemaAttributes

UserPoolType.Builder schemaAttributes(SchemaAttributeType... schemaAttributes)

A container with the schema attributes of a user pool.

Parameters:

schemaAttributes - A container with the schema attributes of a user pool.

Returns:

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

schemaAttributes

UserPoolType.Builder schemaAttributes(Consumer<SchemaAttributeType.Builder>... schemaAttributes)

A container with the schema attributes of a user pool.

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 #schemaAttributes(List).

Parameters:

schemaAttributes - 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:

#schemaAttributes(List)

autoVerifiedAttributes

UserPoolType.Builder autoVerifiedAttributes(Collection<String> autoVerifiedAttributes)

Specifies the attributes that are auto-verified in a user pool.

Parameters:

autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.

Returns:

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

autoVerifiedAttributes

UserPoolType.Builder autoVerifiedAttributes(String... autoVerifiedAttributes)

Specifies the attributes that are auto-verified in a user pool.

Parameters:

autoVerifiedAttributes - Specifies the attributes that are auto-verified in a user pool.

Returns:

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

aliasAttributes

UserPoolType.Builder aliasAttributes(Collection<String> aliasAttributes)

Specifies the attributes that are aliased in a user pool.

Parameters:

aliasAttributes - Specifies the attributes that are aliased in a user pool.

Returns:

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

aliasAttributes

UserPoolType.Builder aliasAttributes(String... aliasAttributes)

Specifies the attributes that are aliased in a user pool.

Parameters:

aliasAttributes - Specifies the attributes that are aliased in a user pool.

Returns:

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

usernameAttributes

UserPoolType.Builder usernameAttributes(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.

usernameAttributes

UserPoolType.Builder usernameAttributes(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.

smsVerificationMessage

UserPoolType.Builder smsVerificationMessage(String smsVerificationMessage)

The contents of the SMS verification message.

Parameters:

smsVerificationMessage - The contents of the SMS verification message.

Returns:

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

emailVerificationMessage

UserPoolType.Builder emailVerificationMessage(String emailVerificationMessage)

The contents of the email verification message.

Parameters:

emailVerificationMessage - The contents of the email verification message.

Returns:

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

emailVerificationSubject

UserPoolType.Builder emailVerificationSubject(String emailVerificationSubject)

The subject of the email verification message.

Parameters:

emailVerificationSubject - The subject of the email verification message.

Returns:

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

verificationMessageTemplate

UserPoolType.Builder verificationMessageTemplate(VerificationMessageTemplateType verificationMessageTemplate)

The template for verification messages.

Parameters:

verificationMessageTemplate - The template for verification messages.

Returns:

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

verificationMessageTemplate

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

The template for verification messages.

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

UserPoolType.Builder smsAuthenticationMessage(String smsAuthenticationMessage)

The contents of the SMS authentication message.

Parameters:

smsAuthenticationMessage - The contents of the SMS authentication message.

Returns:

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

mfaConfiguration

UserPoolType.Builder mfaConfiguration(String mfaConfiguration)

Can be one of the following values:

• OFF - MFA tokens are not required and cannot be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

• OPTIONAL - Users have the option when registering to create an MFA token.

Parameters:

mfaConfiguration - Can be one of the following values:

• OFF - MFA tokens are not required and cannot be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

• OPTIONAL - Users have the option when registering to create an MFA token.

Returns:

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

See Also:

UserPoolMfaType, UserPoolMfaType

mfaConfiguration

UserPoolType.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)

Can be one of the following values:

• OFF - MFA tokens are not required and cannot be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

• OPTIONAL - Users have the option when registering to create an MFA token.

Parameters:

mfaConfiguration - Can be one of the following values:

• OFF - MFA tokens are not required and cannot be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

• OPTIONAL - Users have the option when registering to create an MFA token.

Returns:

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

See Also:

UserPoolMfaType, UserPoolMfaType

deviceConfiguration

UserPoolType.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 UserPoolType.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)

estimatedNumberOfUsers

UserPoolType.Builder estimatedNumberOfUsers(Integer estimatedNumberOfUsers)

A number estimating the size of the user pool.

Parameters:

estimatedNumberOfUsers - A number estimating the size of the user pool.

Returns:

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

emailConfiguration

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

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

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

smsConfigurationFailure

UserPoolType.Builder smsConfigurationFailure(String smsConfigurationFailure)

The reason why the SMS configuration cannot send the messages to your users.

Parameters:

smsConfigurationFailure - The reason why the SMS configuration cannot send the messages to your users.

Returns:

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

emailConfigurationFailure

UserPoolType.Builder emailConfigurationFailure(String emailConfigurationFailure)

The reason why the email configuration cannot send the messages to your users.

Parameters:

emailConfigurationFailure - The reason why the email configuration cannot send the messages to your users.

Returns:

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

adminCreateUserConfig

UserPoolType.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 UserPoolType.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)