Class: Aws::ACMPCA::Types::UpdateCertificateAuthorityRequest

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

Overview

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) 


2568
2569
2570
2571
2572
2573
2574
 
# File 'lib/aws-sdk-acmpca/types.rb', line 2568

class UpdateCertificateAuthorityRequest < Struct.new(
  :certificate_authority_arn,
  :revocation_configuration,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#revocation_configuration ⇒ Types::RevocationConfiguration

Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. If you don’t supply this parameter, existing capibilites remain unchanged. For more information, see the

OcspConfiguration][1

and [CrlConfiguration] types.

The following requirements apply to revocation configurations.

  • A configuration disabling CRLs or OCSP must contain only the ‘Enabled=False` parameter, and will fail if other parameters such as `CustomCname` or `ExpirationInDays` are included.

  • In a CRL configuration, the ‘S3BucketName` parameter must conform to [Amazon S3 bucket naming rules].

  • A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to [RFC2396] restrictions on the use of special characters in a CNAME.

  • In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as “http://” or “https://”.

If you update the ‘S3BucketName` of [CrlConfiguration], you can break revocation for existing certificates. In other words, if you call [UpdateCertificateAuthority] to update the CRL configuration’s S3 bucket name, Amazon Web Services Private CA only writes CRLs to the new S3 bucket. Certificates issued prior to this point will have the old S3 bucket name in your CRL Distribution Point (CDP) extension, essentially breaking revocation. If you must update the S3 bucket, you’ll need to reissue old certificates to keep the revocation working. Alternatively, you can use a

CustomCname][6

in your CRL configuration if you might need to

change the S3 bucket name in the future.

[1]: docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html [2]: docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html [4]: www.ietf.org/rfc/rfc2396.txt [5]: docs.aws.amazon.com/privateca/latest/APIReference/API_UpdateCertificateAuthority.html [6]: docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html#privateca-Type-CrlConfiguration-CustomCname

Returns:



2568
2569
2570
2571
2572
2573
2574
 
# File 'lib/aws-sdk-acmpca/types.rb', line 2568

class UpdateCertificateAuthorityRequest < Struct.new(
  :certificate_authority_arn,
  :revocation_configuration,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Status of your private CA.

Returns:

  • (String) 


2568
2569
2570
2571
2572
2573
2574
 
# File 'lib/aws-sdk-acmpca/types.rb', line 2568

class UpdateCertificateAuthorityRequest < Struct.new(
  :certificate_authority_arn,
  :revocation_configuration,
  :status)
  SENSITIVE = []
  include Aws::Structure
end