| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ElastiCache.CreateUser
Description
For Redis engine version 6.0 onwards: Creates a Redis user. For more information, see Using Role Based Access Control (RBAC).
Synopsis
- data CreateUser = CreateUser' {}
- newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
- createUser_authenticationMode :: Lens' CreateUser (Maybe AuthenticationMode)
- createUser_noPasswordRequired :: Lens' CreateUser (Maybe Bool)
- createUser_passwords :: Lens' CreateUser (Maybe (NonEmpty Text))
- createUser_tags :: Lens' CreateUser (Maybe [Tag])
- createUser_userId :: Lens' CreateUser Text
- createUser_userName :: Lens' CreateUser Text
- createUser_engine :: Lens' CreateUser Text
- createUser_accessString :: Lens' CreateUser Text
- data User = User' {}
- newUser :: User
- user_arn :: Lens' User (Maybe Text)
- user_accessString :: Lens' User (Maybe Text)
- user_authentication :: Lens' User (Maybe Authentication)
- user_engine :: Lens' User (Maybe Text)
- user_minimumEngineVersion :: Lens' User (Maybe Text)
- user_status :: Lens' User (Maybe Text)
- user_userGroupIds :: Lens' User (Maybe [Text])
- user_userId :: Lens' User (Maybe Text)
- user_userName :: Lens' User (Maybe Text)
Creating a Request
data CreateUser Source #
See: newCreateUser smart constructor.
Constructors
| CreateUser' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> CreateUser |
Create a value of CreateUser 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:authenticationMode:CreateUser', createUser_authenticationMode - Specifies how to authenticate the user.
$sel:noPasswordRequired:CreateUser', createUser_noPasswordRequired - Indicates a password is not required for this user.
CreateUser, createUser_passwords - Passwords used for this user. You can create up to two passwords for
each user.
$sel:tags:CreateUser', 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.
CreateUser, createUser_userId - The ID of the user.
CreateUser, createUser_userName - The username of the user.
CreateUser, createUser_engine - The current supported value is Redis.
CreateUser, createUser_accessString - Access permissions string used for this user.
Request Lenses
createUser_authenticationMode :: Lens' CreateUser (Maybe AuthenticationMode) Source #
Specifies how to authenticate the user.
createUser_noPasswordRequired :: Lens' CreateUser (Maybe Bool) Source #
Indicates a password is not required for this user.
createUser_passwords :: Lens' CreateUser (Maybe (NonEmpty Text)) Source #
Passwords used for this user. You can create up to two passwords for each user.
createUser_tags :: Lens' CreateUser (Maybe [Tag]) Source #
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_userId :: Lens' CreateUser Text Source #
The ID of the user.
createUser_userName :: Lens' CreateUser Text Source #
The username of the user.
createUser_engine :: Lens' CreateUser Text Source #
The current supported value is Redis.
createUser_accessString :: Lens' CreateUser Text Source #
Access permissions string used for this user.
Destructuring the Response
See: newUser smart constructor.
Constructors
| User' | |
Fields
| |
Instances
Create a value of User 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:arn:User', user_arn - The Amazon Resource Name (ARN) of the user.
$sel:accessString:User', user_accessString - Access permissions string used for this user.
$sel:authentication:User', user_authentication - Denotes whether the user requires a password to authenticate.
$sel:engine:User', user_engine - The current supported value is Redis.
$sel:minimumEngineVersion:User', user_minimumEngineVersion - The minimum engine version required, which is Redis 6.0
$sel:status:User', user_status - Indicates the user status. Can be "active", "modifying" or
"deleting".
$sel:userGroupIds:User', user_userGroupIds - Returns a list of the user group IDs the user belongs to.
$sel:userId:User', user_userId - The ID of the user.
$sel:userName:User', user_userName - The username of the user.
Response Lenses
user_authentication :: Lens' User (Maybe Authentication) Source #
Denotes whether the user requires a password to authenticate.
user_minimumEngineVersion :: Lens' User (Maybe Text) Source #
The minimum engine version required, which is Redis 6.0
user_status :: Lens' User (Maybe Text) Source #
Indicates the user status. Can be "active", "modifying" or "deleting".