Struct aws_sdk_cognitoidentityprovider::types::builders::UsernameConfigurationTypeBuilder

#[non_exhaustive]
pub struct UsernameConfigurationTypeBuilder { /* private fields */ }

A builder for UsernameConfigurationType.

Implementations

impl UsernameConfigurationTypeBuilder

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 using username, USERNAME, or UserName. This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

This field is required.

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 using username, USERNAME, or UserName. This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

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 using username, USERNAME, or UserName. This option also enables both preferred_username and email alias to be case insensitive, in addition to the username attribute.

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:

• case_sensitive

Trait Implementations

impl Clone for UsernameConfigurationTypeBuilder

fn clone(&self) -> UsernameConfigurationTypeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UsernameConfigurationTypeBuilder

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

Formats the value using the given formatter.

impl Default for UsernameConfigurationTypeBuilder

fn default() -> UsernameConfigurationTypeBuilder

Returns the “default value” for a type.

impl PartialEq for UsernameConfigurationTypeBuilder

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