cdk-utilities v0.0.7

CDK Utilities

Please Advise

This project is currently in development... all releases pre 0.1.0 are to be considered experimental

Purpose

Creating some interesting CDK Utility classes to provide deeper insights into deployable resources and construct trees

API Reference

Structs

KvMap

Initializer

import { KvMap } from 'cdk-utilities'

const kvMap: KvMap = { ... }

Classes

ConstructTreeParser

Initializer

import { ConstructTreeParser } from 'cdk-utilities'

new ConstructTreeParser(node: App)

nodeRequired

• Type: @aws-cdk/core.App

Methods

generateParseTree

public generateParseTree()

generateTreeStructure

public generateTreeStructure()

Properties

rootNodeRequired

• Type: @aws-cdk/core.App

Node

Initializer

import { Node } from 'cdk-utilities'

new Node(node: ConstructNode, parent?: Node, children?: Node[])

nodeRequired

• Type: @aws-cdk/core.ConstructNode

parentOptional

• Type: cdk-utilities.Node

childrenOptional

• Type: cdk-utilities.Node[]

Methods

accept

public accept(visitor: IVisitor)

visitorRequired

• Type: cdk-utilities.IVisitor

addChild

public addChild(node: Node)

nodeRequired

• Type: cdk-utilities.Node

Properties

nodeIdRequired

• Type: string

nodePathRequired

• Type: string

originalNodeRequired

• Type: @aws-cdk/core.ConstructNode

childrenNodesRequired

• Type: cdk-utilities.Node[]

parentNodeRequired

• Type: cdk-utilities.Node

ParseTree

Initializer

import { ParseTree } from 'cdk-utilities'

new ParseTree(app: App)

appRequired

• Type: @aws-cdk/core.App

Methods

createTree

public createTree(constructNode: ConstructNode, parent?: Node)

constructNodeRequired

• Type: @aws-cdk/core.ConstructNode

parentOptional

• Type: cdk-utilities.Node

findPaths

public findPaths()

genTreeStructure

public genTreeStructure()

PrintTreeStructureVisitor

• Implements: cdk-utilities.IVisitor

Initializer

import { PrintTreeStructureVisitor } from 'cdk-utilities'

new PrintTreeStructureVisitor()

Methods

makeIndent

public makeIndent()

postVisit

public postVisit(node: Node)

nodeRequired

• Type: cdk-utilities.Node

preVisit

public preVisit(node: Node)

nodeRequired

• Type: cdk-utilities.Node

visit

public visit(node: Node)

nodeRequired

• Type: cdk-utilities.Node

Properties

indentRequired

• Type: string

indentLevelRequired

• Type: number

knownChildrenSeenRequired

• Type: cdk-utilities.KvMap

lastIndentLevelRequired

• Type: number

outputRequired

• Type: string

PrintVisitor

• Implements: cdk-utilities.IVisitor

Initializer

import { PrintVisitor } from 'cdk-utilities'

new PrintVisitor()

Methods

postVisit

public postVisit(node: Node)

nodeRequired

• Type: cdk-utilities.Node

preVisit

public preVisit(node: Node)

nodeRequired

• Type: cdk-utilities.Node

visit

public visit(node: Node)

nodeRequired

• Type: cdk-utilities.Node

Properties

pathsRequired

• Type: string

Protocols

IVisitor

• Implemented By: cdk-utilities.PrintTreeStructureVisitor, cdk-utilities.PrintVisitor, cdk-utilities.IVisitor

Methods

postVisit

public postVisit(node: Node)

nodeRequired

• Type: cdk-utilities.Node

preVisit

public preVisit(node: Node)

nodeRequired

• Type: cdk-utilities.Node

visit

public visit(node: Node)

nodeRequired

• Type: cdk-utilities.Node