Struct rusoto_cognito_idp::UserPoolType

pub struct UserPoolType {

    pub account_recovery_setting: Option<AccountRecoverySettingType>,
    pub admin_create_user_config: Option<AdminCreateUserConfigType>,
    pub alias_attributes: Option<Vec<String>>,
    pub arn: Option<String>,
    pub auto_verified_attributes: Option<Vec<String>>,
    pub creation_date: Option<f64>,
    pub custom_domain: Option<String>,
    pub device_configuration: Option<DeviceConfigurationType>,
    pub domain: Option<String>,
    pub email_configuration: Option<EmailConfigurationType>,
    pub email_configuration_failure: Option<String>,
    pub email_verification_message: Option<String>,
    pub email_verification_subject: Option<String>,
    pub estimated_number_of_users: Option<i64>,
    pub id: Option<String>,
    pub lambda_config: Option<LambdaConfigType>,
    pub last_modified_date: Option<f64>,
    pub mfa_configuration: Option<String>,
    pub name: Option<String>,
    pub policies: Option<UserPoolPolicyType>,
    pub schema_attributes: Option<Vec<SchemaAttributeType>>,
    pub sms_authentication_message: Option<String>,
    pub sms_configuration: Option<SmsConfigurationType>,
    pub sms_configuration_failure: Option<String>,
    pub sms_verification_message: Option<String>,
    pub status: Option<String>,
    pub user_pool_add_ons: Option<UserPoolAddOnsType>,
    pub user_pool_tags: Option<HashMap<String, String>>,
    pub username_attributes: Option<Vec<String>>,
    pub username_configuration: Option<UsernameConfigurationType>,
    pub verification_message_template: Option<VerificationMessageTemplateType>,
}

A container for information about the user pool.

Fields

account_recovery_setting: Option<AccountRecoverySettingType>

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.

admin_create_user_config: Option<AdminCreateUserConfigType>

The configuration for AdminCreateUser requests.

alias_attributes: Option<Vec<String>>

Specifies the attributes that are aliased in a user pool.

arn: Option<String>

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

auto_verified_attributes: Option<Vec<String>>

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

creation_date: Option<f64>

The date the user pool was created.

custom_domain: 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. For example: auth.example.com.

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

device_configuration: Option<DeviceConfigurationType>

The device configuration.

domain: Option<String>

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

email_configuration: Option<EmailConfigurationType>

The email configuration.

email_configuration_failure: Option<String>

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

email_verification_message: Option<String>

The contents of the email verification message.

email_verification_subject: Option<String>

The subject of the email verification message.

estimated_number_of_users: Option<i64>

A number estimating the size of the user pool.

id: Option<String>

The ID of the user pool.

lambda_config: Option<LambdaConfigType>

The AWS Lambda triggers associated with the user pool.

last_modified_date: Option<f64>

The date the user pool was last modified.

mfa_configuration: Option<String>

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.

name: Option<String>

The name of the user pool.

policies: Option<UserPoolPolicyType>

The policies associated with the user pool.

schema_attributes: Option<Vec<SchemaAttributeType>>

A container with the schema attributes of a user pool.

sms_authentication_message: Option<String>

The contents of the SMS authentication message.

sms_configuration: Option<SmsConfigurationType>

The SMS configuration.

sms_configuration_failure: Option<String>

The reason why the SMS configuration cannot 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 IAM role which Cognito uses to send SMS messages is not properly configured. For more information, see SmsConfigurationType.

• SNSSandbox - The AWS account is in SNS Sandbox and messages won’t reach unverified end users. This parameter won’t get populated with SNSSandbox if the IAM user creating the user pool doesn’t have SNS permissions. To learn how to move your AWS account out of the sandbox, see Moving out of the SMS sandbox.

sms_verification_message: Option<String>

The contents of the SMS verification message.

status: Option<String>

The status of a user pool.

user_pool_add_ons: Option<UserPoolAddOnsType>

The user pool add-ons.

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

username_attributes: Option<Vec<String>>

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

username_configuration: Option<UsernameConfigurationType>

You can choose to enable 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.

verification_message_template: Option<VerificationMessageTemplateType>

The template for verification messages.

Trait Implementations

impl Clone for UserPoolType

fn clone(&self) -> UserPoolType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserPoolType

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

Formats the value using the given formatter.

impl Default for UserPoolType

fn default() -> UserPoolType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserPoolType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<UserPoolType> for UserPoolType

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

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

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

This method tests for !=.

impl StructuralPartialEq for UserPoolType