Struct aws_sdk_cognitoidentityprovider::operation::create_user_pool::builders::CreateUserPoolFluentBuilder

pub struct CreateUserPoolFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateUserPool.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Implementations

impl CreateUserPoolFluentBuilder

pub fn as_input(&self) -> &CreateUserPoolInputBuilder

Access the CreateUserPool as a reference.

pub async fn send( self, ) -> Result<CreateUserPoolOutput, SdkError<CreateUserPoolError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<CreateUserPoolOutput, CreateUserPoolError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn pool_name(self, input: impl Into<String>) -> Self

A string used to name the user pool.

pub fn set_pool_name(self, input: Option<String>) -> Self

A string used to name the user pool.

pub fn get_pool_name(&self) -> &Option<String>

A string used to name the user pool.

pub fn policies(self, input: UserPoolPolicyType) -> Self

The policies associated with the new user pool.

pub fn set_policies(self, input: Option<UserPoolPolicyType>) -> Self

The policies associated with the new user pool.

pub fn get_policies(&self) -> &Option<UserPoolPolicyType>

The policies associated with the new user pool.

pub fn deletion_protection(self, input: DeletionProtectionType) -> Self

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

pub fn set_deletion_protection( self, input: Option<DeletionProtectionType>, ) -> Self

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

pub fn get_deletion_protection(&self) -> &Option<DeletionProtectionType>

When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.

When you try to delete a protected user pool in a DeleteUserPool API request, Amazon Cognito returns an InvalidParameterException error. To delete a protected user pool, send a new DeleteUserPool request after you deactivate deletion protection in an UpdateUserPool API request.

pub fn lambda_config(self, input: LambdaConfigType) -> Self

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 .

pub fn set_lambda_config(self, input: Option<LambdaConfigType>) -> Self

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 .

pub fn get_lambda_config(&self) -> &Option<LambdaConfigType>

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 .

pub fn auto_verified_attributes(self, input: VerifiedAttributeType) -> Self

Appends an item to AutoVerifiedAttributes.

To override the contents of this collection use set_auto_verified_attributes.

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

pub fn set_auto_verified_attributes( self, input: Option<Vec<VerifiedAttributeType>>, ) -> Self

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

pub fn get_auto_verified_attributes( &self, ) -> &Option<Vec<VerifiedAttributeType>>

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

pub fn alias_attributes(self, input: AliasAttributeType) -> Self

Appends an item to AliasAttributes.

To override the contents of this collection use set_alias_attributes.

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

pub fn set_alias_attributes( self, input: Option<Vec<AliasAttributeType>>, ) -> Self

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

pub fn get_alias_attributes(&self) -> &Option<Vec<AliasAttributeType>>

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

pub fn username_attributes(self, input: UsernameAttributeType) -> Self

Appends an item to UsernameAttributes.

To override the contents of this collection use set_username_attributes.

Specifies whether a user can use an email address or phone number as a username when they sign up.

pub fn set_username_attributes( self, input: Option<Vec<UsernameAttributeType>>, ) -> Self

Specifies whether a user can use an email address or phone number as a username when they sign up.

pub fn get_username_attributes(&self) -> &Option<Vec<UsernameAttributeType>>

Specifies whether a user can use an email address or phone number as a username when they sign up.

pub fn sms_verification_message(self, input: impl Into<String>) -> Self

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn set_sms_verification_message(self, input: Option<String>) -> Self

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn get_sms_verification_message(&self) -> &Option<String>

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn email_verification_message(self, input: impl Into<String>) -> Self

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn set_email_verification_message(self, input: Option<String>) -> Self

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn get_email_verification_message(&self) -> &Option<String>

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn email_verification_subject(self, input: impl Into<String>) -> Self

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn set_email_verification_subject(self, input: Option<String>) -> Self

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn get_email_verification_subject(&self) -> &Option<String>

This parameter is no longer used. See VerificationMessageTemplateType.

pub fn verification_message_template( self, input: VerificationMessageTemplateType, ) -> Self

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

pub fn set_verification_message_template( self, input: Option<VerificationMessageTemplateType>, ) -> Self

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

pub fn get_verification_message_template( &self, ) -> &Option<VerificationMessageTemplateType>

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

pub fn sms_authentication_message(self, input: impl Into<String>) -> Self

A string representing the SMS authentication message.

pub fn set_sms_authentication_message(self, input: Option<String>) -> Self

A string representing the SMS authentication message.

pub fn get_sms_authentication_message(&self) -> &Option<String>

