Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Documentation

data UsernameConfigurationType

The username configuration type.

See: newUsernameConfigurationType smart constructor.

Constructors

UsernameConfigurationType'

Fields

• caseSensitive :: Bool

  Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

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

Instances

FromJSON UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Methods

parseJSON :: Value -> Parser UsernameConfigurationType

parseJSONList :: Value -> Parser [UsernameConfigurationType]

ToJSON UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Methods

toJSON :: UsernameConfigurationType -> Value

toEncoding :: UsernameConfigurationType -> Encoding

toJSONList :: [UsernameConfigurationType] -> Value

toEncodingList :: [UsernameConfigurationType] -> Encoding

Generic UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Associated Types

type Rep UsernameConfigurationType :: Type -> Type

Methods

from :: UsernameConfigurationType -> Rep UsernameConfigurationType x

to :: Rep UsernameConfigurationType x -> UsernameConfigurationType

Read UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Methods

readsPrec :: Int -> ReadS UsernameConfigurationType

readList :: ReadS [UsernameConfigurationType]

readPrec :: ReadPrec UsernameConfigurationType

readListPrec :: ReadPrec [UsernameConfigurationType]

Show UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Methods

showsPrec :: Int -> UsernameConfigurationType -> ShowS

show :: UsernameConfigurationType -> String

showList :: [UsernameConfigurationType] -> ShowS

NFData UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Methods

rnf :: UsernameConfigurationType -> ()

Eq UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Methods

(==) :: UsernameConfigurationType -> UsernameConfigurationType -> Bool

(/=) :: UsernameConfigurationType -> UsernameConfigurationType -> Bool

Hashable UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

Methods

hashWithSalt :: Int -> UsernameConfigurationType -> Int

hash :: UsernameConfigurationType -> Int

type Rep UsernameConfigurationType

Defined in Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType

type Rep UsernameConfigurationType = D1 ('MetaData "UsernameConfigurationType" "Amazonka.CognitoIdentityProvider.Types.UsernameConfigurationType" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "UsernameConfigurationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "caseSensitive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))

newUsernameConfigurationType

Arguments

:: Bool

$sel:caseSensitive:UsernameConfigurationType'

-> UsernameConfigurationType

Create a value of UsernameConfigurationType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:caseSensitive:UsernameConfigurationType', usernameConfigurationType_caseSensitive - Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

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

usernameConfigurationType_caseSensitive :: Lens' UsernameConfigurationType Bool

Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs.

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