{-# 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.ElastiCache.Types.User
-- 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.ElastiCache.Types.User where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.ElastiCache.Types.Authentication
import qualified Amazonka.Prelude as Prelude

-- | /See:/ 'newUser' smart constructor.
data User = User'
  { -- | The Amazon Resource Name (ARN) of the user.
    User -> Maybe Text
arn :: Prelude.Maybe Prelude.Text,
    -- | Access permissions string used for this user.
    User -> Maybe Text
accessString :: Prelude.Maybe Prelude.Text,
    -- | Denotes whether the user requires a password to authenticate.
    User -> Maybe Authentication
authentication :: Prelude.Maybe Authentication,
    -- | The current supported value is Redis.
    User -> Maybe Text
engine :: Prelude.Maybe Prelude.Text,
    -- | The minimum engine version required, which is Redis 6.0
    User -> Maybe Text
minimumEngineVersion :: Prelude.Maybe Prelude.Text,
    -- | Indicates the user status. Can be \"active\", \"modifying\" or
    -- \"deleting\".
    User -> Maybe Text
status :: Prelude.Maybe Prelude.Text,
    -- | Returns a list of the user group IDs the user belongs to.
    User -> Maybe [Text]
userGroupIds :: Prelude.Maybe [Prelude.Text],
    -- | The ID of the user.
    User -> Maybe Text
userId :: Prelude.Maybe Prelude.Text,
    -- | The username of the user.
    User -> Maybe Text
userName :: Prelude.Maybe Prelude.Text
  }
  deriving (User -> User -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: User -> User -> Bool
$c/= :: User -> User -> Bool
== :: User -> User -> Bool
$c== :: User -> User -> Bool
Prelude.Eq, ReadPrec [User]
ReadPrec User
Int -> ReadS User
ReadS [User]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [User]
$creadListPrec :: ReadPrec [User]
readPrec :: ReadPrec User
$creadPrec :: ReadPrec User
readList :: ReadS [User]
$creadList :: ReadS [User]
readsPrec :: Int -> ReadS User
$creadsPrec :: Int -> ReadS User
Prelude.Read, Int -> User -> ShowS
[User] -> ShowS
User -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [User] -> ShowS
$cshowList :: [User] -> ShowS
show :: User -> String
$cshow :: User -> String
showsPrec :: Int -> User -> ShowS
$cshowsPrec :: Int -> User -> ShowS
Prelude.Show, forall x. Rep User x -> User
forall x. User -> Rep User x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep User x -> User
$cfrom :: forall x. User -> Rep User x
Prelude.Generic)

-- |
-- Create a value of 'User' 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:
--
-- 'arn', 'user_arn' - The Amazon Resource Name (ARN) of the user.
--
-- 'accessString', 'user_accessString' - Access permissions string used for this user.
--
-- 'authentication', 'user_authentication' - Denotes whether the user requires a password to authenticate.
--
-- 'engine', 'user_engine' - The current supported value is Redis.
--
-- 'minimumEngineVersion', 'user_minimumEngineVersion' - The minimum engine version required, which is Redis 6.0
--
-- 'status', 'user_status' - Indicates the user status. Can be \"active\", \"modifying\" or
-- \"deleting\".
--
-- 'userGroupIds', 'user_userGroupIds' - Returns a list of the user group IDs the user belongs to.
--
-- 'userId', 'user_userId' - The ID of the user.
--
-- 'userName', 'user_userName' - The username of the user.
newUser ::
  User
newUser :: User
newUser =
  User'
    { $sel:arn:User' :: Maybe Text
arn = forall a. Maybe a
Prelude.Nothing,
      $sel:accessString:User' :: Maybe Text
accessString = forall a. Maybe a
Prelude.Nothing,
      $sel:authentication:User' :: Maybe Authentication
authentication = forall a. Maybe a
Prelude.Nothing,
      $sel:engine:User' :: Maybe Text
engine = forall a. Maybe a
Prelude.Nothing,
      $sel:minimumEngineVersion:User' :: Maybe Text
minimumEngineVersion = forall a. Maybe a
Prelude.Nothing,
      $sel:status:User' :: Maybe Text
status = forall a. Maybe a
Prelude.Nothing,
      $sel:userGroupIds:User' :: Maybe [Text]
userGroupIds = forall a. Maybe a
Prelude.Nothing,
      $sel:userId:User' :: Maybe Text
userId = forall a. Maybe a
Prelude.Nothing,
      $sel:userName:User' :: Maybe Text
userName = forall a. Maybe a
Prelude.Nothing
    }

-- | The Amazon Resource Name (ARN) of the user.
user_arn :: Lens.Lens' User (Prelude.Maybe Prelude.Text)
user_arn :: Lens' User (Maybe Text)
user_arn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe Text
arn :: Maybe Text
$sel:arn:User' :: User -> Maybe Text
arn} -> Maybe Text
arn) (\s :: User
s@User' {} Maybe Text
a -> User
s {$sel:arn:User' :: Maybe Text
arn = Maybe Text
a} :: User)

