Table of Contents

Class GetRandomPasswordRequest

Namespace
Amazon.SecretsManager.Model
Assembly
AWSSDK.SecretsManager.dll

Container for the parameters to the GetRandomPassword operation. 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 

public class GetRandomPasswordRequest : AmazonSecretsManagerRequest
Inheritance
GetRandomPasswordRequest

Constructors

GetRandomPasswordRequest() 

public GetRandomPasswordRequest()

Properties

ExcludeCharacters

Gets and sets the property 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. 

public string ExcludeCharacters { get; set; }

Property Value

string

ExcludeLowercase

Gets and sets the property 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. 

public bool ExcludeLowercase { get; set; }

Property Value

bool

ExcludeNumbers

Gets and sets the property 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. 

public bool ExcludeNumbers { get; set; }

Property Value

bool

ExcludePunctuation

Gets and sets the property 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
: 

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
public bool ExcludePunctuation { get; set; }

Property Value

bool

ExcludeUppercase

Gets and sets the property 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. 

public bool ExcludeUppercase { get; set; }

Property Value

bool

IncludeSpace

Gets and sets the property 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. 

public bool IncludeSpace { get; set; }

Property Value

bool

PasswordLength

Gets and sets the property PasswordLength.

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

public long PasswordLength { get; set; }

Property Value

long

RequireEachIncludedType

Gets and sets the property 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. 
public bool RequireEachIncludedType { get; set; }

Property Value

bool