Skip to content

Latest commit

 

History

History
145 lines (83 loc) · 3.95 KB

API.md

File metadata and controls

145 lines (83 loc) · 3.95 KB
Raw

API Reference

Constructs

AwsCleaner

Initializers 

import { AwsCleaner } from 'cdk-aws-cleaner'

new AwsCleaner(scope: Construct, id: string, props: IAwsCleanerProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props IAwsCleanerProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { AwsCleaner } from 'cdk-aws-cleaner'

AwsCleaner.isConstruct(x: any)

Checks if x is a construct.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Protocols

IAwsCleanerProps

Properties

Name Type Description
cleanup aws-cdk-lib.Duration When the Stack should be removed.
email string E-Mail Notification for the removal event.
cleanupRequired 
public readonly cleanup: Duration;
  • Type: aws-cdk-lib.Duration

When the Stack should be removed.

emailRequired 
public readonly email: string;
  • Type: string

E-Mail Notification for the removal event.