Class CloudAssemblyBuilder

Mutable builder for a CloudAssembly.

Created by App at the start of synthesis. Synthesizers use it to:

Write output files via writeFile()
Register stack artifacts via addArtifact()

Once all stacks are synthesized, App calls buildAssembly() which writes manifest.json and returns the immutable CloudAssembly.

Index

Constructors

Properties

Methods

addArtifact buildAssembly writeFile

Constructors

constructor

new CloudAssemblyBuilder(outdir: string): CloudAssemblyBuilder
Parameters
- outdir: string
  Absolute path to the output directory (e.g. /project/cdkx.out).
Returns CloudAssemblyBuilder
- Defined in packages/core/src/lib/assembly/cloud-assembly.ts:121

Properties

`Readonly`outdir

outdir: string

Absolute path to the output directory (e.g. /project/cdkx.out).

Methods

addArtifact

addArtifact(options: AddArtifactOptions): void
Registers a stack artifact. Called by each IStackSynthesizer after writing its output file.
Parameters
- options: AddArtifactOptions
Returns void
- Defined in packages/core/src/lib/assembly/cloud-assembly.ts:141

buildAssembly

buildAssembly(): CloudAssembly
Seals the assembly: writes manifest.json and returns the immutable CloudAssembly. Should be called exactly once, at the end of App.synth().

Returns CloudAssembly
- Defined in packages/core/src/lib/assembly/cloud-assembly.ts:167

writeFile

writeFile(fileName: string, content: string): void
Writes a file into the output directory. Creates the directory if it does not exist.
Parameters
- fileName: string
- content: string
Returns void
- Defined in packages/core/src/lib/assembly/cloud-assembly.ts:130