software.amazon.awscdk.services.certificatemanager

Class DnsValidatedCertificate.Builder

java.lang.Object

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

Enclosing class:

DnsValidatedCertificate

@Stability(value=Experimental)
public static final class DnsValidatedCertificate.Builder
extends Object

A fluent builder for DnsValidatedCertificate.

Method Summary

Modifier and Type	Method and Description
DnsValidatedCertificate	build()
static DnsValidatedCertificate.Builder	create(Construct scope, String id) EXPERIMENTAL
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	validationDomains(Map<String,String> validationDomains) What validation domain to use for every requested domain.
DnsValidatedCertificate.Builder	validationMethod(ValidationMethod validationMethod) Validation method used to assert domain ownership.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

EXPERIMENTAL

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

validationDomains

@Stability(value=Stable)
public DnsValidatedCertificate.Builder validationDomains(Map<String,String> validationDomains)

What validation domain to use for every requested domain.

Has to be a superdomain of the requested domain.

Default: - Apex domain is used for every domain that's not overridden.

Parameters:

validationDomains - What validation domain to use for every requested domain. This parameter is required.

Returns:

this

validationMethod

@Stability(value=Stable)
public DnsValidatedCertificate.Builder validationMethod(ValidationMethod validationMethod)

Validation method used to assert domain ownership.

Default: ValidationMethod.EMAIL

Parameters:

validationMethod - Validation method used to assert domain ownership. This parameter is required.

Returns:

this

hostedZone

@Stability(value=Experimental)
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.

EXPERIMENTAL

Parameters:

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

Returns:

this

customResourceRole

@Stability(value=Experimental)
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

EXPERIMENTAL

Parameters:

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

Returns:

this

region

@Stability(value=Experimental)
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.

EXPERIMENTAL

Parameters:

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

Returns:

this

route53Endpoint

@Stability(value=Experimental)
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 offically 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

EXPERIMENTAL

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=Experimental)
public DnsValidatedCertificate build()