[−][src]Struct rusoto_cognito_idp::UserPoolType
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.
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.
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.
verification_message_template: Option<VerificationMessageTemplateType>
The template for verification messages.
Trait Implementations
impl Clone for UserPoolType
[src]
fn clone(&self) -> UserPoolType
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for UserPoolType
[src]
impl Default for UserPoolType
[src]
fn default() -> UserPoolType
[src]
impl<'de> Deserialize<'de> for UserPoolType
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<UserPoolType> for UserPoolType
[src]
fn eq(&self, other: &UserPoolType) -> bool
[src]
fn ne(&self, other: &UserPoolType) -> bool
[src]
impl StructuralPartialEq for UserPoolType
[src]
Auto Trait Implementations
impl RefUnwindSafe for UserPoolType
impl Send for UserPoolType
impl Sync for UserPoolType
impl Unpin for UserPoolType
impl UnwindSafe for UserPoolType
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,