software.amazon.awscdk.services.certificatemanager

Class PrivateCertificate

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.certificatemanager.PrivateCertificate

All Implemented Interfaces:

IConstruct, IDependable, IResource, ICertificate

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.092Z")
public class PrivateCertificate
extends Resource
implements ICertificate

A private certificate managed by AWS Certificate Manager.

Example:

 import software.amazon.awscdk.services.acmpca.*;
 PrivateCertificate.Builder.create(this, "PrivateCertificate")
         .domainName("test.example.com")
         .subjectAlternativeNames(List.of("cool.example.com", "test.example.net")) // optional
         .certificateAuthority(CertificateAuthority.fromCertificateAuthorityArn(this, "CA", "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/023077d8-2bfa-4eb0-8f22-05c96deade77"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrivateCertificate.Builder A fluent builder for PrivateCertificate.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.certificatemanager.ICertificate

ICertificate.Jsii$Default, ICertificate.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PrivateCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PrivateCertificate(software.amazon.jsii.JsiiObjectRef objRef)
	PrivateCertificate(software.constructs.Construct scope, java.lang.String id, PrivateCertificateProps props)

Method Summary

Modifier and Type	Method and Description
static ICertificate	fromCertificateArn(software.constructs.Construct scope, java.lang.String id, java.lang.String certificateArn) Import a certificate.
java.lang.String	getCertificateArn() The certificate's ARN.
protected java.lang.String	getRegion() 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.
Metric	metricDaysToExpiry() Return the DaysToExpiry metric for this AWS Certificate Manager Certificate.
Metric	metricDaysToExpiry(MetricOptions props) Return the DaysToExpiry metric for this AWS Certificate Manager Certificate.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

PrivateCertificate

protected PrivateCertificate(software.amazon.jsii.JsiiObjectRef objRef)

PrivateCertificate

protected PrivateCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

PrivateCertificate

public PrivateCertificate(software.constructs.Construct scope,
                          java.lang.String id,
                          PrivateCertificateProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromCertificateArn

public static ICertificate fromCertificateArn(software.constructs.Construct scope,
                                              java.lang.String id,
                                              java.lang.String certificateArn)

Import a certificate.

Parameters:

scope - This parameter is required.

id - This parameter is required.

certificateArn - This parameter is required.

metricDaysToExpiry

public Metric metricDaysToExpiry(MetricOptions props)

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

Specified by:

metricDaysToExpiry in interface ICertificate

Parameters:

props -

metricDaysToExpiry

public Metric metricDaysToExpiry()

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

Specified by:

metricDaysToExpiry in interface ICertificate

getCertificateArn

public java.lang.String getCertificateArn()

The certificate's ARN.

Specified by:

getCertificateArn in interface ICertificate

getRegion

protected java.lang.String getRegion()

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.