interface DnsValidatedCertificateProps

Language	Type name
.NET	`Amazon.CDK.AWS.CertificateManager.DnsValidatedCertificateProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscertificatemanager#DnsValidatedCertificateProps`
Java	`software.amazon.awscdk.services.certificatemanager.DnsValidatedCertificateProps`
Python	`aws_cdk.aws_certificatemanager.DnsValidatedCertificateProps`
TypeScript (source)	`aws-cdk-lib` » `aws_certificatemanager` » `DnsValidatedCertificateProps`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_certificatemanager as certificatemanager } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_route53 as route53 } from 'aws-cdk-lib';

declare const certificateValidation: certificatemanager.CertificateValidation;
declare const hostedZone: route53.HostedZone;
declare const keyAlgorithm: certificatemanager.KeyAlgorithm;
declare const role: iam.Role;
const dnsValidatedCertificateProps: certificatemanager.DnsValidatedCertificateProps = {
  domainName: 'domainName',
  hostedZone: hostedZone,

  // the properties below are optional
  certificateName: 'certificateName',
  cleanupRoute53Records: false,
  customResourceRole: role,
  keyAlgorithm: keyAlgorithm,
  region: 'region',
  route53Endpoint: 'route53Endpoint',
  subjectAlternativeNames: ['subjectAlternativeNames'],
  transparencyLoggingEnabled: false,
  validation: certificateValidation,
};

Properties

Name	Type	Description
domainName	`string`	Fully-qualified domain name to request a certificate for.
hostedZone	`IHostedZone`	Route 53 Hosted Zone used to perform DNS validation of the request.
certificateName?	`string`	The Certificate name.
cleanupRoute53Records?	`boolean`	When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed.
customResourceRole?	`IRole`	Role to use for the custom resource that creates the validated certificate.
keyAlgorithm?	`KeyAlgorithm`	Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.
region?	`string`	AWS region that will host the certificate.
route53Endpoint?	`string`	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.
subjectAlternativeNames?	`string[]`	Alternative domain names on your certificate.
transparencyLoggingEnabled?	`boolean`	Enable or disable transparency logging for this certificate.
validation?	`CertificateValidation`	How to validate this certificate.

domainName

Type: string

Fully-qualified domain name to request a certificate for.

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

hostedZone

Type: IHostedZone

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.

certificateName?

Type: string (optional, default: the full, absolute path of this construct)

The Certificate name.

Since the Certificate resource doesn't support providing a physical name, the value provided here will be recorded in the Name tag

cleanupRoute53Records?

Type: boolean (optional, default: false)

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.

customResourceRole?

Type: IRole (optional, default: A new role will be created)

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

keyAlgorithm?

Type: KeyAlgorithm (optional, default: KeyAlgorithm.RSA_2048)

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.

region?

Type: string (optional, default: the region the stack is deployed in.)

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.

route53Endpoint?

Type: string (optional, default: The AWS SDK will determine the Route53 endpoint to use based on region)

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.

subjectAlternativeNames?

Type: string[] (optional, default: No additional FQDNs will be included as alternative domain names.)

Alternative domain names on your certificate.

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

transparencyLoggingEnabled?

Type: boolean (optional, default: true)

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.

validation?

Type: CertificateValidation (optional, default: CertificateValidation.fromEmail())

How to validate this certificate.