#[non_exhaustive]pub struct AdminCreateUserConfigType {
pub allow_admin_create_user_only: bool,
pub unused_account_validity_days: i32,
pub invite_message_template: Option<MessageTemplateType>,
}
Expand description
The configuration for creating a new user profile.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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§
source§impl AdminCreateUserConfigType
impl AdminCreateUserConfigType
sourcepub fn allow_admin_create_user_only(&self) -> bool
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.
sourcepub fn unused_account_validity_days(&self) -> i32
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.
sourcepub fn invite_message_template(&self) -> Option<&MessageTemplateType>
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.
source§impl AdminCreateUserConfigType
impl AdminCreateUserConfigType
sourcepub fn builder() -> AdminCreateUserConfigTypeBuilder
pub fn builder() -> AdminCreateUserConfigTypeBuilder
Creates a new builder-style object to manufacture AdminCreateUserConfigType
.
Trait Implementations§
source§impl Clone for AdminCreateUserConfigType
impl Clone for AdminCreateUserConfigType
source§fn clone(&self) -> AdminCreateUserConfigType
fn clone(&self) -> AdminCreateUserConfigType
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AdminCreateUserConfigType
impl Debug for AdminCreateUserConfigType
source§impl PartialEq for AdminCreateUserConfigType
impl PartialEq for AdminCreateUserConfigType
source§fn eq(&self, other: &AdminCreateUserConfigType) -> bool
fn eq(&self, other: &AdminCreateUserConfigType) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AdminCreateUserConfigType
Auto Trait Implementations§
impl Freeze for AdminCreateUserConfigType
impl RefUnwindSafe for AdminCreateUserConfigType
impl Send for AdminCreateUserConfigType
impl Sync for AdminCreateUserConfigType
impl Unpin for AdminCreateUserConfigType
impl UnwindSafe for AdminCreateUserConfigType
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more