{-# 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.PasswordPolicyType
-- 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.PasswordPolicyType where

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 password policy type.
--
-- /See:/ 'newPasswordPolicyType' smart constructor.
data PasswordPolicyType = PasswordPolicyType'
  { -- | The minimum length of the password in the policy that you have set. This
    -- value can\'t be less than 6.
    PasswordPolicyType -> Maybe Natural
minimumLength :: Prelude.Maybe Prelude.Natural,
    -- | In the password policy that you have set, refers to whether you have
    -- required users to use at least one lowercase letter in their password.
    PasswordPolicyType -> Maybe Bool
requireLowercase :: Prelude.Maybe Prelude.Bool,
    -- | In the password policy that you have set, refers to whether you have
    -- required users to use at least one number in their password.
    PasswordPolicyType -> Maybe Bool
requireNumbers :: Prelude.Maybe Prelude.Bool,
    -- | In the password policy that you have set, refers to whether you have
    -- required users to use at least one symbol in their password.
    PasswordPolicyType -> Maybe Bool
requireSymbols :: Prelude.Maybe Prelude.Bool,
    -- | In the password policy that you have set, refers to whether you have
    -- required users to use at least one uppercase letter in their password.
    PasswordPolicyType -> Maybe Bool
requireUppercase :: Prelude.Maybe Prelude.Bool,
    -- | The number of days a temporary password is valid in the password policy.
    -- If the user doesn\'t sign in during this time, an administrator must
    -- reset their password.
    --
    -- When you set @TemporaryPasswordValidityDays@ for a user pool, you can no
    -- longer set a value for the legacy @UnusedAccountValidityDays@ parameter
    -- in that user pool.
    PasswordPolicyType -> Maybe Natural
temporaryPasswordValidityDays :: Prelude.Maybe Prelude.Natural
  }
  deriving (PasswordPolicyType -> PasswordPolicyType -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PasswordPolicyType -> PasswordPolicyType -> Bool
$c/= :: PasswordPolicyType -> PasswordPolicyType -> Bool
== :: PasswordPolicyType -> PasswordPolicyType -> Bool
$c== :: PasswordPolicyType -> PasswordPolicyType -> Bool
Prelude.Eq, ReadPrec [PasswordPolicyType]
ReadPrec PasswordPolicyType
Int -> ReadS PasswordPolicyType
ReadS [PasswordPolicyType]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PasswordPolicyType]
$creadListPrec :: ReadPrec [PasswordPolicyType]
readPrec :: ReadPrec PasswordPolicyType
$creadPrec :: ReadPrec PasswordPolicyType
readList :: ReadS [PasswordPolicyType]
$creadList :: ReadS [PasswordPolicyType]
readsPrec :: Int -> ReadS PasswordPolicyType
$creadsPrec :: Int -> ReadS PasswordPolicyType
Prelude.Read, Int -> PasswordPolicyType -> ShowS
[PasswordPolicyType] -> ShowS
PasswordPolicyType -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PasswordPolicyType] -> ShowS
$cshowList :: [PasswordPolicyType] -> ShowS
show :: PasswordPolicyType -> String
$cshow :: PasswordPolicyType -> String
showsPrec :: Int -> PasswordPolicyType -> ShowS
$cshowsPrec :: Int -> PasswordPolicyType -> ShowS
Prelude.Show, forall x. Rep PasswordPolicyType x -> PasswordPolicyType
forall x. PasswordPolicyType -> Rep PasswordPolicyType x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PasswordPolicyType x -> PasswordPolicyType
$cfrom :: forall x. PasswordPolicyType -> Rep PasswordPolicyType x
Prelude.Generic)

-- |
-- Create a value of 'PasswordPolicyType' 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:
--
-- 'minimumLength', 'passwordPolicyType_minimumLength' - The minimum length of the password in the policy that you have set. This
-- value can\'t be less than 6.
--
-- 'requireLowercase', 'passwordPolicyType_requireLowercase' - In the password policy that you have set, refers to whether you have
-- required users to use at least one lowercase letter in their password.
--
-- 'requireNumbers', 'passwordPolicyType_requireNumbers' - In the password policy that you have set, refers to whether you have
-- required users to use at least one number in their password.
--
-- 'requireSymbols', 'passwordPolicyType_requireSymbols' - In the password policy that you have set, refers to whether you have
-- required users to use at least one symbol in their password.
--
-- 'requireUppercase', 'passwordPolicyType_requireUppercase' - In the password policy that you have set, refers to whether you have
-- required users to use at least one uppercase letter in their password.
--
-- 'temporaryPasswordValidityDays', 'passwordPolicyType_temporaryPasswordValidityDays' - The number of days a temporary password is valid in the password policy.
-- If the user doesn\'t sign in during this time, an administrator must
-- reset their password.
--
-- When you set @TemporaryPasswordValidityDays@ for a user pool, you can no
-- longer set a value for the legacy @UnusedAccountValidityDays@ parameter
-- in that user pool.
newPasswordPolicyType ::
  PasswordPolicyType
