#[non_exhaustive]pub struct UsernameConfigurationTypeBuilder { /* private fields */ }
Expand description
A builder for UsernameConfigurationType
.
Implementations§
source§impl UsernameConfigurationTypeBuilder
impl UsernameConfigurationTypeBuilder
sourcepub fn case_sensitive(self, input: bool) -> Self
pub fn case_sensitive(self, input: bool) -> Self
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False
(case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.
Valid values include:
- True
-
Enables case sensitivity for all username input. When this option is set to
True
, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value. - False
-
Enables case insensitivity for all username input. For example, when this option is set to
False
, users can sign in usingusername
,USERNAME
, orUserName
. This option also enables bothpreferred_username
andemail
alias to be case insensitive, in addition to theusername
attribute.
sourcepub fn set_case_sensitive(self, input: Option<bool>) -> Self
pub fn set_case_sensitive(self, input: Option<bool>) -> Self
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False
(case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.
Valid values include:
- True
-
Enables case sensitivity for all username input. When this option is set to
True
, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value. - False
-
Enables case insensitivity for all username input. For example, when this option is set to
False
, users can sign in usingusername
,USERNAME
, orUserName
. This option also enables bothpreferred_username
andemail
alias to be case insensitive, in addition to theusername
attribute.
sourcepub fn get_case_sensitive(&self) -> &Option<bool>
pub fn get_case_sensitive(&self) -> &Option<bool>
Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to False
(case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.
Valid values include:
- True
-
Enables case sensitivity for all username input. When this option is set to
True
, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value. - False
-
Enables case insensitivity for all username input. For example, when this option is set to
False
, users can sign in usingusername
,USERNAME
, orUserName
. This option also enables bothpreferred_username
andemail
alias to be case insensitive, in addition to theusername
attribute.
sourcepub fn build(self) -> Result<UsernameConfigurationType, BuildError>
pub fn build(self) -> Result<UsernameConfigurationType, BuildError>
Consumes the builder and constructs a UsernameConfigurationType
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for UsernameConfigurationTypeBuilder
impl Clone for UsernameConfigurationTypeBuilder
source§fn clone(&self) -> UsernameConfigurationTypeBuilder
fn clone(&self) -> UsernameConfigurationTypeBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for UsernameConfigurationTypeBuilder
impl Default for UsernameConfigurationTypeBuilder
source§fn default() -> UsernameConfigurationTypeBuilder
fn default() -> UsernameConfigurationTypeBuilder
source§impl PartialEq for UsernameConfigurationTypeBuilder
impl PartialEq for UsernameConfigurationTypeBuilder
source§fn eq(&self, other: &UsernameConfigurationTypeBuilder) -> bool
fn eq(&self, other: &UsernameConfigurationTypeBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for UsernameConfigurationTypeBuilder
Auto Trait Implementations§
impl Freeze for UsernameConfigurationTypeBuilder
impl RefUnwindSafe for UsernameConfigurationTypeBuilder
impl Send for UsernameConfigurationTypeBuilder
impl Sync for UsernameConfigurationTypeBuilder
impl Unpin for UsernameConfigurationTypeBuilder
impl UnwindSafe for UsernameConfigurationTypeBuilder
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