Skip to content

CloudAssembly

Represents a deployable cloud application.

Initializers 

import { CloudAssembly } from '@alicloud/ros-cdk-cxapi'
new CloudAssembly(directory: string)
Name Type Description
directory string The root directory of the assembly.

directoryRequired

  • Type: string

The root directory of the assembly.

Methods

Name Description
getNestedAssembly Returns a nested assembly.
getNestedAssemblyArtifact Returns a nested assembly artifact.
getStack Returns a ROS stack artifact by name from this assembly.
getStackArtifact Returns a ROS stack artifact from this assembly.
getStackByName Returns a ROS stack artifact from this assembly.
tree Returns the tree metadata artifact from this assembly.
tryGetArtifact Attempts to find an artifact with a specific identity.

getNestedAssembly 

public getNestedAssembly(artifactId: string): CloudAssembly

Returns a nested assembly.

artifactIdRequired

  • Type: string

The artifact ID of the nested assembly.

getNestedAssemblyArtifact 

public getNestedAssemblyArtifact(artifactId: string): NestedCloudAssemblyArtifact

Returns a nested assembly artifact.

artifactIdRequired

  • Type: string

The artifact ID of the nested assembly.

getStack 

public getStack(stackName: string): RosStackArtifact

Returns a ROS stack artifact by name from this assembly.

Deprecated renamed to 'getStackByName' (or 'getStackArtifact(id)')

stackNameRequired

  • Type: string

getStackArtifact 

public getStackArtifact(artifactId: string): RosStackArtifact

Returns a ROS stack artifact from this assembly.

Param artifactId the artifact id of the stack (can be obtained through 'stack.artifactId'). Throws if there is no stack artifact with that id Returns a 'RosStackArtifact' object.

artifactIdRequired

  • Type: string

getStackByName 

public getStackByName(stackName: string): RosStackArtifact

Returns a ROS stack artifact from this assembly.

Will only search the current assembly.

Param stackName the name of the ROS stack. Throws if there is no stack artifact by that name Throws if there is more than one stack with the same stack name. You can use 'getStackArtifact - stack.artifactId' instead. Returns a 'RosStackArtifact' object.

stackNameRequired

  • Type: string

tree 

public tree(): TreeCloudArtifact

Returns the tree metadata artifact from this assembly.

Throws if there is no metadata artifact by that name Returns a 'TreeCloudArtifact' object if there is one defined in the manifest, 'undefined' otherwise.

tryGetArtifact 

public tryGetArtifact(id: string): CloudArtifact

Attempts to find an artifact with a specific identity.

Returns A 'CloudArtifact' object or 'undefined' if the artifact does not exist in this assembly. Param id The artifact ID

idRequired

  • Type: string

Properties

Name Type Description
artifacts CloudArtifact[] All artifacts included in this assembly.
directory string The root directory of the cloud assembly.
manifest @alicloud/ros-cdk-assembly-schema.AssemblyManifest The raw assembly manifest.
runtime @alicloud/ros-cdk-assembly-schema.RuntimeInfo Runtime information such as module versions used to synthesize this assembly.
stacks RosStackArtifact[] No description.
version string The schema version of the assembly manifest.

artifactsRequired 

public readonly artifacts: CloudArtifact[];

All artifacts included in this assembly.

directoryRequired 

public readonly directory: string;
  • Type: string

The root directory of the cloud assembly.

manifestRequired 

public readonly manifest: AssemblyManifest;
  • Type: @alicloud/ros-cdk-assembly-schema.AssemblyManifest

The raw assembly manifest.

runtimeRequired 

public readonly runtime: RuntimeInfo;
  • Type: @alicloud/ros-cdk-assembly-schema.RuntimeInfo

Runtime information such as module versions used to synthesize this assembly.

stacksRequired 

public readonly stacks: RosStackArtifact[];

versionRequired 

public readonly version: string;
  • Type: string

The schema version of the assembly manifest.