class CloudAssemblyBuilder

Language	Type name
.NET	Amazon.CDK.CXAPI.CloudAssemblyBuilder
Go	github.com/aws/aws-cdk-go/awscdk/v2/cxapi#CloudAssemblyBuilder
Java	software.amazon.awscdk.cxapi.CloudAssemblyBuilder
Python	aws_cdk.cx_api.CloudAssemblyBuilder
TypeScript (source)	aws-cdk-lib » cx_api » CloudAssemblyBuilder

Can be used to build a cloud assembly.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cx_api } from 'aws-cdk-lib';

declare const cloudAssemblyBuilder_: cx_api.CloudAssemblyBuilder;
const cloudAssemblyBuilder = new cx_api.CloudAssemblyBuilder(/* all optional props */ 'outdir', /* all optional props */ {
  assetOutdir: 'assetOutdir',
  parentBuilder: cloudAssemblyBuilder_,
});

Initializer

new CloudAssemblyBuilder(outdir?: string, props?: CloudAssemblyBuilderProps)

Parameters

• outdir string — The output directory, uses temporary directory if undefined.
• props CloudAssemblyBuilderProps

Initializes a cloud assembly builder.

Properties

Name	Type	Description
assetOutdir	string	The directory where assets of this Cloud Assembly should be stored.
outdir	string	The root directory of the resulting cloud assembly.

---

assetOutdir

Type: string

The directory where assets of this Cloud Assembly should be stored.

---

outdir

Type: string

The root directory of the resulting cloud assembly.

Methods

Name	Description
addArtifact(id, manifest)	Adds an artifact into the cloud assembly.
addMissing(missing)	Reports that some context is missing in order for this cloud assembly to be fully synthesized.
buildAssembly(options?)	Finalizes the cloud assembly into the output directory returns a CloudAssembly object that can be used to inspect the assembly.
createNestedAssembly(artifactId, displayName)	Creates a nested cloud assembly.
delete()	Delete the cloud assembly directory.

---

addArtifact(id, manifest)

public addArtifact(id: string, manifest: ArtifactManifest): void

Parameters

• id string — The ID of the artifact.
• manifest ArtifactManifest — The artifact manifest.

Adds an artifact into the cloud assembly.

---

addMissing(missing)

public addMissing(missing: MissingContext): void

Parameters

• missing MissingContext — Missing context information.

Reports that some context is missing in order for this cloud assembly to be fully synthesized.

---

buildAssembly(options?)

public buildAssembly(options?: AssemblyBuildOptions): CloudAssembly

Parameters

• options AssemblyBuildOptions

Returns

• CloudAssembly

Finalizes the cloud assembly into the output directory returns a CloudAssembly object that can be used to inspect the assembly.

---

createNestedAssembly(artifactId, displayName)

public createNestedAssembly(artifactId: string, displayName: string): CloudAssemblyBuilder

Parameters

• artifactId string
• displayName string

Returns

• CloudAssemblyBuilder

Creates a nested cloud assembly.

---

delete()

public delete(): void

Delete the cloud assembly directory.