You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ACMPCA::Types::RevokeCertificateRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ACMPCA::Types::RevokeCertificateRequest
- Defined in:
- (unknown)
Overview
When passing RevokeCertificateRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
certificate_authority_arn: "Arn", # required
certificate_serial: "String128", # required
revocation_reason: "UNSPECIFIED", # required, accepts UNSPECIFIED, KEY_COMPROMISE, CERTIFICATE_AUTHORITY_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, PRIVILEGE_WITHDRAWN, A_A_COMPROMISE
}
Instance Attribute Summary collapse
-
#certificate_authority_arn ⇒ String
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked.
-
#certificate_serial ⇒ String
Serial number of the certificate to be revoked.
-
#revocation_reason ⇒ String
Specifies why you revoked the certificate.
Instance Attribute Details
#certificate_authority_arn ⇒ String
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
#certificate_serial ⇒ String
Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.
#revocation_reason ⇒ String
Specifies why you revoked the certificate.
Possible values:
- UNSPECIFIED
- KEY_COMPROMISE
- CERTIFICATE_AUTHORITY_COMPROMISE
- AFFILIATION_CHANGED
- SUPERSEDED
- CESSATION_OF_OPERATION
- PRIVILEGE_WITHDRAWN
- A_A_COMPROMISE