interface ICertificate
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.CertificateManager.ICertificate |
Java | software.amazon.awscdk.services.certificatemanager.ICertificate |
Python | aws_cdk.aws_certificatemanager.ICertificate |
TypeScript (source) | @aws-cdk/aws-certificatemanager » ICertificate |
Implemented by
Certificate
, Dns
, Private
Obtainable from
Certificate
.fromCertificateArn()
, Private
.fromCertificateArn()
Represents a certificate in AWS Certificate Manager.
Properties
Name | Type | Description |
---|---|---|
certificate | string | The certificate's ARN. |
env | Resource | The environment this resource belongs to. |
node | Construct | The construct tree node for this construct. |
stack | Stack | The stack in which this resource is defined. |
certificateArn
Type:
string
The certificate's ARN.
env
Type:
Resource
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:
Construct
The construct tree node for this construct.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
metric | Return the DaysToExpiry metric for this AWS Certificate Manager Certificate. By default, this is the minimum value over 1 day. |
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
).
DaysToExpiry(props?)
metricpublic metricDaysToExpiry(props?: MetricOptions): Metric
Parameters
- props
Metric
Options
Returns
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".