Skip to content

Latest commit

 

History

History
311 lines (194 loc) · 11 KB

API.md

File metadata and controls

311 lines (194 loc) · 11 KB
Raw

API Reference

Constructs

NoopStack

Initializers 

import { NoopStack } from '@cdktf/construct-projen-template'

new NoopStack(scope: Construct, name: string)
Name Type Description
scope constructs.Construct No description.
name string No description.
scopeRequired
  • Type: constructs.Construct
nameRequired
  • Type: string

Methods

Name Description
toString Returns a string representation of this construct.
addDependency No description.
addOverride No description.
allProviders No description.
dependsOn No description.
ensureBackendExists No description.
getLogicalId No description.
hasResourceMove No description.
prepareStack No description.
registerIncomingCrossStackReference No description.
registerOutgoingCrossStackReference No description.
runAllValidations Run all validations on the stack.
toHclTerraform No description.
toTerraform No description.
toString 
public toString(): string

Returns a string representation of this construct.

addDependency 
public addDependency(dependency: TerraformStack): void
dependencyRequired
  • Type: cdktf.TerraformStack
addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
allProviders 
public allProviders(): TerraformProvider[]
dependsOn 
public dependsOn(stack: TerraformStack): boolean
stackRequired
  • Type: cdktf.TerraformStack
ensureBackendExists 
public ensureBackendExists(): TerraformBackend
getLogicalId 
public getLogicalId(tfElement: Node | TerraformElement): string
tfElementRequired
  • Type: constructs.Node | cdktf.TerraformElement
hasResourceMove 
public hasResourceMove(): boolean
prepareStack 
public prepareStack(): void
registerIncomingCrossStackReference 
public registerIncomingCrossStackReference(fromStack: TerraformStack): TerraformRemoteState
fromStackRequired
  • Type: cdktf.TerraformStack
registerOutgoingCrossStackReference 
public registerOutgoingCrossStackReference(identifier: string): TerraformOutput
identifierRequired
  • Type: string
runAllValidations 
public runAllValidations(): void

Run all validations on the stack.

toHclTerraform 
public toHclTerraform(): {[ key: string ]: any}
toTerraform 
public toTerraform(): any

Static Functions

Name Description
isConstruct Checks if x is a construct.
isStack No description.
of No description.
isConstruct 
import { NoopStack } from '@cdktf/construct-projen-template'

NoopStack.isConstruct(x: any)

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.

xRequired
  • Type: any

Any object.

isStack 
import { NoopStack } from '@cdktf/construct-projen-template'

NoopStack.isStack(x: any)
xRequired
  • Type: any
of 
import { NoopStack } from '@cdktf/construct-projen-template'

NoopStack.of(construct: IConstruct)
constructRequired
  • Type: constructs.IConstruct

Properties

Name Type Description
node constructs.Node The tree node.
dependencies cdktf.TerraformStack[] No description.
moveTargets cdktf.TerraformResourceTargets No description.
synthesizer cdktf.IStackSynthesizer No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

dependenciesRequired 
public readonly dependencies: TerraformStack[];
  • Type: cdktf.TerraformStack[]
moveTargetsRequired 
public readonly moveTargets: TerraformResourceTargets;
  • Type: cdktf.TerraformResourceTargets
synthesizerRequired 
public readonly synthesizer: IStackSynthesizer;
  • Type: cdktf.IStackSynthesizer