Struct aws_sdk_cognitoidentityprovider::types::AdminCreateUserConfigType

#[non_exhaustive]
pub struct AdminCreateUserConfigType {
    pub allow_admin_create_user_only: bool,
    pub unused_account_validity_days: i32,
    pub invite_message_template: Option<MessageTemplateType>,
}

The configuration for creating a new user profile.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allow_admin_create_user_only: bool

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

unused_account_validity_days: i32

The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.

invite_message_template: Option<MessageTemplateType>

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages.

Implementations

impl AdminCreateUserConfigType

pub fn allow_admin_create_user_only(&self) -> bool

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

pub fn unused_account_validity_days(&self) -> i32

The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.

pub fn invite_message_template(&self) -> Option<&MessageTemplateType>

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages.

impl AdminCreateUserConfigType

pub fn builder() -> AdminCreateUserConfigTypeBuilder

Creates a new builder-style object to manufacture AdminCreateUserConfigType.

Trait Implementations

impl Clone for AdminCreateUserConfigType

fn clone(&self) -> AdminCreateUserConfigType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AdminCreateUserConfigType

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

Formats the value using the given formatter.

impl PartialEq for AdminCreateUserConfigType

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