| 1 | |||
| 2 | package Paws::ACMPCA::RevokeCertificate; | ||
| 3 | use Moose; | ||
| 4 | has CertificateAuthorityArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has CertificateSerial => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has RevocationReason => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RevokeCertificate'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ACMPCA::RevokeCertificate - Arguments for method RevokeCertificate on L<Paws::ACMPCA> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method RevokeCertificate on the | ||
| 24 | L<AWS Certificate Manager Private Certificate Authority|Paws::ACMPCA> service. Use the attributes of this class | ||
| 25 | as arguments to method RevokeCertificate. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RevokeCertificate. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $acm-pca = Paws->service('ACMPCA'); | ||
| 32 | $acm -pca->RevokeCertificate( | ||
| 33 | CertificateAuthorityArn => 'MyArn', | ||
| 34 | CertificateSerial => 'MyString128', | ||
| 35 | RevocationReason => 'UNSPECIFIED', | ||
| 36 | |||
| 37 | ); | ||
| 38 | |||
| 39 | 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. | ||
| 40 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/acm-pca/RevokeCertificate> | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> CertificateAuthorityArn => Str | ||
| 46 | |||
| 47 | Amazon Resource Name (ARN) of the private CA that issued the | ||
| 48 | certificate to be revoked. This must be of the form: | ||
| 49 | |||
| 50 | C<arn:aws:acm-pca:I<region>:I<account>:certificate-authority/I<12345678-1234-1234-1234-123456789012>> | ||
| 51 | |||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> CertificateSerial => Str | ||
| 55 | |||
| 56 | Serial number of the certificate to be revoked. This must be in | ||
| 57 | hexadecimal format. You can retrieve the serial number by calling | ||
| 58 | GetCertificate | ||
| 59 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificate.html) | ||
| 60 | with the Amazon Resource Name (ARN) of the certificate you want and the | ||
| 61 | ARN of your private CA. The B<GetCertificate> action retrieves the | ||
| 62 | certificate in the PEM format. You can use the following OpenSSL | ||
| 63 | command to list the certificate in text format and copy the hexadecimal | ||
| 64 | serial number. | ||
| 65 | |||
| 66 | C<openssl x509 -in I<file_path> -text -noout> | ||
| 67 | |||
| 68 | You can also copy the serial number from the console or use the | ||
| 69 | DescribeCertificate | ||
| 70 | (https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html) | ||
| 71 | action in the I<AWS Certificate Manager API Reference>. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> RevocationReason => Str | ||
| 76 | |||
| 77 | Specifies why you revoked the certificate. | ||
| 78 | |||
| 79 | Valid values are: C<"UNSPECIFIED">, C<"KEY_COMPROMISE">, C<"CERTIFICATE_AUTHORITY_COMPROMISE">, C<"AFFILIATION_CHANGED">, C<"SUPERSEDED">, C<"CESSATION_OF_OPERATION">, C<"PRIVILEGE_WITHDRAWN">, C<"A_A_COMPROMISE"> | ||
| 80 | |||
| 81 | |||
| 82 | =head1 SEE ALSO | ||
| 83 | |||
| 84 | This class forms part of L<Paws>, documenting arguments for method RevokeCertificate in L<Paws::ACMPCA> | ||
| 85 | |||
| 86 | =head1 BUGS and CONTRIBUTIONS | ||
| 87 | |||
| 88 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 89 | |||
| 90 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 91 | |||
| 92 | =cut | ||
| 93 |