{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType where

import Amazonka.CognitoIdentityProvider.Types.MessageTemplateType
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | The configuration for creating a new user profile.
--
-- /See:/ 'newAdminCreateUserConfigType' smart constructor.
data AdminCreateUserConfigType = AdminCreateUserConfigType'
  { -- | Set to @True@ if only the administrator is allowed to create user
    -- profiles. Set to @False@ if users can sign themselves up via an app.
    AdminCreateUserConfigType -> Maybe Bool
allowAdminCreateUserOnly :: Prelude.Maybe Prelude.Bool,
    -- | The message template to be used for the welcome message to new users.
    --
    -- See also
    -- <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization Customizing User Invitation Messages>.
    AdminCreateUserConfigType -> Maybe MessageTemplateType
inviteMessageTemplate :: Prelude.Maybe MessageTemplateType,
    -- | The user account expiration limit, in days, after which a new account
    -- that hasn\'t signed in is no longer usable. To reset the account after
    -- that time limit, you must call @AdminCreateUser@ again, specifying
    -- @\"RESEND\"@ for the @MessageAction@ parameter. The default value for
    -- this parameter is 7.
    --
    -- If you set a value for @TemporaryPasswordValidityDays@ in
    -- @PasswordPolicy@, that value will be used, and
    -- @UnusedAccountValidityDays@ will be no longer be an available parameter
    -- for that user pool.
    AdminCreateUserConfigType -> Maybe Natural
unusedAccountValidityDays :: Prelude.Maybe Prelude.Natural
  }
  deriving (AdminCreateUserConfigType -> AdminCreateUserConfigType -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AdminCreateUserConfigType -> AdminCreateUserConfigType -> Bool
$c/= :: AdminCreateUserConfigType -> AdminCreateUserConfigType -> Bool
== :: AdminCreateUserConfigType -> AdminCreateUserConfigType -> Bool
$c== :: AdminCreateUserConfigType -> AdminCreateUserConfigType -> Bool
Prelude.Eq, ReadPrec [AdminCreateUserConfigType]
ReadPrec AdminCreateUserConfigType
Int -> ReadS AdminCreateUserConfigType
ReadS [AdminCreateUserConfigType]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AdminCreateUserConfigType]
$creadListPrec :: ReadPrec [AdminCreateUserConfigType]
readPrec :: ReadPrec AdminCreateUserConfigType
$creadPrec :: ReadPrec AdminCreateUserConfigType
readList :: ReadS [AdminCreateUserConfigType]
$creadList :: ReadS [AdminCreateUserConfigType]
readsPrec :: Int -> ReadS AdminCreateUserConfigType
$creadsPrec :: Int -> ReadS AdminCreateUserConfigType
Prelude.Read, Int -> AdminCreateUserConfigType -> ShowS
[AdminCreateUserConfigType] -> ShowS
AdminCreateUserConfigType -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AdminCreateUserConfigType] -> ShowS
$cshowList :: [AdminCreateUserConfigType] -> ShowS
show :: AdminCreateUserConfigType -> String
$cshow :: AdminCreateUserConfigType -> String
showsPrec :: Int -> AdminCreateUserConfigType -> ShowS
$cshowsPrec :: Int -> AdminCreateUserConfigType -> ShowS
Prelude.Show, forall x.
Rep AdminCreateUserConfigType x -> AdminCreateUserConfigType
forall x.
AdminCreateUserConfigType -> Rep AdminCreateUserConfigType x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep AdminCreateUserConfigType x -> AdminCreateUserConfigType
$cfrom :: forall x.
AdminCreateUserConfigType -> Rep AdminCreateUserConfigType x
Prelude.Generic)

