« blib/lib/Paws/IAM/UploadSSHPublicKeyResponse.pm
↑ Summary
blib/lib/Paws/IAM/UploadServerCertificateResponse.pm »
| 1 | |||
| 2 | package Paws::IAM::UploadServerCertificate; | ||
| 3 | use Moose; | ||
| 4 | has CertificateBody => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has CertificateChain => (is => 'ro', isa => 'Str'); | ||
| 6 | has Path => (is => 'ro', isa => 'Str'); | ||
| 7 | has PrivateKey => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ServerCertificateName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IAM::Tag]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UploadServerCertificate'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::UploadServerCertificateResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'UploadServerCertificateResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IAM::UploadServerCertificate - Arguments for method UploadServerCertificate on L<Paws::IAM> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UploadServerCertificate on the | ||
| 27 | L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class | ||
| 28 | as arguments to method UploadServerCertificate. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UploadServerCertificate. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $iam = Paws->service('IAM'); | ||
| 35 | # To upload a server certificate to your AWS account | ||
| 36 | # The following upload-server-certificate command uploads a server certificate | ||
| 37 | # to your AWS account: | ||
| 38 | my $UploadServerCertificateResponse = $iam->UploadServerCertificate( | ||
| 39 | 'CertificateBody' => | ||
| 40 | '-----BEGIN CERTIFICATE-----<a very long certificate text string>-----END CERTIFICATE-----', | ||
| 41 | 'Path' => '/company/servercerts/', | ||
| 42 | 'PrivateKey' => | ||
| 43 | '-----BEGIN DSA PRIVATE KEY-----<a very long private key string>-----END DSA PRIVATE KEY-----', | ||
| 44 | 'ServerCertificateName' => 'ProdServerCert' | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $ServerCertificateMetadata = | ||
| 49 | $UploadServerCertificateResponse->ServerCertificateMetadata; | ||
| 50 | |||
| 51 | # Returns a L<Paws::IAM::UploadServerCertificateResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/UploadServerCertificate> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> CertificateBody => Str | ||
| 60 | |||
| 61 | The contents of the public key certificate in PEM-encoded format. | ||
| 62 | |||
| 63 | The regex pattern (http://wikipedia.org/wiki/regex) used to validate | ||
| 64 | this parameter is a string of characters consisting of the following: | ||
| 65 | |||
| 66 | =over | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | Any printable ASCII character ranging from the space character | ||
| 71 | (C<\u0020>) through the end of the ASCII character range | ||
| 72 | |||
| 73 | =item * | ||
| 74 | |||
| 75 | The printable characters in the Basic Latin and Latin-1 Supplement | ||
| 76 | character set (through C<\u00FF>) | ||
| 77 | |||
| 78 | =item * | ||
| 79 | |||
| 80 | The special characters tab (C<\u0009>), line feed (C<\u000A>), and | ||
| 81 | carriage return (C<\u000D>) | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 CertificateChain => Str | ||
| 89 | |||
| 90 | The contents of the certificate chain. This is typically a | ||
| 91 | concatenation of the PEM-encoded public key certificates of the chain. | ||
| 92 | |||
| 93 | The regex pattern (http://wikipedia.org/wiki/regex) used to validate | ||
| 94 | this parameter is a string of characters consisting of the following: | ||
| 95 | |||
| 96 | =over | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | Any printable ASCII character ranging from the space character | ||
| 101 | (C<\u0020>) through the end of the ASCII character range | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | The printable characters in the Basic Latin and Latin-1 Supplement | ||
| 106 | character set (through C<\u00FF>) | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | The special characters tab (C<\u0009>), line feed (C<\u000A>), and | ||
| 111 | carriage return (C<\u000D>) | ||
| 112 | |||
| 113 | =back | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head2 Path => Str | ||
| 119 | |||
| 120 | The path for the server certificate. For more information about paths, | ||
| 121 | see IAM identifiers | ||
| 122 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) | ||
| 123 | in the I<IAM User Guide>. | ||
| 124 | |||
| 125 | This parameter is optional. If it is not included, it defaults to a | ||
| 126 | slash (/). This parameter allows (through its regex pattern | ||
| 127 | (http://wikipedia.org/wiki/regex)) a string of characters consisting of | ||
| 128 | either a forward slash (/) by itself or a string that must begin and | ||
| 129 | end with forward slashes. In addition, it can contain any ASCII | ||
| 130 | character from the ! (C<\u0021>) through the DEL character (C<\u007F>), | ||
| 131 | including most punctuation characters, digits, and upper and lowercased | ||
| 132 | letters. | ||
| 133 | |||
| 134 | If you are uploading a server certificate specifically for use with | ||
| 135 | Amazon CloudFront distributions, you must specify a path using the | ||
| 136 | C<path> parameter. The path must begin with C</cloudfront> and must | ||
| 137 | include a trailing slash (for example, C</cloudfront/test/>). | ||
| 138 | |||
| 139 | |||
| 140 | |||
| 141 | =head2 B<REQUIRED> PrivateKey => Str | ||
| 142 | |||
| 143 | The contents of the private key in PEM-encoded format. | ||
| 144 | |||
| 145 | The regex pattern (http://wikipedia.org/wiki/regex) used to validate | ||
| 146 | this parameter is a string of characters consisting of the following: | ||
| 147 | |||
| 148 | =over | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | Any printable ASCII character ranging from the space character | ||
| 153 | (C<\u0020>) through the end of the ASCII character range | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | The printable characters in the Basic Latin and Latin-1 Supplement | ||
| 158 | character set (through C<\u00FF>) | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | The special characters tab (C<\u0009>), line feed (C<\u000A>), and | ||
| 163 | carriage return (C<\u000D>) | ||
| 164 | |||
| 165 | =back | ||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 B<REQUIRED> ServerCertificateName => Str | ||
| 171 | |||
| 172 | The name for the server certificate. Do not include the path in this | ||
| 173 | value. The name of the certificate cannot contain any spaces. | ||
| 174 | |||
| 175 | This parameter allows (through its regex pattern | ||
| 176 | (http://wikipedia.org/wiki/regex)) a string of characters consisting of | ||
| 177 | upper and lowercase alphanumeric characters with no spaces. You can | ||
| 178 | also include any of the following characters: _+=,.@- | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head2 Tags => ArrayRef[L<Paws::IAM::Tag>] | ||
| 183 | |||
| 184 | A list of tags that you want to attach to the new IAM server | ||
| 185 | certificate resource. Each tag consists of a key name and an associated | ||
| 186 | value. For more information about tagging, see Tagging IAM resources | ||
| 187 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the | ||
| 188 | I<IAM User Guide>. | ||
| 189 | |||
| 190 | If any one of the tags is invalid or if you exceed the allowed maximum | ||
| 191 | number of tags, then the entire request fails and the resource is not | ||
| 192 | created. | ||
| 193 | |||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | =head1 SEE ALSO | ||
| 198 | |||
| 199 | This class forms part of L<Paws>, documenting arguments for method UploadServerCertificate in L<Paws::IAM> | ||
| 200 | |||
| 201 | =head1 BUGS and CONTRIBUTIONS | ||
| 202 | |||
| 203 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 204 | |||
| 205 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 206 | |||
| 207 | =cut | ||
| 208 |