software.amazon.awscdk.services.acmpca

Interface CfnCertificateAuthority.CrlConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificateAuthority.CrlConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnCertificateAuthority

@Stability(value=Stable)
public static interface CfnCertificateAuthority.CrlConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains configuration information for a certificate revocation list (CRL).

Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true . Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA.

ACM Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs .

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.

A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, ACM Private CA makes further attempts every 15 minutes.

CRLs contain the following fields:

• Version : The current version number defined in RFC 5280 is V2. The integer value is 0x1.
• Signature Algorithm : The name of the algorithm used to sign the CRL.
• Issuer : The X.500 distinguished name of your private CA that issued the CRL.
• Last Update : The issue date and time of this CRL.
• Next Update : The day and time by which the next CRL will be issued.
• Revoked Certificates : List of revoked certificates. Each list item contains the following information.
• Serial Number : The serial number, in hexadecimal format, of the revoked certificate.
• Revocation Date : Date and time the certificate was revoked.
• CRL Entry Extensions : Optional extensions for the CRL entry.
• X509v3 CRL Reason Code : Reason the certificate was revoked.
• CRL Extensions : Optional extensions for the CRL.
• X509v3 Authority Key Identifier : Identifies the public key associated with the private key used to sign the certificate.
• X509v3 CRL Number: : Decimal sequence number for the CRL.
• Signature Algorithm : Algorithm used by your private CA to sign the CRL.
• Signature Value : Signature computed over the CRL.

Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in *crl_path* -noout

For more information, see Planning a certificate revocation list (CRL) in the AWS Certificate Manager Private Certificate Authority (PCA) User Guide

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.acmpca.*;
 CrlConfigurationProperty crlConfigurationProperty = CrlConfigurationProperty.builder()
         .customCname("customCname")
         .enabled(false)
         .expirationInDays(123)
         .s3BucketName("s3BucketName")
         .s3ObjectAcl("s3ObjectAcl")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnCertificateAuthority.CrlConfigurationProperty.Builder A builder for CfnCertificateAuthority.CrlConfigurationProperty
static class	CfnCertificateAuthority.CrlConfigurationProperty.Jsii$Proxy An implementation for CfnCertificateAuthority.CrlConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnCertificateAuthority.CrlConfigurationProperty.Builder	builder()
default String	getCustomCname() Name inserted into the certificate *CRL Distribution Points* extension that enables the use of an alias for the CRL distribution point.
default Object	getEnabled() Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
default Number	getExpirationInDays() Validity period of the CRL in days.
default String	getS3BucketName() Name of the S3 bucket that contains the CRL.
default String	getS3ObjectAcl() Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCustomCname

@Stability(value=Stable)
 @Nullable
default String getCustomCname()

Name inserted into the certificate *CRL Distribution Points* extension that enables the use of an alias for the CRL distribution point.

Use this value if you don't want the name of your S3 bucket to be public.

getEnabled

@Stability(value=Stable)
 @Nullable
default Object getEnabled()

Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.

You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority operation or for an existing CA when you call the UpdateCertificateAuthority operation.

getExpirationInDays

@Stability(value=Stable)
 @Nullable
default Number getExpirationInDays()

Validity period of the CRL in days.

getS3BucketName

@Stability(value=Stable)
 @Nullable
default String getS3BucketName()

Name of the S3 bucket that contains the CRL.

If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority operation. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.

getS3ObjectAcl

@Stability(value=Stable)
 @Nullable
default String getS3ObjectAcl()

Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket.

If you choose PUBLIC_READ, the CRL will be accessible over the public internet. If you choose BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can access the CRL, and your PKI clients may need an alternative method of access.

If no value is specified, the default is PUBLIC_READ.

This default can cause CA creation to fail in some circumstances. If you have enabled the Block Public Access (BPA) feature in your S3 account, then you must specify the value of this parameter as BUCKET_OWNER_FULL_CONTROL , and not doing so results in an error. If you have disabled BPA in S3, then you can specify either BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.

For more information, see Blocking public access to the S3 bucket .

builder

@Stability(value=Stable)
static CfnCertificateAuthority.CrlConfigurationProperty.Builder builder()

Returns:

a CfnCertificateAuthority.CrlConfigurationProperty.Builder of CfnCertificateAuthority.CrlConfigurationProperty