Class CfnCertificate.DomainValidationOptionProperty
DomainValidationOption
is a property of the AWS::CertificateManager::Certificate resource that specifies the AWS Certificate Manager ( ACM ) certificate domain to validate. Depending on the chosen validation method, ACM checks the domain's DNS record for a validation CNAME, or it attempts to send a validation email message to the domain owner.
Inheritance
Namespace: Amazon.CDK.AWS.CertificateManager
Assembly: Amazon.CDK.AWS.CertificateManager.dll
Syntax (csharp)
public class DomainValidationOptionProperty : Object, CfnCertificate.IDomainValidationOptionProperty
Syntax (vb)
Public Class DomainValidationOptionProperty
Inherits Object
Implements CfnCertificate.IDomainValidationOptionProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CertificateManager;
var domainValidationOptionProperty = new DomainValidationOptionProperty {
DomainName = "domainName",
// the properties below are optional
HostedZoneId = "hostedZoneId",
ValidationDomain = "validationDomain"
};
Synopsis
Constructors
DomainValidationOptionProperty() |
Properties
DomainName | A fully qualified domain name (FQDN) in the certificate request. |
HostedZoneId | The |
ValidationDomain | The domain name to which you want ACM to send validation emails. |
Constructors
DomainValidationOptionProperty()
public DomainValidationOptionProperty()
Properties
DomainName
A fully qualified domain name (FQDN) in the certificate request.
public string DomainName { get; set; }
Property Value
System.String
Remarks
HostedZoneId
The HostedZoneId
option, which is available if you are using Route 53 as your domain registrar, causes ACM to add your CNAME to the domain record.
public string HostedZoneId { get; set; }
Property Value
System.String
Remarks
Your list of DomainValidationOptions
must contain one and only one of the domain-validation options, and the HostedZoneId
can be used only when DNS
is specified as your validation method.
Use the Route 53 ListHostedZones
API to discover IDs for available hosted zones.
This option is required for publicly trusted certificates.
The ListHostedZones
API returns IDs in the format "/hostedzone/Z111111QQQQQQQ", but CloudFormation requires the IDs to be in the format "Z111111QQQQQQQ".
When you change your DomainValidationOptions
, a new resource is created.
ValidationDomain
The domain name to which you want ACM to send validation emails.
public string ValidationDomain { get; set; }
Property Value
System.String
Remarks
This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName
value or a superdomain of the DomainName
value. For example, if you request a certificate for testing.example.com
, you can specify example.com
as this value. In that case, ACM sends domain validation emails to the following five addresses: