{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# 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.CreateUser
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- For Redis engine version 6.0 onwards: Creates a Redis user. For more
-- information, see
-- <http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html Using Role Based Access Control (RBAC)>.
module Amazonka.ElastiCache.CreateUser
  ( -- * Creating a Request
    CreateUser (..),
    newCreateUser,

    -- * Request Lenses
    createUser_authenticationMode,
    createUser_noPasswordRequired,
    createUser_passwords,
    createUser_tags,
    createUser_userId,
    createUser_userName,
    createUser_engine,
    createUser_accessString,

    -- * Destructuring the Response
    User (..),
    newUser,

    -- * Response Lenses
    user_arn,
    user_accessString,
    user_authentication,
    user_engine,
    user_minimumEngineVersion,
    user_status,
    user_userGroupIds,
    user_userId,
    user_userName,
  )
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
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newCreateUser' smart constructor.
data CreateUser = CreateUser'
  { -- | Specifies how to authenticate the user.
    CreateUser -> Maybe AuthenticationMode
authenticationMode :: Prelude.Maybe AuthenticationMode,
    -- | Indicates a password is not required for this user.
    CreateUser -> Maybe Bool
noPasswordRequired :: Prelude.Maybe Prelude.Bool,
    -- | Passwords used for this user. You can create up to two passwords for
    -- each user.
    CreateUser -> Maybe (NonEmpty Text)
passwords :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text),
    -- | A list of tags to be added to this resource. A tag is a key-value pair.
    -- A tag key must be accompanied by a tag value, although null is accepted.
    CreateUser -> Maybe [Tag]
tags :: Prelude.Maybe [Tag],
    -- | The ID of the user.
    CreateUser -> Text
userId :: Prelude.Text,
    -- | The username of the user.
    CreateUser -> Text
userName :: Prelude.Text,
    -- | The current supported value is Redis.
    CreateUser -> Text
engine :: Prelude.Text,
    -- | Access permissions string used for this user.
    CreateUser -> Text
accessString :: Prelude.Text
  }
  deriving (CreateUser -> CreateUser -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CreateUser -> CreateUser -> Bool
$c/= :: CreateUser -> CreateUser -> Bool
== :: CreateUser -> CreateUser -> Bool
$c== :: CreateUser -> CreateUser -> Bool
Prelude.Eq, ReadPrec [CreateUser]
ReadPrec CreateUser
Int -> ReadS CreateUser
ReadS [CreateUser]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CreateUser]
$creadListPrec :: ReadPrec [CreateUser]
readPrec :: ReadPrec CreateUser
$creadPrec :: ReadPrec CreateUser
readList :: ReadS [CreateUser]
$creadList :: ReadS [CreateUser]
readsPrec :: Int -> ReadS CreateUser
$creadsPrec :: Int -> ReadS CreateUser
Prelude.Read, Int -> CreateUser -> ShowS
[CreateUser] -> ShowS
CreateUser -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CreateUser] -> ShowS
$cshowList :: [CreateUser] -> ShowS
show :: CreateUser -> String
$cshow :: CreateUser -> String
showsPrec :: Int -> CreateUser -> ShowS
$cshowsPrec :: Int -> CreateUser -> ShowS
Prelude.Show, forall x. Rep CreateUser x -> CreateUser
forall x. CreateUser -> Rep CreateUser x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CreateUser x -> CreateUser
$cfrom :: forall x. CreateUser -> Rep CreateUser x
Prelude.Generic)

-- |
-- Create a value of 'CreateUser' 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:
--
-- 'authenticationMode', 'createUser_authenticationMode' - Specifies how to authenticate the user.
--
-- 'noPasswordRequired', 'createUser_noPasswordRequired' - Indicates a password is not required for this user.
--
-- 'passwords', 'createUser_passwords' - Passwords used for this user. You can create up to two passwords for
-- each user.
--
-- 'tags', 'createUser_tags' - A list of tags to be added to this resource. A tag is a key-value pair.
-- A tag key must be accompanied by a tag value, although null is accepted.
--
-- 'userId', 'createUser_userId' - The ID of the user.
--
-- 'userName', 'createUser_userName' - The username of the user.
--
-- 'engine', 'createUser_engine' - The current supported value is Redis.
--
-- 'accessString', 'createUser_accessString' - Access permissions string used for this user.
newCreateUser ::
  -- | 'userId'
  Prelude.Text ->
  -- | 'userName'
  Prelude.Text ->
  -- | 'engine'
  Prelude.Text ->
  -- | 'accessString'
  Prelude.Text ->
  CreateUser
newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
newCreateUser
  Text
pUserId_
  Text
pUserName_
  Text
pEngine_
  Text
