Skip to content

@openfabr/cdf / Exports / cdktf / ProjectStack

Class: ProjectStack<IPC, GC, NC, CC, SC, RC>

cdktf.ProjectStack

Stack as top-level construct with CDKTF as IaC runtime.

Type parameters

Name Type
IPC extends InfraPlanConstructs
GC extends GeneralConfig
NC extends NetworkConfig
CC extends ComponentConfig
SC extends ServiceConfig
RC extends RelationConfig

Hierarchy

  • TerraformStack

↳ ProjectStack

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new ProjectStack<IPC, GC, NC, CC, SC, RC>(scope, id, props)

Type parameters

Name Type
IPC extends InfraPlanConstructs
GC extends GeneralConfig
NC extends NetworkConfig
CC extends ComponentConfig
SC extends ServiceConfig
RC extends RelationConfig

Parameters

Name Type
scope Construct
id string
props ProjectStackProps<IPC, GC, NC, CC, SC, RC>

Overrides

TerraformStack.constructor

Defined in

src/lib/bootstrap/cdktf/stack.ts:46

Properties

dependencies

• dependencies: TerraformStack[]

Inherited from

TerraformStack.dependencies

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:20

node

• Readonly node: Node

The tree node.

Inherited from

TerraformStack.node

Defined in

node_modules/constructs/lib/construct.d.ts:247

synthesizer

• synthesizer: IStackSynthesizer

Inherited from

TerraformStack.synthesizer

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:19

Methods

addDependency

▸ addDependency(dependency): void

Parameters

Name Type
dependency TerraformStack

Returns

void

Inherited from

TerraformStack.addDependency

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:42

addOverride

▸ addOverride(path, value): void

Parameters

Name Type
path string
value any

Returns

void

Inherited from

TerraformStack.addOverride

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:26

allProviders

▸ allProviders(): TerraformProvider[]

Returns

TerraformProvider[]

Inherited from

TerraformStack.allProviders

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:36

allocateLogicalId

▸ Protected allocateLogicalId(tfElement): string

Returns the naming scheme used to allocate logical IDs. By default, uses the HashedAddressingScheme but this method can be overridden to customize this behavior.

Parameters

Name Type Description
tfElement Node | TerraformElement The element for which the logical ID is allocated.

Returns

string

Inherited from

TerraformStack.allocateLogicalId

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:35

dependsOn

▸ dependsOn(stack): boolean

Parameters

Name Type
stack TerraformStack

Returns

boolean

Inherited from

TerraformStack.dependsOn

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:41

ensureBackendExists

▸ ensureBackendExists(): TerraformBackend

Returns

TerraformBackend

Inherited from

TerraformStack.ensureBackendExists

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:37

getLogicalId

▸ getLogicalId(tfElement): string

Parameters

Name Type
tfElement Node | TerraformElement

Returns

string

Inherited from

TerraformStack.getLogicalId

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:27

prepareStack

▸ prepareStack(): void

Returns

void

Inherited from

TerraformStack.prepareStack

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:25

registerIncomingCrossStackReference

▸ registerIncomingCrossStackReference(fromStack): TerraformRemoteState

Parameters

Name Type
fromStack TerraformStack

Returns

TerraformRemoteState

Inherited from

TerraformStack.registerIncomingCrossStackReference

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:40

registerOutgoingCrossStackReference

▸ registerOutgoingCrossStackReference(identifier): TerraformOutput

Parameters

Name Type
identifier string

Returns

TerraformOutput

Inherited from

TerraformStack.registerOutgoingCrossStackReference

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:39

runAllValidations

▸ runAllValidations(): void

Run all validations on the stack.

Returns

void

Inherited from

TerraformStack.runAllValidations

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:46

toString

▸ toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

TerraformStack.toString

Defined in

node_modules/constructs/lib/construct.d.ts:260

toTerraform

▸ toTerraform(): any

Returns

any

Inherited from

TerraformStack.toTerraform

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:38

isConstruct

▸ Static isConstruct(x): 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

Name Type Description
x any Any object

Returns

x is Construct

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

Inherited from

TerraformStack.isConstruct

Defined in

node_modules/constructs/lib/construct.d.ts:243

isStack

▸ Static isStack(x): x is TerraformStack

Parameters

Name Type
x any

Returns

x is TerraformStack

Inherited from

TerraformStack.isStack

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:22

of

▸ Static of(construct): TerraformStack

Parameters

Name Type
construct IConstruct

Returns

TerraformStack

Inherited from

TerraformStack.of

Defined in

node_modules/cdktf/lib/terraform-stack.d.ts:23