-- | Access permissions string used for this user.
user_accessString :: Lens.Lens' User (Prelude.Maybe Prelude.Text)
user_accessString :: Lens' User (Maybe Text)
user_accessString = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe Text
accessString :: Maybe Text
$sel:accessString:User' :: User -> Maybe Text
accessString} -> Maybe Text
accessString) (\s :: User
s@User' {} Maybe Text
a -> User
s {$sel:accessString:User' :: Maybe Text
accessString = Maybe Text
a} :: User)

-- | Denotes whether the user requires a password to authenticate.
user_authentication :: Lens.Lens' User (Prelude.Maybe Authentication)
user_authentication :: Lens' User (Maybe Authentication)
user_authentication = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe Authentication
authentication :: Maybe Authentication
$sel:authentication:User' :: User -> Maybe Authentication
authentication} -> Maybe Authentication
authentication) (\s :: User
s@User' {} Maybe Authentication
a -> User
s {$sel:authentication:User' :: Maybe Authentication
authentication = Maybe Authentication
a} :: User)

-- | The current supported value is Redis.
user_engine :: Lens.Lens' User (Prelude.Maybe Prelude.Text)
user_engine :: Lens' User (Maybe Text)
user_engine = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe Text
engine :: Maybe Text
$sel:engine:User' :: User -> Maybe Text
engine} -> Maybe Text
engine) (\s :: User
s@User' {} Maybe Text
a -> User
s {$sel:engine:User' :: Maybe Text
engine = Maybe Text
a} :: User)

-- | The minimum engine version required, which is Redis 6.0
user_minimumEngineVersion :: Lens.Lens' User (Prelude.Maybe Prelude.Text)
user_minimumEngineVersion :: Lens' User (Maybe Text)
user_minimumEngineVersion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe Text
minimumEngineVersion :: Maybe Text
$sel:minimumEngineVersion:User' :: User -> Maybe Text
minimumEngineVersion} -> Maybe Text
minimumEngineVersion) (\s :: User
s@User' {} Maybe Text
a -> User
s {$sel:minimumEngineVersion:User' :: Maybe Text
minimumEngineVersion = Maybe Text
a} :: User)

-- | Indicates the user status. Can be \"active\", \"modifying\" or
-- \"deleting\".
user_status :: Lens.Lens' User (Prelude.Maybe Prelude.Text)
user_status :: Lens' User (Maybe Text)
user_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe Text
status :: Maybe Text
$sel:status:User' :: User -> Maybe Text
status} -> Maybe Text
status) (\s :: User
s@User' {} Maybe Text
a -> User
s {$sel:status:User' :: Maybe Text
status = Maybe Text
a} :: User)

