Class CfnCertificate
The AWS::CertificateManager::Certificate
resource requests an AWS Certificate Manager ( ACM ) certificate that you can use to enable secure connections.
Inherited Members
Namespace: Amazon.CDK.AWS.CertificateManager
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCertificate : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnCertificate
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For example, you can deploy an ACM certificate to an Elastic Load Balancer to enable HTTPS support. For more information, see RequestCertificate in the AWS Certificate Manager API Reference.
When you use the AWS::CertificateManager::Certificate
resource in a CloudFormation stack, domain validation is handled automatically if all three of the following are true: The certificate domain is hosted in Amazon Route 53, the domain resides in your AWS account , and you are using DNS validation.
However, if the certificate uses email validation, or if the domain is not hosted in Route 53, then the stack will remain in the CREATE_IN_PROGRESS
state. Further stack operations are delayed until you validate the certificate request, either by acting upon the instructions in the validation email, or by adding a CNAME record to your DNS configuration. For more information, see Option 1: DNS Validation and Option 2: Email Validation .
CloudformationResource: AWS::CertificateManager::Certificate
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 cfnCertificate = new CfnCertificate(this, "MyCfnCertificate", 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"
} },
KeyAlgorithm = "keyAlgorithm",
SubjectAlternativeNames = new [] { "subjectAlternativeNames" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
ValidationMethod = "validationMethod"
});
Synopsis
Constructors
CfnCertificate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCertificate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnCertificate(Construct, String, ICfnCertificateProps) |
Properties
AttrId | |
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 |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
KeyAlgorithm | Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. |
SubjectAlternativeNames | Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCertificate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCertificate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCertificate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCertificate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnCertificate(Construct, String, ICfnCertificateProps)
public CfnCertificate(Construct scope, string id, ICfnCertificateProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnCertificateProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CertificateAuthorityArn
The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.
public virtual string CertificateAuthorityArn { get; set; }
Property Value
System.String
CertificateTransparencyLoggingPreference
You can opt out of certificate transparency logging by specifying the DISABLED
option.
public virtual string CertificateTransparencyLoggingPreference { get; set; }
Property Value
System.String
Remarks
Opt in by specifying ENABLED
.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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 virtual string DomainName { get; set; }
Property Value
System.String
DomainValidationOptions
Domain information that domain name registrars use to verify your identity.
public virtual object DomainValidationOptions { get; set; }
Property Value
System.Object
KeyAlgorithm
Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.
public virtual string KeyAlgorithm { get; set; }
Property Value
System.String
SubjectAlternativeNames
Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.
public virtual string[] SubjectAlternativeNames { get; set; }
Property Value
System.String[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Key-value pairs that can identify the certificate.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
ValidationMethod
The method you want to use to validate that you own or control the domain associated with a public certificate.
public virtual string ValidationMethod { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>