Class DnsValidatedCertificateProps
Properties to create a DNS validated certificate managed by AWS Certificate Manager.
Inheritance
Namespace: Amazon.CDK.AWS.CertificateManager
Assembly: Amazon.CDK.AWS.CertificateManager.dll
Syntax (csharp)
public class DnsValidatedCertificateProps : Object, IDnsValidatedCertificateProps, ICertificateProps
Syntax (vb)
Public Class DnsValidatedCertificateProps
Inherits Object
Implements IDnsValidatedCertificateProps, ICertificateProps
Remarks
ExampleMetadata: infused
Examples
HostedZone myHostedZone;
new DnsValidatedCertificate(this, "CrossRegionCertificate", new DnsValidatedCertificateProps {
DomainName = "hello.example.com",
HostedZone = myHostedZone,
Region = "us-east-1"
});
Synopsis
Constructors
DnsValidatedCertificateProps() |
Properties
CleanupRoute53Records | When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed. |
CustomResourceRole | Role to use for the custom resource that creates the validated certificate. |
DomainName | Fully-qualified domain name to request a certificate for. |
HostedZone | Route 53 Hosted Zone used to perform DNS validation of the request. |
Region | AWS region that will host the certificate. |
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. |
SubjectAlternativeNames | Alternative domain names on your certificate. |
Validation | How to validate this certificate. |
ValidationDomains | (deprecated) What validation domain to use for every requested domain. |
ValidationMethod | (deprecated) Validation method used to assert domain ownership. |
Constructors
DnsValidatedCertificateProps()
public DnsValidatedCertificateProps()
Properties
CleanupRoute53Records
When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed.
public Nullable<bool> CleanupRoute53Records { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
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
CustomResourceRole
Role to use for the custom resource that creates the validated certificate.
public IRole CustomResourceRole { get; set; }
Property Value
Remarks
Default: - A new role will be created
DomainName
Fully-qualified domain name to request a certificate for.
public string DomainName { get; set; }
Property Value
System.String
Remarks
May contain wildcards, such as *.domain.com
.
HostedZone
Route 53 Hosted Zone used to perform DNS validation of the request.
public IHostedZone HostedZone { get; set; }
Property Value
Remarks
The zone must be authoritative for the domain name specified in the Certificate Request.
Region
AWS region that will host the certificate.
public string Region { get; set; }
Property Value
System.String
Remarks
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.
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.
public string Route53Endpoint { get; set; }
Property Value
System.String
Remarks
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
SubjectAlternativeNames
Alternative domain names on your certificate.
public string[] SubjectAlternativeNames { get; set; }
Property Value
System.String[]
Remarks
Use this to register alternative domain names that represent the same site.
Default: - No additional FQDNs will be included as alternative domain names.
Validation
How to validate this certificate.
public CertificateValidation Validation { get; set; }
Property Value
Remarks
Default: CertificateValidation.fromEmail()
ValidationDomains
(deprecated) What validation domain to use for every requested domain.
public IDictionary<string, string> ValidationDomains { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Has to be a superdomain of the requested domain.
Default: - Apex domain is used for every domain that's not overridden.
Stability: Deprecated
ValidationMethod
(deprecated) Validation method used to assert domain ownership.
public Nullable<ValidationMethod> ValidationMethod { get; set; }
Property Value
System.Nullable<ValidationMethod>
Remarks
Default: ValidationMethod.EMAIL
Stability: Deprecated