interface DnsValidatedCertificateProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CertificateManager.DnsValidatedCertificateProps |
Java | software.amazon.awscdk.services.certificatemanager.DnsValidatedCertificateProps |
Python | aws_cdk.aws_certificatemanager.DnsValidatedCertificateProps |
TypeScript (source) | @aws-cdk/aws-certificatemanager » DnsValidatedCertificateProps |
Properties to create a DNS validated certificate managed by AWS Certificate Manager.
Example
declare const myHostedZone: route53.HostedZone;
new acm.DnsValidatedCertificate(this, 'CrossRegionCertificate', {
domainName: 'hello.example.com',
hostedZone: myHostedZone,
region: 'us-east-1',
});
Properties
Name | Type | Description |
---|---|---|
domain | string | Fully-qualified domain name to request a certificate for. |
hosted | IHosted | Route 53 Hosted Zone used to perform DNS validation of the request. |
cleanup | boolean | When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed. |
custom | IRole | Role to use for the custom resource that creates the validated certificate. |
region? | string | AWS region that will host the certificate. |
route53 | 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. |
subject | string[] | Alternative domain names on your certificate. |
validation? | Certificate | How to validate this certificate. |
validation | { [string]: string } | What validation domain to use for every requested domain. |
validation | Validation | Validation method used to assert domain ownership. |
domainName
Type:
string
Fully-qualified domain name to request a certificate for.
May contain wildcards, such as *.domain.com
.
hostedZone
Type:
IHosted
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.
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.
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.
validation?
Type:
Certificate
(optional, default: CertificateValidation.fromEmail())
How to validate this certificate.
validationDomains?
⚠️ Deprecated: use validation
instead.
Type:
{ [string]: string }
(optional, default: Apex domain is used for every domain that's not overridden.)
What validation domain to use for every requested domain.
Has to be a superdomain of the requested domain.
validationMethod?
⚠️ Deprecated: use validation
instead.
Type:
Validation
(optional, default: ValidationMethod.EMAIL)
Validation method used to assert domain ownership.