Struct aws_sdk_cognitoidentityprovider::operation::update_user_pool::builders::UpdateUserPoolInputBuilder

#[non_exhaustive]
pub struct UpdateUserPoolInputBuilder { /* private fields */ }

A builder for UpdateUserPoolInput.

Implementations

impl UpdateUserPoolInputBuilder

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

The user pool ID for the user pool you want to update.

This field is required.

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

The user pool ID for the user pool you want to update.

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

The user pool ID for the user pool you want to update.

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

A container with the policies you want to update in a user pool.

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

A container with the policies you want to update in a user pool.

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

A container with the policies you want to update in a 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 configuration information from the request to update the user pool.

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

The Lambda configuration information from the request to update the user pool.

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

The Lambda configuration information from the request to update the user pool.

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

Appends an item to auto_verified_attributes.

To override the contents of this collection use set_auto_verified_attributes.

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

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

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

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

The attributes that are automatically verified when Amazon Cognito requests to update user pools.

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 verification messages.

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

The template for verification messages.

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

The template for verification messages.

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

The contents of the SMS authentication message.

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

The contents of the SMS authentication message.

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

The contents of the SMS authentication message.

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 mfa_configuration(self, input: UserPoolMfaType) -> Self

Possible values include:

• OFF - MFA tokens aren't required and can't be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

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

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

Possible values include:

• OFF - MFA tokens aren't required and can't be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

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

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

Possible values include:

• OFF - MFA tokens aren't required and can't be specified during user registration.

• ON - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools.

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

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 email invitation and verification 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 email invitation and verification 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 email invitation and verification 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 user_pool_tags.

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

pub fn build(self) -> Result<UpdateUserPoolInput, BuildError>

Consumes the builder and constructs a UpdateUserPoolInput.

impl UpdateUserPoolInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<UpdateUserPoolOutput, SdkError<UpdateUserPoolError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for UpdateUserPoolInputBuilder

fn clone(&self) -> UpdateUserPoolInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateUserPoolInputBuilder

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

Formats the value using the given formatter.

impl Default for UpdateUserPoolInputBuilder

fn default() -> UpdateUserPoolInputBuilder

Returns the “default value” for a type.

impl PartialEq for UpdateUserPoolInputBuilder

fn eq(&self, other: &UpdateUserPoolInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateUserPoolInputBuilder