A certificate managed by AWS Certificate Manager.

Return the DaysToExpiry metric for this AWS Certificate Manager Certificate. By default, this is the minimum value over 1 day.

This metric is no longer emitted once the certificate has effectively
expired, so alarms configured on this metric should probably treat missing
data as "breaching".

metricDaysToExpiry

Certificate

Fully-qualified domain name to request a certificate for.

May contain wildcards, such as ``*.domain.com``.

domainName

Enable or disable export of this certificate.

If you issue an exportable public certificate, there is a charge at certificate issuance and again when the certificate renews.
Ref: https://aws.amazon.com/certificate-manager/pricing

allowExport

The Certificate name.

Since the Certificate resource doesn't support providing a physical name, the value provided here will be recorded in the `Name` tag

certificateName

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.

keyAlgorithm

Alternative domain names on your certificate.

Use this to register alternative domain names that represent the same site.

subjectAlternativeNames

Enable or disable transparency logging for this certificate.

Once a certificate has been logged, it cannot be removed from the log.
Opting out at that point will have no effect. If you opt out of logging
when you request a certificate and then choose later to opt back in,
your certificate will not be logged until it is renewed.
If you want the certificate to be logged immediately, we recommend that you issue a new one.

transparencyLoggingEnabled

validation

A certificate managed by AWS Certificate Manager.

Will be automatically
validated using DNS validation against the specified Route 53 hosted zone.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops
being managed by CloudFormation, either because you've removed it from the
CDK application or because you've made a change that requires the resource
to be replaced.

The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

applyRemovalPolicy

DnsValidatedCertificate

Route 53 Hosted Zone used to perform DNS validation of the request.

The zone
must be authoritative for the domain name specified in the Certificate Request.

hostedZone

When set to true, when the DnsValidatedCertificate is deleted, the associated Route53 validation records are removed.

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.

cleanupRoute53Records

Role to use for the custom resource that creates the validated certificate.

customResourceRole

AWS region that will host the certificate.

This is needed especially
for certificates used for CloudFront distributions, which require the region
to be us-east-1.

region

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.

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.

route53Endpoint

A private certificate managed by AWS Certificate Manager.

PrivateCertificate

Private certificate authority (CA) that will be used to issue the certificate.

certificateAuthority

Fully-qualified domain name to request a private certificate for.

May contain wildcards, such as ``*.domain.com``.

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.

When you request a private PKI certificate signed by a CA from AWS Private CA, the specified signing algorithm family
(RSA or ECDSA) must match the algorithm family of the CA's secret key.

Alternative domain names on your private certificate.

Use this to register alternative domain names that represent the same site.

The `AWS::CertificateManager::Account` resource defines the expiry event configuration that determines the number of days prior to expiry when ACM starts generating EventBridge events.

CfnAccount

Object containing expiration events options associated with an AWS account .

For more information, see [ExpiryEventsConfiguration](https://docs.aws.amazon.com/acm/latest/APIReference/API_ExpiryEventsConfiguration.html) in the API reference.

expiryEventsConfiguration

The `AWS::CertificateManager::Certificate` resource requests an 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](https://docs.aws.amazon.com/acm/latest/APIReference/API_RequestCertificate.html) in the 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](https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html) and [Option 2: Email Validation](https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html) .

CfnCertificate

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.`.

The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.

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](https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) user guide. The ARN must have the following form:

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

certificateAuthorityArn

You can opt out of allowing export of your certificate by specifying the `DISABLED` option.

Allow export of your certificate by specifying the `ENABLED` option.

If you do not specify an export preference in a new CloudFormation template, it is the same as explicitly denying export of your certificate.

certificateExport

You can opt out of certificate transparency logging by specifying the `DISABLED` option.

Opt in by specifying `ENABLED` . This setting doces not apply to private certificates.

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.

certificateTransparencyLoggingPreference

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

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

domainValidationOptions

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data.

RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some AWS services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the AWS service where you plan to deploy your certificate. For more information about selecting an algorithm, see [Key algorithms](https://docs.aws.amazon.com/acm/latest/userguide/acm-certificate-characteristics.html#algorithms-term) .

> Algorithms supported for an ACM certificate request include:
>
> - `RSA_2048`
> - `EC_prime256v1`
> - `EC_secp384r1`
>
> Other listed algorithms are for imported certificates only. > When you request a private PKI certificate signed by a CA from AWS Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.

Default: RSA_2048

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.

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.

Key-value pairs that can identify the certificate.

AWS Certificate Manager

L2 Constructs3

Certificate

DnsValidatedCertificate

PrivateCertificate

L1 Constructs2

CfnAccount

CfnCertificate

Learn AWS the Practical Way

Quick Facts

Related Links