-- |
-- Create a value of 'AdminCreateUserConfigType' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'allowAdminCreateUserOnly', 'adminCreateUserConfigType_allowAdminCreateUserOnly' - Set to @True@ if only the administrator is allowed to create user
-- profiles. Set to @False@ if users can sign themselves up via an app.
--
-- 'inviteMessageTemplate', 'adminCreateUserConfigType_inviteMessageTemplate' - The message template to be used for the welcome message to new users.
--
-- See also
-- <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization Customizing User Invitation Messages>.
--
-- 'unusedAccountValidityDays', 'adminCreateUserConfigType_unusedAccountValidityDays' - The user account expiration limit, in days, after which a new account
-- that hasn\'t signed in is no longer usable. To reset the account after
-- that time limit, you must call @AdminCreateUser@ again, specifying
-- @\"RESEND\"@ for the @MessageAction@ parameter. The default value for
-- this parameter is 7.
--
-- If you set a value for @TemporaryPasswordValidityDays@ in
-- @PasswordPolicy@, that value will be used, and
-- @UnusedAccountValidityDays@ will be no longer be an available parameter
-- for that user pool.
newAdminCreateUserConfigType ::
  AdminCreateUserConfigType
newAdminCreateUserConfigType :: AdminCreateUserConfigType
newAdminCreateUserConfigType =
  AdminCreateUserConfigType'
    { $sel:allowAdminCreateUserOnly:AdminCreateUserConfigType' :: Maybe Bool
allowAdminCreateUserOnly =
        forall a. Maybe a
Prelude.Nothing,
      $sel:inviteMessageTemplate:AdminCreateUserConfigType' :: Maybe MessageTemplateType
inviteMessageTemplate = forall a. Maybe a
Prelude.Nothing,
      $sel:unusedAccountValidityDays:AdminCreateUserConfigType' :: Maybe Natural
unusedAccountValidityDays = forall a. Maybe a
Prelude.Nothing
    }

-- | Set to @True@ if only the administrator is allowed to create user
-- profiles. Set to @False@ if users can sign themselves up via an app.
adminCreateUserConfigType_allowAdminCreateUserOnly :: Lens.Lens' AdminCreateUserConfigType (Prelude.Maybe Prelude.Bool)
adminCreateUserConfigType_allowAdminCreateUserOnly :: Lens' AdminCreateUserConfigType (Maybe Bool)
adminCreateUserConfigType_allowAdminCreateUserOnly = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminCreateUserConfigType' {Maybe Bool
allowAdminCreateUserOnly :: Maybe Bool
$sel:allowAdminCreateUserOnly:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe Bool
allowAdminCreateUserOnly} -> Maybe Bool
allowAdminCreateUserOnly) (\s :: AdminCreateUserConfigType
s@AdminCreateUserConfigType' {} Maybe Bool
a -> AdminCreateUserConfigType
s {$sel:allowAdminCreateUserOnly:AdminCreateUserConfigType' :: Maybe Bool
allowAdminCreateUserOnly = Maybe Bool
a} :: AdminCreateUserConfigType)

-- | The message template to be used for the welcome message to new users.
--
-- See also
-- <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization Customizing User Invitation Messages>.
adminCreateUserConfigType_inviteMessageTemplate :: Lens.Lens' AdminCreateUserConfigType (Prelude.Maybe MessageTemplateType)
adminCreateUserConfigType_inviteMessageTemplate :: Lens' AdminCreateUserConfigType (Maybe MessageTemplateType)
adminCreateUserConfigType_inviteMessageTemplate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminCreateUserConfigType' {Maybe MessageTemplateType
inviteMessageTemplate :: Maybe MessageTemplateType
$sel:inviteMessageTemplate:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe MessageTemplateType
inviteMessageTemplate} -> Maybe MessageTemplateType
inviteMessageTemplate) (\s :: AdminCreateUserConfigType
s@AdminCreateUserConfigType' {} Maybe MessageTemplateType
a -> AdminCreateUserConfigType
s {$sel:inviteMessageTemplate:AdminCreateUserConfigType' :: Maybe MessageTemplateType
inviteMessageTemplate = Maybe MessageTemplateType
a} :: AdminCreateUserConfigType)

