Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig

Description

Synopsis

Documentation

data CreateBackendAuthUserPoolConfig Source #

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

passwordPolicy :: Maybe CreateBackendAuthPasswordPolicyConfig
Describes the 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.
forgotPassword :: Maybe CreateBackendAuthForgotPasswordConfig
Describes the forgotten password policy 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.
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

Instances details

Eq CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig Methods (==) :: CreateBackendAuthUserPoolConfig -> CreateBackendAuthUserPoolConfig -> Bool # (/=) :: CreateBackendAuthUserPoolConfig -> CreateBackendAuthUserPoolConfig -> Bool #
Read CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig Methods readsPrec :: Int -> ReadS CreateBackendAuthUserPoolConfig # readList :: ReadS [CreateBackendAuthUserPoolConfig] # readPrec :: ReadPrec CreateBackendAuthUserPoolConfig # readListPrec :: ReadPrec [CreateBackendAuthUserPoolConfig] #
Show CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig Methods showsPrec :: Int -> CreateBackendAuthUserPoolConfig -> ShowS # show :: CreateBackendAuthUserPoolConfig -> String # showList :: [CreateBackendAuthUserPoolConfig] -> ShowS #
Generic CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig Associated Types type Rep CreateBackendAuthUserPoolConfig :: Type -> Type # Methods from :: CreateBackendAuthUserPoolConfig -> Rep CreateBackendAuthUserPoolConfig x # to :: Rep CreateBackendAuthUserPoolConfig x -> CreateBackendAuthUserPoolConfig #
NFData CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig Methods rnf :: CreateBackendAuthUserPoolConfig -> () #
Hashable CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig Methods hashWithSalt :: Int -> CreateBackendAuthUserPoolConfig -> Int # hash :: CreateBackendAuthUserPoolConfig -> Int #
ToJSON CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig Methods toJSON :: CreateBackendAuthUserPoolConfig -> Value # toEncoding :: CreateBackendAuthUserPoolConfig -> Encoding # toJSONList :: [CreateBackendAuthUserPoolConfig] -> Value # toEncodingList :: [CreateBackendAuthUserPoolConfig] -> Encoding #
FromJSON CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig Methods parseJSON :: Value -> Parser CreateBackendAuthUserPoolConfig # parseJSONList :: Value -> Parser [CreateBackendAuthUserPoolConfig] #
type Rep CreateBackendAuthUserPoolConfig Source #
Instance details Defined in Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig type Rep CreateBackendAuthUserPoolConfig = D1 ('MetaData "CreateBackendAuthUserPoolConfig" "Amazonka.AmplifyBackend.Types.CreateBackendAuthUserPoolConfig" "libZSservicesZSamazonka-amplifybackendZSamazonka-amplifybackend" 'False) (C1 ('MetaCons "CreateBackendAuthUserPoolConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "passwordPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthPasswordPolicyConfig)) :: (S1 ('MetaSel ('Just "mfa") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthMFAConfig)) :: S1 ('MetaSel ('Just "forgotPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthForgotPasswordConfig)))) :: ((S1 ('MetaSel ('Just "oAuth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CreateBackendAuthOAuthConfig)) :: 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 Source #

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:passwordPolicy:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_passwordPolicy - Describes the 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:forgotPassword:CreateBackendAuthUserPoolConfig', createBackendAuthUserPoolConfig_forgotPassword - Describes the forgotten password policy 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: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_passwordPolicy :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthPasswordPolicyConfig) Source #

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

createBackendAuthUserPoolConfig_mfa :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthMFAConfig) Source #

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

createBackendAuthUserPoolConfig_forgotPassword :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthForgotPasswordConfig) Source #

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

createBackendAuthUserPoolConfig_oAuth :: Lens' CreateBackendAuthUserPoolConfig (Maybe CreateBackendAuthOAuthConfig) Source #

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

createBackendAuthUserPoolConfig_requiredSignUpAttributes :: Lens' CreateBackendAuthUserPoolConfig [RequiredSignUpAttributesElement] Source #

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

createBackendAuthUserPoolConfig_signInMethod :: Lens' CreateBackendAuthUserPoolConfig SignInMethod Source #

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 Source #

The Amazon Cognito user pool name.