Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Documentation

data CreateBackendAuthUserPoolConfig

Describes the Amazon Cognito user pool configuration for the auth resource to be configured for your Amplify project.

See: newCreateBackendAuthUserPoolConfig smart constructor.

Constructors

CreateBackendAuthUserPoolConfig'

Fields

• forgotPassword :: Maybe CreateBackendAuthForgotPasswordConfig

  (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

• mfa :: Maybe CreateBackendAuthMFAConfig

  Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

• oAuth :: Maybe CreateBackendAuthOAuthConfig

  Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

• passwordPolicy :: Maybe CreateBackendAuthPasswordPolicyConfig

  Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

• verificationMessage :: Maybe CreateBackendAuthVerificationMessageConfig

  Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

• requiredSignUpAttributes :: [RequiredSignUpAttributesElement]

  The required attributes to sign up new users in the user pool.

• signInMethod :: SignInMethod

  Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

• userPoolName :: Text

  The Amazon Cognito user pool name.

Instances

FromJSON CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Methods

parseJSON :: Value -> Parser CreateBackendAuthUserPoolConfig

parseJSONList :: Value -> Parser [CreateBackendAuthUserPoolConfig]

ToJSON CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Methods

toJSON :: CreateBackendAuthUserPoolConfig -> Value

toEncoding :: CreateBackendAuthUserPoolConfig -> Encoding

toJSONList :: [CreateBackendAuthUserPoolConfig] -> Value

toEncodingList :: [CreateBackendAuthUserPoolConfig] -> Encoding

Generic CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Associated Types

type Rep CreateBackendAuthUserPoolConfig :: Type -> Type

Methods

from :: CreateBackendAuthUserPoolConfig -> Rep CreateBackendAuthUserPoolConfig x

to :: Rep CreateBackendAuthUserPoolConfig x -> CreateBackendAuthUserPoolConfig

Read CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Methods

readsPrec :: Int -> ReadS CreateBackendAuthUserPoolConfig

readList :: ReadS [CreateBackendAuthUserPoolConfig]

readPrec :: ReadPrec CreateBackendAuthUserPoolConfig

readListPrec :: ReadPrec [CreateBackendAuthUserPoolConfig]

Show CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Methods

showsPrec :: Int -> CreateBackendAuthUserPoolConfig -> ShowS

show :: CreateBackendAuthUserPoolConfig -> String

showList :: [CreateBackendAuthUserPoolConfig] -> ShowS

NFData CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Methods

rnf :: CreateBackendAuthUserPoolConfig -> ()

Eq CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Methods

(==) :: CreateBackendAuthUserPoolConfig -> CreateBackendAuthUserPoolConfig -> Bool

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

Hashable CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Methods

hashWithSalt :: Int -> CreateBackendAuthUserPoolConfig -> Int

hash :: CreateBackendAuthUserPoolConfig -> Int

type Rep CreateBackendAuthUserPoolConfig

Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

type Rep CreateBackendAuthUserPoolConfig = D1 ('MetaData "CreateBackendAuthUserPoolConfig" "Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig" "amazonka-amplifybackend-2.0-KAbme26dIsGHSomQ2pZcRc" 'False) (C1 ('MetaCons "CreateBackendAuthUserPoolConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "forgotPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthForgotPasswordConfig)) :*: S1 ('MetaSel ('Just "mfa") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthMFAConfig))) :*: (S1 ('MetaSel ('Just "oAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthOAuthConfig)) :*: S1 ('MetaSel ('Just "passwordPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthPasswordPolicyConfig)))) :*: ((S1 ('MetaSel ('Just "verificationMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthVerificationMessageConfig)) :*: S1 ('MetaSel ('Just "requiredSignUpAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RequiredSignUpAttributesElement])) :*: (S1 ('MetaSel ('Just "signInMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SignInMethod) :*: S1 ('MetaSel ('Just "userPoolName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateBackendAuthUserPoolConfig

Arguments

:: SignInMethod

$sel:signInMethod:CreateBackendAuthUserPoolConfig'

-> Text

$sel:userPoolName:CreateBackendAuthUserPoolConfig'

-> CreateBackendAuthUserPoolConfig

Create a value of CreateBackendAuthUserPoolConfig 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:forgotPassword:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_forgotPassword - (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

$sel:mfa:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_mfa - Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

$sel:oAuth:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_oAuth - Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

$sel:passwordPolicy:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_passwordPolicy - Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

$sel:verificationMessage:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_verificationMessage - Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

$sel:requiredSignUpAttributes:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_requiredSignUpAttributes - The required attributes to sign up new users in the user pool.

$sel:signInMethod:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_signInMethod - Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

$sel:userPoolName:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_userPoolName - The Amazon Cognito user pool name.

createBackendAuthUserPoolConfig_forgotPassword :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthForgotPasswordConfig)

(DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

createBackendAuthUserPoolConfig_mfa :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthMFAConfig)

Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool configured as a part of your Amplify project.

createBackendAuthUserPoolConfig_oAuth :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthOAuthConfig)

Describes the OAuth policy and rules for your Amazon Cognito user pool, configured as a part of your Amplify project.

createBackendAuthUserPoolConfig_passwordPolicy :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthPasswordPolicyConfig)

Describes the password policy for your Amazon Cognito user pool, configured as a part of your Amplify project.

createBackendAuthUserPoolConfig_verificationMessage :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthVerificationMessageConfig)

Describes the email or SMS verification message for your Amazon Cognito user pool, configured as a part of your Amplify project.

createBackendAuthUserPoolConfig_requiredSignUpAttributes :: Lens' CreateBackendAuthUserPoolConfig [RequiredSignUpAttributesElement]

The required attributes to sign up new users in the user pool.

createBackendAuthUserPoolConfig_signInMethod :: Lens' CreateBackendAuthUserPoolConfig SignInMethod

Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, configured as a part of your Amplify project.

createBackendAuthUserPoolConfig_userPoolName :: Lens' CreateBackendAuthUserPoolConfig Text

The Amazon Cognito user pool name.