aws-cdk-lib.aws_certificatemanager.ICertificate

interface ICertificate

LanguageType name
.NETAmazon.CDK.AWS.CertificateManager.ICertificate
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscertificatemanager#ICertificate
Javasoftware.amazon.awscdk.services.certificatemanager.ICertificate
Pythonaws_cdk.aws_certificatemanager.ICertificate
TypeScript (source)aws-cdk-lib » aws_certificatemanager » ICertificate

Implemented by Certificate, DnsValidatedCertificate, PrivateCertificate

Obtainable from Certificate.fromCertificateArn(), PrivateCertificate.fromCertificateArn()

Represents a certificate in AWS Certificate Manager.

Properties

NameTypeDescription
certificateArnstringThe certificate's ARN.
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

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: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.

Methods

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

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