Package software.amazon.awscdk.cfnpropertymixins.services.acmpca

Class CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.acmpca.CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty>

Enclosing interface:

CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty

@Stability(Stable)
public static final class CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty>

A builder for CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty	build()	Builds the configured instance.
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	crlDistributionPointExtensionConfiguration(CfnCertificateAuthorityPropsMixin.CrlDistributionPointExtensionConfigurationProperty crlDistributionPointExtensionConfiguration)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCrlDistributionPointExtensionConfiguration()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	crlDistributionPointExtensionConfiguration(IResolvable crlDistributionPointExtensionConfiguration)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCrlDistributionPointExtensionConfiguration()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	crlType(String crlType)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCrlType()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	customCname(String customCname)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCustomCname()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	customPath(String customPath)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCustomPath()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	enabled(Boolean enabled)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getEnabled()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	enabled(IResolvable enabled)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getEnabled()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	expirationInDays(Number expirationInDays)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getExpirationInDays()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	s3BucketName(String s3BucketName)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getS3BucketName()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	s3BucketName(IBucketRef s3BucketName)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getS3BucketName()
CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder	s3ObjectAcl(String s3ObjectAcl)	Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getS3ObjectAcl()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

crlDistributionPointExtensionConfiguration

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder crlDistributionPointExtensionConfiguration(IResolvable crlDistributionPointExtensionConfiguration)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCrlDistributionPointExtensionConfiguration()

Parameters:

crlDistributionPointExtensionConfiguration - Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA. If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL.

Returns:

this

crlDistributionPointExtensionConfiguration

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder crlDistributionPointExtensionConfiguration(CfnCertificateAuthorityPropsMixin.CrlDistributionPointExtensionConfigurationProperty crlDistributionPointExtensionConfiguration)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCrlDistributionPointExtensionConfiguration()

Parameters:

crlDistributionPointExtensionConfiguration - Configures the default behavior of the CRL Distribution Point extension for certificates issued by your CA. If this field is not provided, then the CRL Distribution Point extension will be present and contain the default CRL URL.

Returns:

this

crlType

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder crlType(String crlType)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCrlType()

Parameters:

crlType - Specifies the type of CRL. This setting determines the maximum number of certificates that the certificate authority can issue and revoke. For more information, see AWS Private CA quotas .

• COMPLETE - The default setting. AWS Private CA maintains a single CRL file for all unexpired certificates issued by a CA that have been revoked for any reason. Each certificate that AWS Private CA issues is bound to a specific CRL through the CRL distribution point (CDP) defined in RFC 5280 .
• PARTITIONED - Compared to complete CRLs, partitioned CRLs dramatically increase the number of certificates your private CA can issue.

When using partitioned CRLs, you must validate that the CRL's associated issuing distribution point (IDP) URI matches the certificate's CDP URI to ensure the right CRL has been fetched. AWS Private CA marks the IDP extension as critical, which your client must be able to process.

Returns:

this

customCname

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder customCname(String customCname)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCustomCname()

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.

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://".

Returns:

this

customPath

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder customPath(String customPath)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getCustomPath()

Parameters:

customPath - Designates a custom file path in S3 for CRL(s). For example, http://<CustomName>/<CustomPath>/<CrlPartition_GUID>.crl .

Returns:

this

enabled

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder enabled(Boolean enabled)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getEnabled()

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:

this

enabled

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder enabled(IResolvable enabled)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getEnabled()

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:

this

expirationInDays

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder expirationInDays(Number expirationInDays)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getExpirationInDays()

Parameters:

expirationInDays - Validity period of the CRL in days.

Returns:

this

s3BucketName

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder s3BucketName(String s3BucketName)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getS3BucketName()

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 AWS Private CA to write the CRL to your bucket.

The S3BucketName parameter must conform to the S3 bucket naming rules .

Returns:

this

s3BucketName

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder s3BucketName(IBucketRef s3BucketName)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getS3BucketName()

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 AWS Private CA to write the CRL to your bucket.

The S3BucketName parameter must conform to the S3 bucket naming rules .

Returns:

this

s3ObjectAcl

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.Builder s3ObjectAcl(String s3ObjectAcl)

Sets the value of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty.getS3ObjectAcl()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty>

Returns:

a new instance of CfnCertificateAuthorityPropsMixin.CrlConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided