RosStackArtifact

Initializers

import { RosStackArtifact } from '@alicloud/ros-cdk-cxapi'
new RosStackArtifact(assembly: CloudAssembly, artifactId: string, artifact: ArtifactManifest)

Name	Type	Description
assembly	CloudAssembly	No description.
artifactId	string	No description.
artifact	@alicloud/ros-cdk-assembly-schema.ArtifactManifest	No description.

---

assembly^Required

• Type: CloudAssembly

---

artifactId^Required

• Type: string

---

artifact^Required

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

---

Methods

Name	Description
findMetadataByType	No description.

---

findMetadataByType

public findMetadataByType(type: string): MetadataEntryResult[]

type^Required

• Type: string

---

Static Functions

Name	Description
fromManifest	Returns a subclass of CloudArtifact based on the artifact type defined in the artifact manifest.

---

fromManifest

import { RosStackArtifact } from '@alicloud/ros-cdk-cxapi'
RosStackArtifact.fromManifest(assembly: CloudAssembly, id: string, artifact: ArtifactManifest)

Returns a subclass of CloudArtifact based on the artifact type defined in the artifact manifest.

assembly^Required

• Type: CloudAssembly

The cloud assembly from which to load the artifact.

---

id^Required

• Type: string

The artifact ID.

---

artifact^Required

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

The artifact manifest.

---

Properties

Name	Type	Description
assembly	CloudAssembly	No description.
id	string	No description.
manifest	@alicloud/ros-cdk-assembly-schema.ArtifactManifest	The artifact's manifest.
messages	SynthesisMessage[]	The set of messages extracted from the artifact's metadata.
dependencies	CloudArtifact[]	Returns all the artifacts that this artifact depends on.
displayName	string	A string that represents this stack.
name	string	The physical name of this stack.
originalName	string	The original name as defined in the CDK app.
parameters	{[ key: string ]: string}	ROS parameters to pass to the stack.
stackName	string	The physical name of this stack.
tags	any	No description.
template	any	The ROS template for this stack.
templateFile	string	The file name of the template.

---

assembly^Required

public readonly assembly: CloudAssembly;

• Type: CloudAssembly

---

id^Required

public readonly id: string;

• Type: string

---

manifest^Required

public readonly manifest: ArtifactManifest;

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

The artifact's manifest.

---

messages^Required

public readonly messages: SynthesisMessage[];

• Type: SynthesisMessage[]

The set of messages extracted from the artifact's metadata.

---

dependencies^Optional

public readonly dependencies: CloudArtifact[];

• Type: CloudArtifact[]

Returns all the artifacts that this artifact depends on.

---

displayName^Required

public readonly displayName: string;

• Type: string

A string that represents this stack.

Should only be used in user interfaces. If the stackName and artifactId are the same, it will just return that. Otherwise, it will return something like " ()"

---

~~name~~^Required

• Deprecated: renamed to stackName

public readonly name: string;

• Type: string

The physical name of this stack.

---

originalName^Required

public readonly originalName: string;

• Type: string

The original name as defined in the CDK app.

---

parameters^Required

public readonly parameters: {[ key: string ]: string};

• Type: {[ key: string ]: string}

ROS parameters to pass to the stack.

---

stackName^Required

public readonly stackName: string;

• Type: string

The physical name of this stack.

---

tags^Required

public readonly tags: any;

• Type: any

---

template^Required

public readonly template: any;

• Type: any

The ROS template for this stack.

---

templateFile^Required

public readonly templateFile: string;

• Type: string

The file name of the template.

---