class Certificate (construct)

Language	Type name
.NET	Amazon.CDK.AWS.CertificateManager.Certificate
Java	software.amazon.awscdk.services.certificatemanager.Certificate
Python	aws_cdk.aws_certificatemanager.Certificate
TypeScript (source)	@aws-cdk/aws-certificatemanager » Certificate

Implements IConstruct, IConstruct, IDependable, IResource, ICertificate

A certificate managed by AWS Certificate Manager.

Example

const pool = new cognito.UserPool(this, 'Pool');

pool.addDomain('CognitoDomain', {
  cognitoDomain: {
    domainPrefix: 'my-awesome-app',
  },
});

const certificateArn = 'arn:aws:acm:us-east-1:123456789012:certificate/11-3336f1-44483d-adc7-9cd375c5169d';

const domainCert = certificatemanager.Certificate.fromCertificateArn(this, 'domainCert', certificateArn);
pool.addDomain('CustomDomain', {
  customDomain: {
    domainName: 'user.myapp.com',
    certificate: domainCert,
  },
});

Initializer

new Certificate(scope: Construct, id: string, props: CertificateProps)

Parameters

• scope Construct
• id string
• props CertificateProps

Construct Props

Name	Type	Description
domainName	string	Fully-qualified domain name to request a certificate for.
subjectAlternativeNames?	string[]	Alternative domain names on your certificate.
validation?	CertificateValidation	How to validate this certificate.
validationDomains?⚠️	{ [string]: string }	What validation domain to use for every requested domain.
validationMethod?⚠️	ValidationMethod	Validation method used to assert domain ownership.

---

domainName

Type: string

Fully-qualified domain name to request a certificate for.

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

---

subjectAlternativeNames?

Type: string[] (optional, default: No additional FQDNs will be included as alternative domain names.)

Alternative domain names on your certificate.

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

---

validation?

Type: CertificateValidation (optional, default: CertificateValidation.fromEmail())

How to validate this certificate.

---

validationDomains?⚠️

⚠️ Deprecated: use validation instead.

Type: { [string]: string } (optional, default: Apex domain is used for every domain that's not overridden.)

What validation domain to use for every requested domain.

Has to be a superdomain of the requested domain.

---

validationMethod?⚠️

⚠️ Deprecated: use validation instead.

Type: ValidationMethod (optional, default: ValidationMethod.EMAIL)

Validation method used to assert domain ownership.

Properties

Name	Type	Description
certificateArn	string	The certificate's ARN.
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
stack	Stack	The stack in which this resource is defined.
region?	string	If the certificate is provisionned in a different region than the containing stack, this should be the region in which the certificate lives so we can correctly create Metric instances.

---

certificateArn

Type: string

The certificate's ARN.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

---

region?

Type: string (optional)

If the certificate is provisionned in a different region than the containing stack, this should be the region in which the certificate lives so we can correctly create Metric instances.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
metricDaysToExpiry(props?)	Return the DaysToExpiry metric for this AWS Certificate Manager Certificate. By default, this is the minimum value over 1 day.
toString()	Returns a string representation of this construct.
static fromCertificateArn(scope, id, certificateArn)	Import a certificate.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

---

metricDaysToExpiry(props?)

public metricDaysToExpiry(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

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

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromCertificateArn(scope, id, certificateArn)

public static fromCertificateArn(scope: Construct, id: string, certificateArn: string): ICertificate

Parameters

• scope Construct
• id string
• certificateArn string

Returns

• ICertificate

Import a certificate.