Class CfnCertificate

A CloudFormation AWS::CertificateManager::Certificate.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnCertificate
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.CertificateManager
Assembly: Amazon.CDK.AWS.CertificateManager.dll
Syntax (csharp)
public class CfnCertificate : CfnResource, IConstruct, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCertificate
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable
Remarks

The AWS::CertificateManager::Certificate resource requests an AWS Certificate Manager ( ACM ) certificate that you can use to enable secure connections. 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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html

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;

CfnCertificate 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"
    } },
    SubjectAlternativeNames = new [] { "subjectAlternativeNames" },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    ValidationMethod = "validationMethod"
});

Synopsis

Constructors

CfnCertificate(Construct, String, ICfnCertificateProps)

Create a new AWS::CertificateManager::Certificate.
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

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 DISABLED option. Opt in by specifying ENABLED .
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, *.example.com protects www.example.com , site.example.com , and images.example.com..
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnCertificate(Construct, String, ICfnCertificateProps)

Create a new AWS::CertificateManager::Certificate.

public CfnCertificate(Construct scope, string id, ICfnCertificateProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnCertificateProps
  • resource properties.

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

Properties

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

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 Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificateauthorityarn

CertificateTransparencyLoggingPreference

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED .

public virtual 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificatetransparencyloggingpreference

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

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainname

DomainValidationOptions

Domain information that domain name registrars use to verify your identity.

public virtual 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainvalidationoptions

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[]

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-subjectalternativenames

Tags

Key-value pairs that can identify the certificate.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-tags

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

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-validationmethod

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>

Overrides

Implements

Constructs.IConstruct