| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.SecretsManager.GetRandomPassword
Description
Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
Minimum permissions
To run this command, you must have the following permissions:
- secretsmanager:GetRandomPassword
Synopsis
- data GetRandomPassword = GetRandomPassword' {}
- newGetRandomPassword :: GetRandomPassword
- getRandomPassword_includeSpace :: Lens' GetRandomPassword (Maybe Bool)
- getRandomPassword_excludeNumbers :: Lens' GetRandomPassword (Maybe Bool)
- getRandomPassword_excludeLowercase :: Lens' GetRandomPassword (Maybe Bool)
- getRandomPassword_excludeCharacters :: Lens' GetRandomPassword (Maybe Text)
- getRandomPassword_excludePunctuation :: Lens' GetRandomPassword (Maybe Bool)
- getRandomPassword_requireEachIncludedType :: Lens' GetRandomPassword (Maybe Bool)
- getRandomPassword_excludeUppercase :: Lens' GetRandomPassword (Maybe Bool)
- getRandomPassword_passwordLength :: Lens' GetRandomPassword (Maybe Natural)
- data GetRandomPasswordResponse = GetRandomPasswordResponse' {
- randomPassword :: Maybe (Sensitive Text)
- httpStatus :: Int
- newGetRandomPasswordResponse :: Int -> GetRandomPasswordResponse
- getRandomPasswordResponse_randomPassword :: Lens' GetRandomPasswordResponse (Maybe Text)
- getRandomPasswordResponse_httpStatus :: Lens' GetRandomPasswordResponse Int
Creating a Request
data GetRandomPassword Source #
See: newGetRandomPassword smart constructor.
Constructors
| GetRandomPassword' | |
Fields
| |
Instances
newGetRandomPassword :: GetRandomPassword Source #
Create a value of GetRandomPassword 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:includeSpace:GetRandomPassword', getRandomPassword_includeSpace - Specifies that the generated password can include the space character.
The default if you do not include this switch parameter is that the
space character is not included.
$sel:excludeNumbers:GetRandomPassword', getRandomPassword_excludeNumbers - Specifies that the generated password should not include digits. The
default if you do not include this switch parameter is that digits can
be included.
$sel:excludeLowercase:GetRandomPassword', getRandomPassword_excludeLowercase - Specifies that the generated password should not include lowercase
letters. The default if you do not include this switch parameter is that
lowercase letters can be included.
$sel:excludeCharacters:GetRandomPassword', getRandomPassword_excludeCharacters - A string that includes characters that should not be included in the
generated password. The default is that all characters from the included
sets can be used.
$sel:excludePunctuation:GetRandomPassword', getRandomPassword_excludePunctuation - Specifies that the generated password should not include punctuation
characters. The default if you do not include this switch parameter is
that punctuation characters can be included.
The following are the punctuation characters that can be included in
the generated password if you don't explicitly exclude them with
ExcludeCharacters or ExcludePunctuation:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~$sel:requireEachIncludedType:GetRandomPassword', getRandomPassword_requireEachIncludedType - A boolean value that specifies whether the generated password must
include at least one of every allowed character type. The default value
is True and the operation requires at least one of every character
type.
$sel:excludeUppercase:GetRandomPassword', getRandomPassword_excludeUppercase - Specifies that the generated password should not include uppercase
letters. The default if you do not include this switch parameter is that
uppercase letters can be included.
$sel:passwordLength:GetRandomPassword', getRandomPassword_passwordLength - The desired length of the generated password. The default value if you
do not include this parameter is 32 characters.
Request Lenses
getRandomPassword_includeSpace :: Lens' GetRandomPassword (Maybe Bool) Source #
Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
getRandomPassword_excludeNumbers :: Lens' GetRandomPassword (Maybe Bool) Source #
Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
getRandomPassword_excludeLowercase :: Lens' GetRandomPassword (Maybe Bool) Source #
Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
getRandomPassword_excludeCharacters :: Lens' GetRandomPassword (Maybe Text) Source #
A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
getRandomPassword_excludePunctuation :: Lens' GetRandomPassword (Maybe Bool) Source #
Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in
the generated password if you don't explicitly exclude them with
ExcludeCharacters or ExcludePunctuation:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~getRandomPassword_requireEachIncludedType :: Lens' GetRandomPassword (Maybe Bool) Source #
A boolean value that specifies whether the generated password must
include at least one of every allowed character type. The default value
is True and the operation requires at least one of every character
type.
getRandomPassword_excludeUppercase :: Lens' GetRandomPassword (Maybe Bool) Source #
Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
getRandomPassword_passwordLength :: Lens' GetRandomPassword (Maybe Natural) Source #
The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
Destructuring the Response
data GetRandomPasswordResponse Source #
See: newGetRandomPasswordResponse smart constructor.
Constructors
| GetRandomPasswordResponse' | |
Fields
| |
Instances
newGetRandomPasswordResponse Source #
Create a value of GetRandomPasswordResponse 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:randomPassword:GetRandomPasswordResponse', getRandomPasswordResponse_randomPassword - A string with the generated password.
$sel:httpStatus:GetRandomPasswordResponse', getRandomPasswordResponse_httpStatus - The response's http status code.
Response Lenses
getRandomPasswordResponse_randomPassword :: Lens' GetRandomPasswordResponse (Maybe Text) Source #
A string with the generated password.
getRandomPasswordResponse_httpStatus :: Lens' GetRandomPasswordResponse Int Source #
The response's http status code.