Class CfnCertificateProps
Properties for defining a CfnCertificate.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CertificateManager
Assembly: Amazon.CDK.AWS.CertificateManager.dll
Syntax (csharp)
public class CfnCertificateProps : Object, ICfnCertificatePropsSyntax (vb)
Public Class CfnCertificateProps
Inherits Object
Implements ICfnCertificatePropsRemarks
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 cfnCertificateProps = new CfnCertificateProps {
DomainName = "domainName",
// the properties below are optional
CertificateAuthorityArn = "certificateAuthorityArn",
CertificateTransparencyLoggingPreference = "certificateTransparencyLoggingPreference",
DomainValidationOptions = new [] { new DomainValidationOptionProperty {
DomainName = "domainName",
// the properties below are optional
HostedZoneId = "hostedZoneId",
ValidationDomain = "validationDomain"
} },
SubjectAlternativeNames = new [] { "subjectAlternativeNames" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
ValidationMethod = "validationMethod"
};Synopsis
Constructors
| CfnCertificateProps() |
Properties
| CertificateAuthorityArn | The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. |
| CertificateTransparencyLoggingPreference | You can opt out of certificate transparency logging by specifying the |
| DomainName | The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, |
| DomainValidationOptions | Domain information that domain name registrars use to verify your identity. |
| SubjectAlternativeNames | Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. |
| Tags | Key-value pairs that can identify the certificate. |
| ValidationMethod | The method you want to use to validate that you own or control the domain associated with a public certificate. |
Constructors
CfnCertificateProps()
public CfnCertificateProps()Properties
CertificateAuthorityArn
The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.
public string CertificateAuthorityArn { get; set; }Property Value
System.String
Remarks
If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the AWS Private Certificate Authority user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
CertificateTransparencyLoggingPreference
You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED .
public string CertificateTransparencyLoggingPreference { get; set; }Property Value
System.String
Remarks
If you do not specify a certificate transparency logging preference on a new CloudFormation template, or if you remove the logging preference from an existing template, this is the same as explicitly enabling the preference.
Changing the certificate transparency logging preference will update the existing resource by calling UpdateCertificateOptions on the certificate. This action will not create a new resource.
DomainName
The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com , site.example.com , and images.example.com..
public string DomainName { get; set; }Property Value
System.String
Remarks
DomainValidationOptions
Domain information that domain name registrars use to verify your identity.
public object DomainValidationOptions { get; set; }Property Value
System.Object
Remarks
In order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the DomainName property needs to be identical to one of the DomainName property supplied in DomainValidationOptions, if the ValidationMethod is DNS. Failing to keep them like-for-like will result in failure to create the domain validation records in Route53.
SubjectAlternativeNames
Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.
public string[] SubjectAlternativeNames { get; set; }Property Value
System.String[]
Remarks
For example, you can add www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name.
Tags
Key-value pairs that can identify the certificate.
public ICfnTag[] Tags { get; set; }Property Value
ICfnTag[]
Remarks
ValidationMethod
The method you want to use to validate that you own or control the domain associated with a public certificate.
public string ValidationMethod { get; set; }Property Value
System.String
Remarks
You can validate with DNS or validate with email . We recommend that you use DNS validation.
If not specified, this property defaults to email validation.