A string representing the SMS authentication message.

pub fn mfa_configuration(self, input: UserPoolMfaType) -> Self

Specifies MFA configuration details.

pub fn set_mfa_configuration(self, input: Option<UserPoolMfaType>) -> Self

Specifies MFA configuration details.

pub fn get_mfa_configuration(&self) -> &Option<UserPoolMfaType>

Specifies MFA configuration details.

pub fn user_attribute_update_settings( self, input: UserAttributeUpdateSettingsType, ) -> Self

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

pub fn set_user_attribute_update_settings( self, input: Option<UserAttributeUpdateSettingsType>, ) -> Self

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

pub fn get_user_attribute_update_settings( &self, ) -> &Option<UserAttributeUpdateSettingsType>

The settings for updates to user attributes. These settings include the property AttributesRequireVerificationBeforeUpdate, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see Verifying updates to email addresses and phone numbers.

pub fn device_configuration(self, input: DeviceConfigurationType) -> Self

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

pub fn set_device_configuration( self, input: Option<DeviceConfigurationType>, ) -> Self

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

pub fn get_device_configuration(&self) -> &Option<DeviceConfigurationType>

The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.

When you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.

pub fn email_configuration(self, input: EmailConfigurationType) -> Self

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.

pub fn set_email_configuration( self, input: Option<EmailConfigurationType>, ) -> Self

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.

pub fn get_email_configuration(&self) -> &Option<EmailConfigurationType>

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.

pub fn sms_configuration(self, input: SmsConfigurationType) -> Self

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.

pub fn set_sms_configuration(self, input: Option<SmsConfigurationType>) -> Self

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.

pub fn get_sms_configuration(&self) -> &Option<SmsConfigurationType>

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.

pub fn user_pool_tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to UserPoolTags.

To override the contents of this collection use set_user_pool_tags.

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.

pub fn set_user_pool_tags(self, input: Option<HashMap<String, String>>) -> Self

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.

pub fn get_user_pool_tags(&self) -> &Option<HashMap<String, String>>

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.

pub fn admin_create_user_config(self, input: AdminCreateUserConfigType) -> Self

The configuration for AdminCreateUser requests.

pub fn set_admin_create_user_config( self, input: Option<AdminCreateUserConfigType>, ) -> Self

The configuration for AdminCreateUser requests.

pub fn get_admin_create_user_config(&self) -> &Option<AdminCreateUserConfigType>

The configuration for AdminCreateUser requests.

pub fn schema(self, input: SchemaAttributeType) -> Self

Appends an item to Schema.

To override the contents of this collection use set_schema.

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

pub fn set_schema(self, input: Option<Vec<SchemaAttributeType>>) -> Self

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

pub fn get_schema(&self) -> &Option<Vec<SchemaAttributeType>>

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

pub fn user_pool_add_ons(self, input: UserPoolAddOnsType) -> Self

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

pub fn set_user_pool_add_ons(self, input: Option<UserPoolAddOnsType>) -> Self

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

pub fn get_user_pool_add_ons(&self) -> &Option<UserPoolAddOnsType>

User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to AUDIT. To configure automatic security responses to risky traffic to your user pool, set to ENFORCED.

For more information, see Adding advanced security to a user pool.

pub fn username_configuration(self, input: UsernameConfigurationType) -> Self

Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

pub fn set_username_configuration( self, input: Option<UsernameConfigurationType>, ) -> Self

Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

pub fn get_username_configuration(&self) -> &Option<UsernameConfigurationType>

Case sensitivity on the username input for the selected sign-in option. When case sensitivity is set to False (case insensitive), users can sign in with any combination of capital and lowercase letters. For example, username, USERNAME, or UserName, or for email, email@example.com or EMaiL@eXamplE.Com. For most use cases, set case sensitivity to False (case insensitive) as a best practice. When usernames and email addresses are case insensitive, Amazon Cognito treats any variation in case as the same user, and prevents a case variation from being assigned to the same attribute for a different user.

This configuration is immutable after you set it. For more information, see UsernameConfigurationType.

pub fn account_recovery_setting(self, input: AccountRecoverySettingType) -> Self

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.

pub fn set_account_recovery_setting( self, input: Option<AccountRecoverySettingType>, ) -> Self

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.

pub fn get_account_recovery_setting( &self, ) -> &Option<AccountRecoverySettingType>

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.

Trait Implementations

impl Clone for CreateUserPoolFluentBuilder

fn clone(&self) -> CreateUserPoolFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateUserPoolFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.