-- | The user account expiration limit, in days, after which a new account
-- that hasn\'t signed in is no longer usable. To reset the account after
-- that time limit, you must call @AdminCreateUser@ again, specifying
-- @\"RESEND\"@ for the @MessageAction@ parameter. The default value for
-- this parameter is 7.
--
-- If you set a value for @TemporaryPasswordValidityDays@ in
-- @PasswordPolicy@, that value will be used, and
-- @UnusedAccountValidityDays@ will be no longer be an available parameter
-- for that user pool.
adminCreateUserConfigType_unusedAccountValidityDays :: Lens.Lens' AdminCreateUserConfigType (Prelude.Maybe Prelude.Natural)
adminCreateUserConfigType_unusedAccountValidityDays :: Lens' AdminCreateUserConfigType (Maybe Natural)
adminCreateUserConfigType_unusedAccountValidityDays = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdminCreateUserConfigType' {Maybe Natural
unusedAccountValidityDays :: Maybe Natural
$sel:unusedAccountValidityDays:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe Natural
unusedAccountValidityDays} -> Maybe Natural
unusedAccountValidityDays) (\s :: AdminCreateUserConfigType
s@AdminCreateUserConfigType' {} Maybe Natural
a -> AdminCreateUserConfigType
s {$sel:unusedAccountValidityDays:AdminCreateUserConfigType' :: Maybe Natural
unusedAccountValidityDays = Maybe Natural
a} :: AdminCreateUserConfigType)

instance Data.FromJSON AdminCreateUserConfigType where
  parseJSON :: Value -> Parser AdminCreateUserConfigType
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AdminCreateUserConfigType"
      ( \Object
x ->
          Maybe Bool
-> Maybe MessageTemplateType
-> Maybe Natural
-> AdminCreateUserConfigType
AdminCreateUserConfigType'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"AllowAdminCreateUserOnly")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"InviteMessageTemplate")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"UnusedAccountValidityDays")
      )

instance Prelude.Hashable AdminCreateUserConfigType where
  hashWithSalt :: Int -> AdminCreateUserConfigType -> Int
hashWithSalt Int
_salt AdminCreateUserConfigType' {Maybe Bool
Maybe Natural
Maybe MessageTemplateType
unusedAccountValidityDays :: Maybe Natural
inviteMessageTemplate :: Maybe MessageTemplateType
allowAdminCreateUserOnly :: Maybe Bool
$sel:unusedAccountValidityDays:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe Natural
$sel:inviteMessageTemplate:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe MessageTemplateType
$sel:allowAdminCreateUserOnly:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
allowAdminCreateUserOnly
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe MessageTemplateType
inviteMessageTemplate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
unusedAccountValidityDays

instance Prelude.NFData AdminCreateUserConfigType where
  rnf :: AdminCreateUserConfigType -> ()
rnf AdminCreateUserConfigType' {Maybe Bool
Maybe Natural
Maybe MessageTemplateType
unusedAccountValidityDays :: Maybe Natural
inviteMessageTemplate :: Maybe MessageTemplateType
allowAdminCreateUserOnly :: Maybe Bool
$sel:unusedAccountValidityDays:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe Natural
$sel:inviteMessageTemplate:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe MessageTemplateType
$sel:allowAdminCreateUserOnly:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
allowAdminCreateUserOnly
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe MessageTemplateType
inviteMessageTemplate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
unusedAccountValidityDays

instance Data.ToJSON AdminCreateUserConfigType where
  toJSON :: AdminCreateUserConfigType -> Value
toJSON AdminCreateUserConfigType' {Maybe Bool
Maybe Natural
Maybe MessageTemplateType
unusedAccountValidityDays :: Maybe Natural
inviteMessageTemplate :: Maybe MessageTemplateType
allowAdminCreateUserOnly :: Maybe Bool
$sel:unusedAccountValidityDays:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe Natural
$sel:inviteMessageTemplate:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe MessageTemplateType
$sel:allowAdminCreateUserOnly:AdminCreateUserConfigType' :: AdminCreateUserConfigType -> Maybe Bool
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AllowAdminCreateUserOnly" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
allowAdminCreateUserOnly,
            (Key
"InviteMessageTemplate" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe MessageTemplateType
inviteMessageTemplate,
            (Key
"UnusedAccountValidityDays" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
unusedAccountValidityDays
          ]
      )