Class: AWSCDK::ACMPCA::CfnCertificateAuthority::RevocationConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
acmpca/cfn_certificate_authority.rb

Overview

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate in the AWS Private CA API Reference and Setting up a certificate revocation method in the AWS Private CA User Guide .

The following requirements and constraints 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 the 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://".
  • To revoke a certificate, delete the resource from your template, and call the AWS Private CA RevokeCertificate API and specify the resource's certificate authority ARN.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(crl_configuration: nil, ocsp_configuration: nil) ⇒ RevocationConfigurationProperty

Returns a new instance of RevocationConfigurationProperty.

Parameters:



1390
1391
1392
1393
1394
1395
 
# File 'acmpca/cfn_certificate_authority.rb', line 1390

def initialize(crl_configuration: nil, ocsp_configuration: nil)
  @crl_configuration = crl_configuration.is_a?(Hash) ? ::AWSCDK::ACMPCA::CfnCertificateAuthority::CrlConfigurationProperty.new(**crl_configuration.transform_keys(&:to_sym)) : crl_configuration
  Jsii::Type.check_type(@crl_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hY21wY2EuQ2ZuQ2VydGlmaWNhdGVBdXRob3JpdHkuQ3JsQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "crlConfiguration") unless @crl_configuration.nil?
  @ocsp_configuration = ocsp_configuration.is_a?(Hash) ? ::AWSCDK::ACMPCA::CfnCertificateAuthority::OcspConfigurationProperty.new(**ocsp_configuration.transform_keys(&:to_sym)) : ocsp_configuration
  Jsii::Type.check_type(@ocsp_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hY21wY2EuQ2ZuQ2VydGlmaWNhdGVBdXRob3JpdHkuT2NzcENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "ocspConfiguration") unless @ocsp_configuration.nil?
end

Instance Attribute Details

#crl_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.

Returns:

See Also:



1401
1402
1403
 
# File 'acmpca/cfn_certificate_authority.rb', line 1401

def crl_configuration
  @crl_configuration
end

#ocsp_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration of Online Certificate Status Protocol (OCSP) support, if any, maintained by your private CA.

Returns:

See Also:



1406
1407
1408
 
# File 'acmpca/cfn_certificate_authority.rb', line 1406

def ocsp_configuration
  @ocsp_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



1408
1409
1410
1411
1412
1413
 
# File 'acmpca/cfn_certificate_authority.rb', line 1408

def self.jsii_properties
  {
    :crl_configuration => "crlConfiguration",
    :ocsp_configuration => "ocspConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1415
1416
1417
1418
1419
1420
1421
1422
 
# File 'acmpca/cfn_certificate_authority.rb', line 1415

def to_jsii
  result = {}
  result.merge!({
    "crlConfiguration" => @crl_configuration,
    "ocspConfiguration" => @ocsp_configuration,
  })
  result.compact
end