Class: Aws::ACMPCA::Types::RevokeCertificateRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb

Overview

Note:

When making an API call, you may pass RevokeCertificateRequest data as a 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
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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

Returns:

  • (String) 


3260
3261
3262
3263
3264
3265
3266
 
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 3260

class RevokeCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :certificate_serial,
  :revocation_reason)
  SENSITIVE = []
  include Aws::Structure
end

#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 Certificate Manager API Reference.

Returns:

  • (String) 


3260
3261
3262
3263
3264
3265
3266
 
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 3260

class RevokeCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :certificate_serial,
  :revocation_reason)
  SENSITIVE = []
  include Aws::Structure
end

#revocation_reason ⇒ String

Specifies why you revoked the certificate.

Returns:

  • (String) 


3260
3261
3262
3263
3264
3265
3266
 
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 3260

class RevokeCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :certificate_serial,
  :revocation_reason)
  SENSITIVE = []
  include Aws::Structure
end