newPasswordPolicyType :: PasswordPolicyType
newPasswordPolicyType =
  PasswordPolicyType'
    { $sel:minimumLength:PasswordPolicyType' :: Maybe Natural
minimumLength =
        forall a. Maybe a
Prelude.Nothing,
      $sel:requireLowercase:PasswordPolicyType' :: Maybe Bool
requireLowercase = forall a. Maybe a
Prelude.Nothing,
      $sel:requireNumbers:PasswordPolicyType' :: Maybe Bool
requireNumbers = forall a. Maybe a
Prelude.Nothing,
      $sel:requireSymbols:PasswordPolicyType' :: Maybe Bool
requireSymbols = forall a. Maybe a
Prelude.Nothing,
      $sel:requireUppercase:PasswordPolicyType' :: Maybe Bool
requireUppercase = forall a. Maybe a
Prelude.Nothing,
      $sel:temporaryPasswordValidityDays:PasswordPolicyType' :: Maybe Natural
temporaryPasswordValidityDays = forall a. Maybe a
Prelude.Nothing
    }

-- | The minimum length of the password in the policy that you have set. This
-- value can\'t be less than 6.
passwordPolicyType_minimumLength :: Lens.Lens' PasswordPolicyType (Prelude.Maybe Prelude.Natural)
passwordPolicyType_minimumLength :: Lens' PasswordPolicyType (Maybe Natural)
passwordPolicyType_minimumLength = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PasswordPolicyType' {Maybe Natural
minimumLength :: Maybe Natural
$sel:minimumLength:PasswordPolicyType' :: PasswordPolicyType -> Maybe Natural
minimumLength} -> Maybe Natural
minimumLength) (\s :: PasswordPolicyType
s@PasswordPolicyType' {} Maybe Natural
a -> PasswordPolicyType
s {$sel:minimumLength:PasswordPolicyType' :: Maybe Natural
minimumLength = Maybe Natural
a} :: PasswordPolicyType)

-- | In the password policy that you have set, refers to whether you have
-- required users to use at least one lowercase letter in their password.
passwordPolicyType_requireLowercase :: Lens.Lens' PasswordPolicyType (Prelude.Maybe Prelude.Bool)
passwordPolicyType_requireLowercase :: Lens' PasswordPolicyType (Maybe Bool)
passwordPolicyType_requireLowercase = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PasswordPolicyType' {Maybe Bool
requireLowercase :: Maybe Bool
$sel:requireLowercase:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
requireLowercase} -> Maybe Bool
requireLowercase) (\s :: PasswordPolicyType
s@PasswordPolicyType' {} Maybe Bool
a -> PasswordPolicyType
s {$sel:requireLowercase:PasswordPolicyType' :: Maybe Bool
requireLowercase = Maybe Bool
a} :: PasswordPolicyType)

-- | In the password policy that you have set, refers to whether you have
-- required users to use at least one number in their password.
passwordPolicyType_requireNumbers :: Lens.Lens' PasswordPolicyType (Prelude.Maybe Prelude.Bool)
passwordPolicyType_requireNumbers :: Lens' PasswordPolicyType (Maybe Bool)
passwordPolicyType_requireNumbers = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PasswordPolicyType' {Maybe Bool
requireNumbers :: Maybe Bool
$sel:requireNumbers:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
requireNumbers} -> Maybe Bool
requireNumbers) (\s :: PasswordPolicyType
s@PasswordPolicyType' {} Maybe Bool
a -> PasswordPolicyType
s {$sel:requireNumbers:PasswordPolicyType' :: Maybe Bool
requireNumbers = Maybe Bool
a} :: PasswordPolicyType)

-- | In the password policy that you have set, refers to whether you have
-- required users to use at least one symbol in their password.
passwordPolicyType_requireSymbols :: Lens.Lens' PasswordPolicyType (Prelude.Maybe Prelude.Bool)
passwordPolicyType_requireSymbols :: Lens' PasswordPolicyType (Maybe Bool)
passwordPolicyType_requireSymbols = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PasswordPolicyType' {Maybe Bool
requireSymbols :: Maybe Bool
$sel:requireSymbols:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
requireSymbols} -> Maybe Bool
requireSymbols) (\s :: PasswordPolicyType
s@PasswordPolicyType' {} Maybe Bool
a -> PasswordPolicyType
s {$sel:requireSymbols:PasswordPolicyType' :: Maybe Bool
requireSymbols = Maybe Bool
a} :: PasswordPolicyType)

-- | In the password policy that you have set, refers to whether you have
-- required users to use at least one uppercase letter in their password.
passwordPolicyType_requireUppercase :: Lens.Lens' PasswordPolicyType (Prelude.Maybe Prelude.Bool)
passwordPolicyType_requireUppercase :: Lens' PasswordPolicyType (Maybe Bool)
passwordPolicyType_requireUppercase = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PasswordPolicyType' {Maybe Bool
requireUppercase :: Maybe Bool
$sel:requireUppercase:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
requireUppercase} -> Maybe Bool
requireUppercase) (\s :: PasswordPolicyType
s@PasswordPolicyType' {} Maybe Bool
a -> PasswordPolicyType
s {$sel:requireUppercase:PasswordPolicyType' :: Maybe Bool
requireUppercase = Maybe Bool
a} :: PasswordPolicyType)

