Class GuCertificate

Construct which creates a DNS-validated ACM Certificate.

If your DNS is managed via Route 53, then supplying hostedZoneId props will allow AWS to automatically validate your certificate.

If your DNS is not managed via Route 53, or you omit the hostedZoneId props, then the CloudFormation operation which adds this construct will pause until the relevant DNS record has been added manually.

Hierarchy

  • Mixin<typeof Certificate, this> & Certificate<this>
    • GuCertificate

Constructors

constructor

Properties

certificateArn env idWithApp node physicalName region? stack

Methods

_enableCrossEnvironment applyRemovalPolicy generatePhysicalName getResourceArnAttribute getResourceNameAttribute metricDaysToExpiry toString fromCertificateArn isConstruct isOwnedResource isResource

Constructors

constructor

Properties

ReadonlycertificateArn

certificateArn: string

The certificate's ARN

Readonlyenv

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

ReadonlyidWithApp

idWithApp: string

The ID of the construct with the App suffix. This should be used in place of id when trying to reference the construct.

Readonlynode

node: Node

The tree node.

Protected ReadonlyphysicalName

physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Protected Optional Readonlyregion

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.

Readonlystack

stack: Stack

The stack in which this resource is defined.

Methods

_enableCrossEnvironment

  • _enableCrossEnvironment(): void
  • Internal

    Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

    Returns void

applyRemovalPolicy

  • applyRemovalPolicy(policy: RemovalPolicy): void

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

    Parameters

    • policy: RemovalPolicy

    Returns void

ProtectedgeneratePhysicalName

  • generatePhysicalName(): string

  • Returns string

ProtectedgetResourceArnAttribute

  • getResourceArnAttribute(arnAttr: string, arnComponents: ArnComponents): string

  • Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

    Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arnComponents.

    Parameters

    • arnAttr: string

      The CFN attribute which resolves to the ARN of the resource. Commonly it will be called "Arn" (e.g. resource.attrArn), but sometimes it's the CFN resource's ref.

    • arnComponents: ArnComponents

      The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

    Returns string

ProtectedgetResourceNameAttribute

  • getResourceNameAttribute(nameAttr: string): string

  • Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

    Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

    Parameters

    • nameAttr: string

      The CFN attribute which resolves to the resource's name. Commonly this is the resource's ref.

    Returns string

metricDaysToExpiry

  • metricDaysToExpiry(props?: MetricOptions): 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".

    Parameters

    • Optionalprops: MetricOptions

    Returns Metric

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

StaticfromCertificateArn

  • fromCertificateArn(
        scope: Construct,
        id: string,
        certificateArn: string,
    ): ICertificate

  • Import a certificate

    Parameters

    • scope: Construct
    • id: string
    • certificateArn: string

    Returns ICertificate

StaticisConstruct

  • isConstruct(x: any): x is Construct

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

StaticisOwnedResource

  • isOwnedResource(construct: IConstruct): boolean

  • Returns true if the construct was created by CDK, and false otherwise

    Parameters

    • construct: IConstruct

    Returns boolean

StaticisResource

  • isResource(construct: IConstruct): construct is Resource

  • Check whether the given construct is a Resource

    Parameters

    • construct: IConstruct

    Returns construct is Resource

Settings

Member Visibility

On This Page

Constructors
Properties
Methods