pAccessString_ =
    CreateUser'
      { $sel:authenticationMode:CreateUser' :: Maybe AuthenticationMode
authenticationMode = forall a. Maybe a
Prelude.Nothing,
        $sel:noPasswordRequired:CreateUser' :: Maybe Bool
noPasswordRequired = forall a. Maybe a
Prelude.Nothing,
        $sel:passwords:CreateUser' :: Maybe (NonEmpty Text)
passwords = forall a. Maybe a
Prelude.Nothing,
        $sel:tags:CreateUser' :: Maybe [Tag]
tags = forall a. Maybe a
Prelude.Nothing,
        $sel:userId:CreateUser' :: Text
userId = Text
pUserId_,
        $sel:userName:CreateUser' :: Text
userName = Text
pUserName_,
        $sel:engine:CreateUser' :: Text
engine = Text
pEngine_,
        $sel:accessString:CreateUser' :: Text
accessString = Text
pAccessString_
      }

-- | Specifies how to authenticate the user.
createUser_authenticationMode :: Lens.Lens' CreateUser (Prelude.Maybe AuthenticationMode)
createUser_authenticationMode :: Lens' CreateUser (Maybe AuthenticationMode)
createUser_authenticationMode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateUser' {Maybe AuthenticationMode
authenticationMode :: Maybe AuthenticationMode
$sel:authenticationMode:CreateUser' :: CreateUser -> Maybe AuthenticationMode
authenticationMode} -> Maybe AuthenticationMode
authenticationMode) (\s :: CreateUser
s@CreateUser' {} Maybe AuthenticationMode
a -> CreateUser
s {$sel:authenticationMode:CreateUser' :: Maybe AuthenticationMode
authenticationMode = Maybe AuthenticationMode
a} :: CreateUser)

-- | Indicates a password is not required for this user.
createUser_noPasswordRequired :: Lens.Lens' CreateUser (Prelude.Maybe Prelude.Bool)
createUser_noPasswordRequired :: Lens' CreateUser (Maybe Bool)
createUser_noPasswordRequired = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateUser' {Maybe Bool
noPasswordRequired :: Maybe Bool
$sel:noPasswordRequired:CreateUser' :: CreateUser -> Maybe Bool
noPasswordRequired} -> Maybe Bool
noPasswordRequired) (\s :: CreateUser
s@CreateUser' {} Maybe Bool
a -> CreateUser
s {$sel:noPasswordRequired:CreateUser' :: Maybe Bool
noPasswordRequired = Maybe Bool
a} :: CreateUser)

-- | Passwords used for this user. You can create up to two passwords for
-- each user.
createUser_passwords :: Lens.Lens' CreateUser (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
createUser_passwords :: Lens' CreateUser (Maybe (NonEmpty Text))
createUser_passwords = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateUser' {Maybe (NonEmpty Text)
passwords :: Maybe (NonEmpty Text)
$sel:passwords:CreateUser' :: CreateUser -> Maybe (NonEmpty Text)
passwords} -> Maybe (NonEmpty Text)
passwords) (\s :: CreateUser
s@CreateUser' {} Maybe (NonEmpty Text)
a -> CreateUser
s {$sel:passwords:CreateUser' :: Maybe (NonEmpty Text)
passwords = Maybe (NonEmpty Text)
a} :: CreateUser) 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

-- | A list of tags to be added to this resource. A tag is a key-value pair.
-- A tag key must be accompanied by a tag value, although null is accepted.
createUser_tags :: Lens.Lens' CreateUser (Prelude.Maybe [Tag])
createUser_tags :: Lens' CreateUser (Maybe [Tag])
createUser_tags = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateUser' {Maybe [Tag]
tags :: Maybe [Tag]
$sel:tags:CreateUser' :: CreateUser -> Maybe [Tag]
tags} -> Maybe [Tag]
tags) (\s :: CreateUser
s@CreateUser' {} Maybe [Tag]
a -> CreateUser
s {$sel:tags:CreateUser' :: Maybe [Tag]
tags = Maybe [Tag]
a} :: CreateUser) 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.
createUser_userId :: Lens.Lens' CreateUser Prelude.Text
createUser_userId :: Lens' CreateUser Text
createUser_userId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateUser' {Text
userId :: Text
$sel:userId:CreateUser' :: CreateUser -> Text
userId} -> Text
userId) (\s :: CreateUser
s@CreateUser' {} Text
a -> CreateUser
s {$sel:userId:CreateUser' :: Text
userId = Text
a} :: CreateUser)

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

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

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

