« blib/lib/Paws/SecretsManager/Filter.pm
↑ Summary
blib/lib/Paws/SecretsManager/GetRandomPasswordResponse.pm »
| 1 | |||
| 2 | package Paws::SecretsManager::GetRandomPassword; | ||
| 3 | use Moose; | ||
| 4 | has ExcludeCharacters => (is => 'ro', isa => 'Str'); | ||
| 5 | has ExcludeLowercase => (is => 'ro', isa => 'Bool'); | ||
| 6 | has ExcludeNumbers => (is => 'ro', isa => 'Bool'); | ||
| 7 | has ExcludePunctuation => (is => 'ro', isa => 'Bool'); | ||
| 8 | has ExcludeUppercase => (is => 'ro', isa => 'Bool'); | ||
| 9 | has IncludeSpace => (is => 'ro', isa => 'Bool'); | ||
| 10 | has PasswordLength => (is => 'ro', isa => 'Int'); | ||
| 11 | has RequireEachIncludedType => (is => 'ro', isa => 'Bool'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetRandomPassword'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SecretsManager::GetRandomPasswordResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::SecretsManager::GetRandomPassword - Arguments for method GetRandomPassword on L<Paws::SecretsManager> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method GetRandomPassword on the | ||
| 29 | L<AWS Secrets Manager|Paws::SecretsManager> service. Use the attributes of this class | ||
| 30 | as arguments to method GetRandomPassword. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRandomPassword. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $secretsmanager = Paws->service('SecretsManager'); | ||
| 37 | # To generate a random password | ||
| 38 | # The following example shows how to request a randomly generated password. This | ||
| 39 | # example includes the optional flags to require spaces and at least one | ||
| 40 | # character of each included type. It specifies a length of 20 characters. | ||
| 41 | my $GetRandomPasswordResponse = $secretsmanager->GetRandomPassword( | ||
| 42 | 'IncludeSpace' => 1, | ||
| 43 | 'PasswordLength' => 20, | ||
| 44 | 'RequireEachIncludedType' => 1 | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $RandomPassword = $GetRandomPasswordResponse->RandomPassword; | ||
| 49 | |||
| 50 | # Returns a L<Paws::SecretsManager::GetRandomPasswordResponse> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/GetRandomPassword> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ExcludeCharacters => Str | ||
| 59 | |||
| 60 | A string that includes characters that should not be included in the | ||
| 61 | generated password. The default is that all characters from the | ||
| 62 | included sets can be used. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 ExcludeLowercase => Bool | ||
| 67 | |||
| 68 | Specifies that the generated password should not include lowercase | ||
| 69 | letters. The default if you do not include this switch parameter is | ||
| 70 | that lowercase letters can be included. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 ExcludeNumbers => Bool | ||
| 75 | |||
| 76 | Specifies that the generated password should not include digits. The | ||
| 77 | default if you do not include this switch parameter is that digits can | ||
| 78 | be included. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 ExcludePunctuation => Bool | ||
| 83 | |||
| 84 | Specifies that the generated password should not include punctuation | ||
| 85 | characters. The default if you do not include this switch parameter is | ||
| 86 | that punctuation characters can be included. | ||
| 87 | |||
| 88 | The following are the punctuation characters that I<can> be included in | ||
| 89 | the generated password if you don't explicitly exclude them with | ||
| 90 | C<ExcludeCharacters> or C<ExcludePunctuation>: | ||
| 91 | |||
| 92 | C<! " # $ % & ' ( ) * + , - . / : ; E<lt> = E<gt> ? @ [ \ ] ^ _ ` { | } | ||
| 93 | ~> | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 ExcludeUppercase => Bool | ||
| 98 | |||
| 99 | Specifies that the generated password should not include uppercase | ||
| 100 | letters. The default if you do not include this switch parameter is | ||
| 101 | that uppercase letters can be included. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 IncludeSpace => Bool | ||
| 106 | |||
| 107 | Specifies that the generated password can include the space character. | ||
| 108 | The default if you do not include this switch parameter is that the | ||
| 109 | space character is not included. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 PasswordLength => Int | ||
| 114 | |||
| 115 | The desired length of the generated password. The default value if you | ||
| 116 | do not include this parameter is 32 characters. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 RequireEachIncludedType => Bool | ||
| 121 | |||
| 122 | A boolean value that specifies whether the generated password must | ||
| 123 | include at least one of every allowed character type. The default value | ||
| 124 | is C<True> and the operation requires at least one of every character | ||
| 125 | type. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, documenting arguments for method GetRandomPassword in L<Paws::SecretsManager> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |