Struct aws_sdk_cognitoidentityprovider::types::builders::UserPoolTypeBuilder

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

A builder for UserPoolType.

Implementations

impl UserPoolTypeBuilder

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

The ID of the user pool.

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

The ID of the user pool.

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

The ID of the user pool.

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

The name of the user pool.

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

The name of the user pool.

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

The name of the user pool.

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

The policies associated with the user pool.

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

The policies associated with the user pool.

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

The policies associated with the 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 triggers associated with the user pool.

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

The Lambda triggers associated with the user pool.

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

The Lambda triggers associated with the user pool.

pub fn status(self, input: StatusType) -> Self

👎Deprecated: This property is no longer available.

This parameter is no longer used.

pub fn set_status(self, input: Option<StatusType>) -> Self

👎Deprecated: This property is no longer available.

This parameter is no longer used.

pub fn get_status(&self) -> &Option<StatusType>

👎Deprecated: This property is no longer available.

This parameter is no longer used.

pub fn last_modified_date(self, input: DateTime) -> Self

The date and time, in ISO 8601 format, when the item was modified.

pub fn set_last_modified_date(self, input: Option<DateTime>) -> Self

The date and time, in ISO 8601 format, when the item was modified.

pub fn get_last_modified_date(&self) -> &Option<DateTime>

The date and time, in ISO 8601 format, when the item was modified.

pub fn creation_date(self, input: DateTime) -> Self

The date and time, in ISO 8601 format, when the item was created.

pub fn set_creation_date(self, input: Option<DateTime>) -> Self

The date and time, in ISO 8601 format, when the item was created.

pub fn get_creation_date(&self) -> &Option<DateTime>

The date and time, in ISO 8601 format, when the item was created.

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

Appends an item to schema_attributes.

To override the contents of this collection use set_schema_attributes.

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

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

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

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

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

Developer-only attributes are a legacy feature of user pools, are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

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 auto-verified in a user pool.

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

The attributes that are auto-verified in a user pool.

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

The attributes that are auto-verified in a user pool.

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

Appends an item to alias_attributes.

To override the contents of this collection use set_alias_attributes.

The attributes that are aliased in a user pool.

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

The attributes that are aliased in a user pool.

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

The attributes that are aliased in a user pool.

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

Appends an item to username_attributes.

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

Can be one of the following values:

• 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 required when you're initially creating a user pool.

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

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

Can be one of the following values:

• 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 required when you're initially creating a user pool.

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

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

Can be one of the following values:

• 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 required when you're initially creating a user pool.

• 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 estimated_number_of_users(self, input: i32) -> Self

A number estimating the size of the user pool.

pub fn set_estimated_number_of_users(self, input: Option<i32>) -> Self

A number estimating the size of the user pool.

pub fn get_estimated_number_of_users(&self) -> &Option<i32>

A number estimating the size of the user pool.

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

To override the contents of this collection use set_user_pool_tags.

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them 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 tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

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

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

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

The reason why the SMS configuration can't send the messages to your users.

This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

InvalidSmsRoleAccessPolicyException

The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

SNSSandbox

The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

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

The reason why the SMS configuration can't send the messages to your users.

This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

InvalidSmsRoleAccessPolicyException

The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

SNSSandbox

The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

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

The reason why the SMS configuration can't send the messages to your users.

This message might include comma-separated values to describe why your SMS configuration can't send messages to user pool end users.

InvalidSmsRoleAccessPolicyException

The Identity and Access Management role that Amazon Cognito uses to send SMS messages isn't properly configured. For more information, see SmsConfigurationType.

SNSSandbox

The Amazon Web Services account is in the SNS SMS Sandbox and messages will only reach verified end users. This parameter won’t get populated with SNSSandbox if the user creating the user pool doesn’t have SNS permissions. To learn how to move your Amazon Web Services account out of the sandbox, see Moving out of the SMS sandbox.

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

Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

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

Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

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

Deprecated. Review error codes from API requests with EventSource:cognito-idp.amazonaws.com in CloudTrail for information about problems with user pool email configuration.

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

The domain prefix, if the user pool has a domain associated with it.

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

The domain prefix, if the user pool has a domain associated with it.

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

The domain prefix, if the user pool has a domain associated with it.

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

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

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

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

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

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. An example of a custom domain name might be auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

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 username_configuration(self, input: UsernameConfigurationType) -> Self

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

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

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

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

Case sensitivity of the username input for the selected sign-in option. For example, when case sensitivity is set to False, users can sign in using either "username" or "Username". This configuration is immutable once it has been set. For more information, see UsernameConfigurationType.

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

The Amazon Resource Name (ARN) for the user pool.

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

The Amazon Resource Name (ARN) for the user pool.

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

The Amazon Resource Name (ARN) for the 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) -> UserPoolType

Consumes the builder and constructs a UserPoolType.

Trait Implementations

impl Clone for UserPoolTypeBuilder

fn clone(&self) -> UserPoolTypeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserPoolTypeBuilder

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

Formats the value using the given formatter.

impl Default for UserPoolTypeBuilder

fn default() -> UserPoolTypeBuilder

Returns the “default value” for a type.

impl PartialEq for UserPoolTypeBuilder

fn eq(&self, other: &UserPoolTypeBuilder) -> 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 UserPoolTypeBuilder