NAME

Paws::SecretsManager::GetRandomPassword - Arguments for method GetRandomPassword on Paws::SecretsManager

DESCRIPTION

This class represents the parameters used for calling the method GetRandomPassword on the AWS Secrets Manager service. Use the attributes of this class as arguments to method GetRandomPassword.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRandomPassword.

SYNOPSIS

my $secretsmanager = Paws->service('SecretsManager');
# To generate a random password
# The following example shows how to request a randomly generated password. This
# example includes the optional flags to require spaces and at least one
# character of each included type. It specifies a length of 20 characters.
my $GetRandomPasswordResponse = $secretsmanager->GetRandomPassword(
  'IncludeSpace'            => 1,
  'PasswordLength'          => 20,
  'RequireEachIncludedType' => 1
);

# Results:
my $RandomPassword = $GetRandomPasswordResponse->RandomPassword;

# Returns a L<Paws::SecretsManager::GetRandomPasswordResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/GetRandomPassword

ATTRIBUTES

ExcludeCharacters => Str

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.

ExcludeLowercase => Bool

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.

ExcludeNumbers => Bool

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.

ExcludePunctuation => Bool

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:

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

ExcludeUppercase => Bool

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.

IncludeSpace => Bool

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.

PasswordLength => Int

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

RequireEachIncludedType => Bool

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetRandomPassword in Paws::SecretsManager

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues