Class CfnCertificateAuthority.CrlConfigurationProperty
Contains configuration information for a certificate revocation list (CRL).
Inheritance
Namespace: Amazon.CDK.AWS.ACMPCA
Assembly: Amazon.CDK.AWS.ACMPCA.dll
Syntax (csharp)
public class CrlConfigurationProperty : Object, CfnCertificateAuthority.ICrlConfigurationProperty
Syntax (vb)
Public Class CrlConfigurationProperty
Inherits Object
Implements CfnCertificateAuthority.ICrlConfigurationProperty
Remarks
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 AWS Private CA.
AWS 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, AWS Private CA makes further attempts every 15 minutes.
CRLs contain the following fields:
Certificate revocation lists created by AWS 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 Private Certificate Authority User Guide
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ACMPCA;
var crlConfigurationProperty = new CrlConfigurationProperty {
CustomCname = "customCname",
Enabled = false,
ExpirationInDays = 123,
S3BucketName = "s3BucketName",
S3ObjectAcl = "s3ObjectAcl"
};
Synopsis
Constructors
CrlConfigurationProperty() |
Properties
CustomCname | Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. |
Enabled | Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. |
ExpirationInDays | Validity period of the CRL in days. |
S3BucketName | Name of the S3 bucket that contains the CRL. |
S3ObjectAcl | Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket. |
Constructors
CrlConfigurationProperty()
public CrlConfigurationProperty()
Properties
CustomCname
Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point.
public string CustomCname { get; set; }
Property Value
System.String
Remarks
Use this value if you don't want the name of your S3 bucket to be public.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
Enabled
Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
public object Enabled { get; set; }
Property Value
System.Object
Remarks
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.
ExpirationInDays
Validity period of the CRL in days.
public Nullable<double> ExpirationInDays { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
S3BucketName
Name of the S3 bucket that contains the CRL.
public string S3BucketName { get; set; }
Property Value
System.String
Remarks
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 AWS Private CA to write the CRL to your bucket.
The S3BucketName
parameter must conform to the S3 bucket naming rules .
S3ObjectAcl
Determines whether the CRL will be publicly readable or privately held in the CRL Amazon S3 bucket.
public string S3ObjectAcl { get; set; }
Property Value
System.String
Remarks
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.
Note: This default can cause CA creation to fail in some circumstances. If you have 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 .