com.amazonaws.services.acmpca.model

Class CrlConfiguration

java.lang.Object

com.amazonaws.services.acmpca.model.CrlConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CrlConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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

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.

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 PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CrlConfiguration()

Method Summary

Modifier and Type	Method and Description
CrlConfiguration	clone()
boolean	equals(Object obj)
String	getCustomCname() Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point.
Boolean	getEnabled() Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
Integer	getExpirationInDays() Number of days until a certificate expires.
String	getS3BucketName() Name of the S3 bucket that contains the CRL.
int	hashCode()
Boolean	isEnabled() Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCustomCname(String customCname) Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point.
void	setEnabled(Boolean enabled) Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
void	setExpirationInDays(Integer expirationInDays) Number of days until a certificate expires.
void	setS3BucketName(String s3BucketName) Name of the S3 bucket that contains the CRL.
String	toString() Returns a string representation of this object.
CrlConfiguration	withCustomCname(String customCname) Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point.
CrlConfiguration	withEnabled(Boolean enabled) Boolean value that specifies whether certificate revocation lists (CRLs) are enabled.
CrlConfiguration	withExpirationInDays(Integer expirationInDays) Number of days until a certificate expires.
CrlConfiguration	withS3BucketName(String s3BucketName) Name of the S3 bucket that contains the CRL.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CrlConfiguration

public CrlConfiguration()

Method Detail

setEnabled

public void setEnabled(Boolean 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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.

Parameters:

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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.

getEnabled

public Boolean 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.

Returns:

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.

withEnabled

public CrlConfiguration withEnabled(Boolean 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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.

Parameters:

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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnabled

public Boolean isEnabled()

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.

Returns:

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.

setExpirationInDays

public void setExpirationInDays(Integer expirationInDays)

Number of days until a certificate expires.

Parameters:

expirationInDays - Number of days until a certificate expires.

getExpirationInDays

public Integer getExpirationInDays()

Number of days until a certificate expires.

Returns:

Number of days until a certificate expires.

withExpirationInDays

public CrlConfiguration withExpirationInDays(Integer expirationInDays)

Number of days until a certificate expires.

Parameters:

expirationInDays - Number of days until a certificate expires.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCustomCname

public void setCustomCname(String customCname)

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.

Parameters:

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

getCustomCname

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

Returns:

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.

withCustomCname

public CrlConfiguration withCustomCname(String customCname)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3BucketName

public void setS3BucketName(String s3BucketName)

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 PCA to write the CRL to your bucket.

Parameters:

s3BucketName - 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 PCA to write the CRL to your bucket.

getS3BucketName

public 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 PCA to write the CRL to your bucket.

Returns:

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 PCA to write the CRL to your bucket.

withS3BucketName

public CrlConfiguration withS3BucketName(String s3BucketName)

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 PCA to write the CRL to your bucket.

Parameters:

s3BucketName - 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 PCA to write the CRL to your bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CrlConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.