software.amazon.awscdk.services.certificatemanager

Class DnsValidatedCertificate.Builder

java.lang.Object

software.amazon.awscdk.services.certificatemanager.DnsValidatedCertificate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DnsValidatedCertificate>

Enclosing class:

DnsValidatedCertificate

@Stability(value=Stable)
public static final class DnsValidatedCertificate.Builder
extends Object
implements software.amazon.jsii.Builder<DnsValidatedCertificate>

A fluent builder for DnsValidatedCertificate.

Method Summary

Modifier and Type	Method and Description
DnsValidatedCertificate	build()
DnsValidatedCertificate.Builder	cleanupRoute53Records(Boolean cleanupRoute53Records) When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed.
static DnsValidatedCertificate.Builder	create(software.constructs.Construct scope, String id)
DnsValidatedCertificate.Builder	customResourceRole(IRole customResourceRole) Role to use for the custom resource that creates the validated certificate.
DnsValidatedCertificate.Builder	domainName(String domainName) Fully-qualified domain name to request a certificate for.
DnsValidatedCertificate.Builder	hostedZone(IHostedZone hostedZone) Route 53 Hosted Zone used to perform DNS validation of the request.
DnsValidatedCertificate.Builder	region(String region) AWS region that will host the certificate.
DnsValidatedCertificate.Builder	route53Endpoint(String route53Endpoint) An endpoint of Route53 service, which is not necessary as AWS SDK could figure out the right endpoints for most regions, but for some regions such as those in aws-cn partition, the default endpoint is not working now, hence the right endpoint need to be specified through this prop.
DnsValidatedCertificate.Builder	subjectAlternativeNames(List<String> subjectAlternativeNames) Alternative domain names on your certificate.
DnsValidatedCertificate.Builder	transparencyLoggingEnabled(Boolean transparencyLoggingEnabled) Enable or disable transparency logging for this certificate.
DnsValidatedCertificate.Builder	validation(CertificateValidation validation) How to validate this certificate.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static DnsValidatedCertificate.Builder create(software.constructs.Construct scope,
                                                                              String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of DnsValidatedCertificate.Builder.

domainName

@Stability(value=Stable)
public DnsValidatedCertificate.Builder domainName(String domainName)

Fully-qualified domain name to request a certificate for.

May contain wildcards, such as *.domain.com.

Parameters:

domainName - Fully-qualified domain name to request a certificate for. This parameter is required.

Returns:

this

subjectAlternativeNames

@Stability(value=Stable)
public DnsValidatedCertificate.Builder subjectAlternativeNames(List<String> subjectAlternativeNames)

Alternative domain names on your certificate.

Use this to register alternative domain names that represent the same site.

Default: - No additional FQDNs will be included as alternative domain names.

Parameters:

subjectAlternativeNames - Alternative domain names on your certificate. This parameter is required.

Returns:

this

transparencyLoggingEnabled

@Stability(value=Stable)
public DnsValidatedCertificate.Builder transparencyLoggingEnabled(Boolean transparencyLoggingEnabled)

Enable or disable transparency logging for this certificate.

Once a certificate has been logged, it cannot be removed from the log. Opting out at that point will have no effect. If you opt out of logging when you request a certificate and then choose later to opt back in, your certificate will not be logged until it is renewed. If you want the certificate to be logged immediately, we recommend that you issue a new one.

Default: true

Parameters:

transparencyLoggingEnabled - Enable or disable transparency logging for this certificate. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency

validation

@Stability(value=Stable)
public DnsValidatedCertificate.Builder validation(CertificateValidation validation)

How to validate this certificate.

Default: CertificateValidation.fromEmail()

Parameters:

validation - How to validate this certificate. This parameter is required.

Returns:

this

hostedZone

@Stability(value=Stable)
public DnsValidatedCertificate.Builder hostedZone(IHostedZone hostedZone)

Route 53 Hosted Zone used to perform DNS validation of the request.

The zone must be authoritative for the domain name specified in the Certificate Request.

Parameters:

hostedZone - Route 53 Hosted Zone used to perform DNS validation of the request. This parameter is required.

Returns:

this

cleanupRoute53Records

@Stability(value=Stable)
public DnsValidatedCertificate.Builder cleanupRoute53Records(Boolean cleanupRoute53Records)

When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed.

CAUTION: If multiple certificates share the same domains (and same validation records), this can cause the other certificates to fail renewal and/or not validate. Not recommended for production use.

Default: false

Parameters:

cleanupRoute53Records - When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed. This parameter is required.

Returns:

this

customResourceRole

@Stability(value=Stable)
public DnsValidatedCertificate.Builder customResourceRole(IRole customResourceRole)

Role to use for the custom resource that creates the validated certificate.

Default: - A new role will be created

Parameters:

customResourceRole - Role to use for the custom resource that creates the validated certificate. This parameter is required.

Returns:

this

region

@Stability(value=Stable)
public DnsValidatedCertificate.Builder region(String region)

AWS region that will host the certificate.

This is needed especially for certificates used for CloudFront distributions, which require the region to be us-east-1.

Default: the region the stack is deployed in.

Parameters:

region - AWS region that will host the certificate. This parameter is required.

Returns:

this

route53Endpoint

@Stability(value=Stable)
public DnsValidatedCertificate.Builder route53Endpoint(String route53Endpoint)

An endpoint of Route53 service, which is not necessary as AWS SDK could figure out the right endpoints for most regions, but for some regions such as those in aws-cn partition, the default endpoint is not working now, hence the right endpoint need to be specified through this prop.

Route53 is not been officially launched in China, it is only available for AWS internal accounts now. To make DnsValidatedCertificate work for internal accounts now, a special endpoint needs to be provided.

Default: - The AWS SDK will determine the Route53 endpoint to use based on region

Parameters:

route53Endpoint - An endpoint of Route53 service, which is not necessary as AWS SDK could figure out the right endpoints for most regions, but for some regions such as those in aws-cn partition, the default endpoint is not working now, hence the right endpoint need to be specified through this prop. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public DnsValidatedCertificate build()

Specified by:

build in interface software.amazon.jsii.Builder<DnsValidatedCertificate>