class Aws::ACMPCA::Types::CrlConfiguration

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 at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.

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:

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*

[1]: docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#crl-encryption [2]: docs.aws.amazon.com/acm-pca/latest/userguide/crl-planning.html

@note When making an API call, you may pass CrlConfiguration

data as a hash:

    {
      enabled: false, # required
      expiration_in_days: 1,
      custom_cname: "String253",
      s3_bucket_name: "String3To255",
      s3_object_acl: "PUBLIC_READ", # accepts PUBLIC_READ, BUCKET_OWNER_FULL_CONTROL
    }

@!attribute [rw] enabled

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][1] action or for an existing CA when
you call the [UpdateCertificateAuthority][2] action.

[1]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html
[2]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html
@return [Boolean]

@!attribute [rw] expiration_in_days

Validity period of the CRL in days.
@return [Integer]

@!attribute [rw] custom_cname

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.
@return [String]

@!attribute [rw] s3_bucket_name

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][1] operation. You must
specify a [bucket policy][2] that allows ACM Private CA to write the
CRL to your bucket.

[1]: https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_UpdateCertificateAuthority.html
[2]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-policies
@return [String]

@!attribute [rw] s3_object_acl

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`.

*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][1].

[1]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaCreateCa.html#s3-bpa
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CrlConfiguration AWS API Documentation

Constants

SENSITIVE