Struct 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 settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

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

The setting for allowing self-service sign-up. When true, only administrators can create new user profiles. When false, users can register themselves and create a new user profile with the SignUp operation.

unused_account_validity_days: i32

This parameter is no longer in use.

The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. 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.

invite_message_template: Option<MessageTemplateType>

The template for the welcome message to new users. This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

See also Customizing User Invitation Messages.

Implementations

impl AdminCreateUserConfigType

pub fn allow_admin_create_user_only(&self) -> bool

The setting for allowing self-service sign-up. When true, only administrators can create new user profiles. When false, users can register themselves and create a new user profile with the SignUp operation.

pub fn unused_account_validity_days(&self) -> i32

This parameter is no longer in use.

The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. 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.

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

The template for the welcome message to new users. This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

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 duplicate of the value.

const 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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AdminCreateUserConfigType