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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_authority_arnString

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)


2412
2413
2414
2415
2416
2417
2418
# File 'lib/aws-sdk-acmpca/types.rb', line 2412

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

#certificate_serialString

Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling

GetCertificate][1

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][2

action in the *Certificate Manager API

Reference*.

[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificate.html [2]: docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
# File 'lib/aws-sdk-acmpca/types.rb', line 2412

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

#revocation_reasonString

Specifies why you revoked the certificate.

Returns:

  • (String)


2412
2413
2414
2415
2416
2417
2418
# File 'lib/aws-sdk-acmpca/types.rb', line 2412

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