-- | The number of days a temporary password is valid in the password policy.
-- If the user doesn\'t sign in during this time, an administrator must
-- reset their password.
--
-- When you set @TemporaryPasswordValidityDays@ for a user pool, you can no
-- longer set a value for the legacy @UnusedAccountValidityDays@ parameter
-- in that user pool.
passwordPolicyType_temporaryPasswordValidityDays :: Lens.Lens' PasswordPolicyType (Prelude.Maybe Prelude.Natural)
passwordPolicyType_temporaryPasswordValidityDays :: Lens' PasswordPolicyType (Maybe Natural)
passwordPolicyType_temporaryPasswordValidityDays = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PasswordPolicyType' {Maybe Natural
temporaryPasswordValidityDays :: Maybe Natural
$sel:temporaryPasswordValidityDays:PasswordPolicyType' :: PasswordPolicyType -> Maybe Natural
temporaryPasswordValidityDays} -> Maybe Natural
temporaryPasswordValidityDays) (\s :: PasswordPolicyType
s@PasswordPolicyType' {} Maybe Natural
a -> PasswordPolicyType
s {$sel:temporaryPasswordValidityDays:PasswordPolicyType' :: Maybe Natural
temporaryPasswordValidityDays = Maybe Natural
a} :: PasswordPolicyType)

instance Data.FromJSON PasswordPolicyType where
  parseJSON :: Value -> Parser PasswordPolicyType
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PasswordPolicyType"
      ( \Object
x ->
          Maybe Natural
-> Maybe Bool
-> Maybe Bool
-> Maybe Bool
-> Maybe Bool
-> Maybe Natural
-> PasswordPolicyType
PasswordPolicyType'
            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
"MinimumLength")
            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
"RequireLowercase")
            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
"RequireNumbers")
            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
"RequireSymbols")
            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
"RequireUppercase")
            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
"TemporaryPasswordValidityDays")
      )

instance Prelude.Hashable PasswordPolicyType where
  hashWithSalt :: Int -> PasswordPolicyType -> Int
hashWithSalt Int
_salt PasswordPolicyType' {Maybe Bool
Maybe Natural
temporaryPasswordValidityDays :: Maybe Natural
requireUppercase :: Maybe Bool
requireSymbols :: Maybe Bool
requireNumbers :: Maybe Bool
requireLowercase :: Maybe Bool
minimumLength :: Maybe Natural
$sel:temporaryPasswordValidityDays:PasswordPolicyType' :: PasswordPolicyType -> Maybe Natural
$sel:requireUppercase:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireSymbols:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireNumbers:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireLowercase:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:minimumLength:PasswordPolicyType' :: PasswordPolicyType -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
minimumLength
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
requireLowercase
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
requireNumbers
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
requireSymbols
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
requireUppercase
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
temporaryPasswordValidityDays

instance Prelude.NFData PasswordPolicyType where
  rnf :: PasswordPolicyType -> ()
rnf PasswordPolicyType' {Maybe Bool
Maybe Natural
temporaryPasswordValidityDays :: Maybe Natural
requireUppercase :: Maybe Bool
requireSymbols :: Maybe Bool
requireNumbers :: Maybe Bool
requireLowercase :: Maybe Bool
minimumLength :: Maybe Natural
$sel:temporaryPasswordValidityDays:PasswordPolicyType' :: PasswordPolicyType -> Maybe Natural
$sel:requireUppercase:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireSymbols:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireNumbers:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireLowercase:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:minimumLength:PasswordPolicyType' :: PasswordPolicyType -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
minimumLength
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
requireLowercase
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
requireNumbers
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
requireSymbols
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
requireUppercase
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
temporaryPasswordValidityDays

instance Data.ToJSON PasswordPolicyType where
  toJSON :: PasswordPolicyType -> Value
toJSON PasswordPolicyType' {Maybe Bool
Maybe Natural
temporaryPasswordValidityDays :: Maybe Natural
requireUppercase :: Maybe Bool
requireSymbols :: Maybe Bool
requireNumbers :: Maybe Bool
requireLowercase :: Maybe Bool
minimumLength :: Maybe Natural
$sel:temporaryPasswordValidityDays:PasswordPolicyType' :: PasswordPolicyType -> Maybe Natural
$sel:requireUppercase:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireSymbols:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireNumbers:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:requireLowercase:PasswordPolicyType' :: PasswordPolicyType -> Maybe Bool
$sel:minimumLength:PasswordPolicyType' :: PasswordPolicyType -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"MinimumLength" 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
minimumLength,
            (Key
"RequireLowercase" 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
requireLowercase,
            (Key
"RequireNumbers" 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
requireNumbers,
            (Key
"RequireSymbols" 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
requireSymbols,
            (Key
"RequireUppercase" 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
requireUppercase,
            (Key
"TemporaryPasswordValidityDays" 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
temporaryPasswordValidityDays
          ]
      )