amazonka-secretsmanager-1.6.1: Amazon Secrets Manager SDK.

Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

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:

Synopsis

# Creating a Request

Creates a value of GetRandomPassword with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• grpIncludeSpace - 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.
• grpExcludeNumbers - 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.
• grpExcludeLowercase - 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.
• grpExcludeCharacters - 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.
• grpExcludePunctuation - 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.
• grpRequireEachIncludedType - 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.
• grpExcludeUppercase - 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.
• grpPasswordLength - The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

See: getRandomPassword smart constructor.

Instances

# Request Lenses

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.

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.

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.

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.

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.

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.

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.

The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

# Destructuring the Response

Arguments

 :: Int grprsResponseStatus -> GetRandomPasswordResponse

Creates a value of GetRandomPasswordResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• grprsRandomPassword - A string with the generated password.
• grprsResponseStatus - -- | The response status code.

See: getRandomPasswordResponse smart constructor.

Instances