CloudAssemblyBuilder

Can be used to build a cloud assembly.

Initializers

import { CloudAssemblyBuilder } from '@alicloud/ros-cdk-cxapi'
new CloudAssemblyBuilder(outdir?: string, props?: CloudAssemblyBuilderProps)

Name	Type	Description
outdir	string	The output directory, uses temporary directory if undefined.
props	CloudAssemblyBuilderProps	No description.

---

outdir^Optional

• Type: string

The output directory, uses temporary directory if undefined.

---

props^Optional

• Type: CloudAssemblyBuilderProps

---

Methods

Name	Description
addArtifact	Adds an artifact into the cloud assembly.
addMissing	Reports that some context is missing in order for this cloud assembly to be fully synthesized.
buildAssembly	Finalizes the cloud assembly into the output directory returns a 'CloudAssembly' object that can be used to inspect the assembly.
createNestedAssembly	Creates a nested cloud assembly.

---

addArtifact

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

Adds an artifact into the cloud assembly.

id^Required

• Type: string

The ID of the artifact.

---

manifest^Required

• Type: @alicloud/ros-cdk-assembly-schema.ArtifactManifest

The artifact manifest.

---

addMissing

public addMissing(missing: MissingContext): void

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

missing^Required

• Type: @alicloud/ros-cdk-assembly-schema.MissingContext

Missing context information.

---

buildAssembly

public buildAssembly(options?: AssemblyBuildOptions): CloudAssembly

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

options^Optional

• Type: AssemblyBuildOptions

---

createNestedAssembly

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

Creates a nested cloud assembly.

artifactId^Required

• Type: string

---

displayName^Required

• Type: string

---

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^Required

public readonly assetOutdir: string;

• Type: string

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

---

outdir^Required

public readonly outdir: string;

• Type: string

The root directory of the resulting cloud assembly.

---