-- | Returns a list of the user group IDs the user belongs to.
user_userGroupIds :: Lens.Lens' User (Prelude.Maybe [Prelude.Text])
user_userGroupIds :: Lens' User (Maybe [Text])
user_userGroupIds = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe [Text]
userGroupIds :: Maybe [Text]
$sel:userGroupIds:User' :: User -> Maybe [Text]
userGroupIds} -> Maybe [Text]
userGroupIds) (\s :: User
s@User' {} Maybe [Text]
a -> User
s {$sel:userGroupIds:User' :: Maybe [Text]
userGroupIds = Maybe [Text]
a} :: User) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The ID of the user.
user_userId :: Lens.Lens' User (Prelude.Maybe Prelude.Text)
user_userId :: Lens' User (Maybe Text)
user_userId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe Text
userId :: Maybe Text
$sel:userId:User' :: User -> Maybe Text
userId} -> Maybe Text
userId) (\s :: User
s@User' {} Maybe Text
a -> User
s {$sel:userId:User' :: Maybe Text
userId = Maybe Text
a} :: User)

-- | The username of the user.
user_userName :: Lens.Lens' User (Prelude.Maybe Prelude.Text)
user_userName :: Lens' User (Maybe Text)
user_userName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\User' {Maybe Text
userName :: Maybe Text
$sel:userName:User' :: User -> Maybe Text
userName} -> Maybe Text
userName) (\s :: User
s@User' {} Maybe Text
a -> User
s {$sel:userName:User' :: Maybe Text
userName = Maybe Text
a} :: User)

instance Data.FromXML User where
  parseXML :: [Node] -> Either String User
parseXML [Node]
x =
    Maybe Text
-> Maybe Text
-> Maybe Authentication
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe [Text]
-> Maybe Text
-> Maybe Text
-> User
User'
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"ARN")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"AccessString")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Authentication")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Engine")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"MinimumEngineVersion")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"Status")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( [Node]
x
                      forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"UserGroupIds"
                      forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                      forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
Prelude.>>= forall (f :: * -> *) a b.
Applicative f =>
([a] -> f b) -> [a] -> f (Maybe b)
Core.may (forall a. FromXML a => Text -> [Node] -> Either String [a]
Data.parseXMLList Text
"member")
                  )
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"UserId")
      forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ([Node]
x forall a. FromXML a => [Node] -> Text -> Either String (Maybe a)
Data..@? Text
"UserName")

instance Prelude.Hashable User where
  hashWithSalt :: Int -> User -> Int
hashWithSalt Int
_salt User' {Maybe [Text]
Maybe Text
Maybe Authentication
userName :: Maybe Text
userId :: Maybe Text
userGroupIds :: Maybe [Text]
status :: Maybe Text
minimumEngineVersion :: Maybe Text
engine :: Maybe Text
authentication :: Maybe Authentication
accessString :: Maybe Text
arn :: Maybe Text
$sel:userName:User' :: User -> Maybe Text
$sel:userId:User' :: User -> Maybe Text
$sel:userGroupIds:User' :: User -> Maybe [Text]
$sel:status:User' :: User -> Maybe Text
$sel:minimumEngineVersion:User' :: User -> Maybe Text
$sel:engine:User' :: User -> Maybe Text
$sel:authentication:User' :: User -> Maybe Authentication
$sel:accessString:User' :: User -> Maybe Text
$sel:arn:User' :: User -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
arn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
accessString
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Authentication
authentication
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
engine
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
minimumEngineVersion
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
status
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
userGroupIds
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
userId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
userName

instance Prelude.NFData User where
  rnf :: User -> ()
rnf User' {Maybe [Text]
Maybe Text
Maybe Authentication
userName :: Maybe Text
userId :: Maybe Text
userGroupIds :: Maybe [Text]
status :: Maybe Text
minimumEngineVersion :: Maybe Text
engine :: Maybe Text
authentication :: Maybe Authentication
accessString :: Maybe Text
arn :: Maybe Text
$sel:userName:User' :: User -> Maybe Text
$sel:userId:User' :: User -> Maybe Text
$sel:userGroupIds:User' :: User -> Maybe [Text]
$sel:status:User' :: User -> Maybe Text
$sel:minimumEngineVersion:User' :: User -> Maybe Text
$sel:engine:User' :: User -> Maybe Text
$sel:authentication:User' :: User -> Maybe Authentication
$sel:accessString:User' :: User -> Maybe Text
$sel:arn:User' :: User -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
arn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
accessString
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Authentication
authentication
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
engine
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
minimumEngineVersion
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
userGroupIds
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
userId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
userName