instance Core.AWSRequest CreateUser where
  type AWSResponse CreateUser = User
  request :: (Service -> Service) -> CreateUser -> Request CreateUser
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.postQuery (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy CreateUser
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse CreateUser)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
Text
-> (Int
    -> ResponseHeaders -> [Node] -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveXMLWrapper
      Text
"CreateUserResult"
      (\Int
s ResponseHeaders
h [Node]
x -> forall a. FromXML a => [Node] -> Either String a
Data.parseXML [Node]
x)

instance Prelude.Hashable CreateUser where
  hashWithSalt :: Int -> CreateUser -> Int
hashWithSalt Int
_salt CreateUser' {Maybe Bool
Maybe [Tag]
Maybe (NonEmpty Text)
Maybe AuthenticationMode
Text
accessString :: Text
engine :: Text
userName :: Text
userId :: Text
tags :: Maybe [Tag]
passwords :: Maybe (NonEmpty Text)
noPasswordRequired :: Maybe Bool
authenticationMode :: Maybe AuthenticationMode
$sel:accessString:CreateUser' :: CreateUser -> Text
$sel:engine:CreateUser' :: CreateUser -> Text
$sel:userName:CreateUser' :: CreateUser -> Text
$sel:userId:CreateUser' :: CreateUser -> Text
$sel:tags:CreateUser' :: CreateUser -> Maybe [Tag]
$sel:passwords:CreateUser' :: CreateUser -> Maybe (NonEmpty Text)
$sel:noPasswordRequired:CreateUser' :: CreateUser -> Maybe Bool
$sel:authenticationMode:CreateUser' :: CreateUser -> Maybe AuthenticationMode
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe AuthenticationMode
authenticationMode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
noPasswordRequired
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty Text)
passwords
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Tag]
tags
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
userId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
userName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
engine
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
accessString

instance Prelude.NFData CreateUser where
  rnf :: CreateUser -> ()
rnf CreateUser' {Maybe Bool
Maybe [Tag]
Maybe (NonEmpty Text)
Maybe AuthenticationMode
Text
accessString :: Text
engine :: Text
userName :: Text
userId :: Text
tags :: Maybe [Tag]
passwords :: Maybe (NonEmpty Text)
noPasswordRequired :: Maybe Bool
authenticationMode :: Maybe AuthenticationMode
$sel:accessString:CreateUser' :: CreateUser -> Text
$sel:engine:CreateUser' :: CreateUser -> Text
$sel:userName:CreateUser' :: CreateUser -> Text
$sel:userId:CreateUser' :: CreateUser -> Text
$sel:tags:CreateUser' :: CreateUser -> Maybe [Tag]
$sel:passwords:CreateUser' :: CreateUser -> Maybe (NonEmpty Text)
$sel:noPasswordRequired:CreateUser' :: CreateUser -> Maybe Bool
$sel:authenticationMode:CreateUser' :: CreateUser -> Maybe AuthenticationMode
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe AuthenticationMode
authenticationMode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
noPasswordRequired
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty Text)
passwords
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Tag]
tags
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
userId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
userName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
engine
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
accessString

instance Data.ToHeaders CreateUser where
  toHeaders :: CreateUser -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToPath CreateUser where
  toPath :: CreateUser -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery CreateUser where
  toQuery :: CreateUser -> QueryString
toQuery CreateUser' {Maybe Bool
Maybe [Tag]
Maybe (NonEmpty Text)
Maybe AuthenticationMode
Text
accessString :: Text
engine :: Text
userName :: Text
userId :: Text
tags :: Maybe [Tag]
passwords :: Maybe (NonEmpty Text)
noPasswordRequired :: Maybe Bool
authenticationMode :: Maybe AuthenticationMode
$sel:accessString:CreateUser' :: CreateUser -> Text
$sel:engine:CreateUser' :: CreateUser -> Text
$sel:userName:CreateUser' :: CreateUser -> Text
$sel:userId:CreateUser' :: CreateUser -> Text
$sel:tags:CreateUser' :: CreateUser -> Maybe [Tag]
$sel:passwords:CreateUser' :: CreateUser -> Maybe (NonEmpty Text)
$sel:noPasswordRequired:CreateUser' :: CreateUser -> Maybe Bool
$sel:authenticationMode:CreateUser' :: CreateUser -> Maybe AuthenticationMode
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Action"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"CreateUser" :: Prelude.ByteString),
        ByteString
"Version"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: (ByteString
"2015-02-02" :: Prelude.ByteString),
        ByteString
"AuthenticationMode" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe AuthenticationMode
authenticationMode,
        ByteString
"NoPasswordRequired" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Bool
noPasswordRequired,
        ByteString
"Passwords"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            (forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"member" forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty Text)
passwords),
        ByteString
"Tags"
          forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: forall a. ToQuery a => a -> QueryString
Data.toQuery
            (forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Data.toQueryList ByteString
"Tag" forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Tag]
tags),
        ByteString
"UserId" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
userId,
        ByteString
"UserName" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
userName,
        ByteString
"Engine" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
engine,
        ByteString
"AccessString" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Text
accessString
      ]