software.amazon.awscdk.services.certificatemanager

Interface DnsValidatedCertificateProps

All Superinterfaces:

CertificateProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DnsValidatedCertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-10T17:05:58.552Z")
 @Stability(value=Stable)
public interface DnsValidatedCertificateProps
extends software.amazon.jsii.JsiiSerializable, CertificateProps

Properties to create a DNS validated certificate managed by AWS Certificate Manager.

Example:

 HostedZone myHostedZone;
 DnsValidatedCertificate.Builder.create(this, "CrossRegionCertificate")
         .domainName("hello.example.com")
         .hostedZone(myHostedZone)
         .region("us-east-1")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DnsValidatedCertificateProps.Builder A builder for DnsValidatedCertificateProps
static class	DnsValidatedCertificateProps.Jsii$Proxy An implementation for DnsValidatedCertificateProps

Method Summary

Modifier and Type	Method and Description
static DnsValidatedCertificateProps.Builder	builder()
default Boolean	getCleanupRoute53Records() When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed.
default IRole	getCustomResourceRole() Role to use for the custom resource that creates the validated certificate.
IHostedZone	getHostedZone() Route 53 Hosted Zone used to perform DNS validation of the request.
default String	getRegion() AWS region that will host the certificate.
default String	getRoute53Endpoint() 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.

Methods inherited from interface software.amazon.awscdk.services.certificatemanager.CertificateProps

getDomainName, getSubjectAlternativeNames, getValidation, getValidationDomains, getValidationMethod

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHostedZone

@Stability(value=Stable)
 @NotNull
IHostedZone getHostedZone()

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.

getCleanupRoute53Records

@Stability(value=Stable)
 @Nullable
default Boolean getCleanupRoute53Records()

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

getCustomResourceRole

@Stability(value=Stable)
 @Nullable
default IRole getCustomResourceRole()

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

Default: - A new role will be created

getRegion

@Stability(value=Stable)
 @Nullable
default String getRegion()

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.

getRoute53Endpoint

@Stability(value=Stable)
 @Nullable
default String getRoute53Endpoint()

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

builder

@Stability(value=Stable)
static DnsValidatedCertificateProps.Builder builder()

Specified by:

builder in interface CertificateProps

Returns:

a DnsValidatedCertificateProps.Builder of DnsValidatedCertificateProps