Skip to content

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.

assemblyRequired

artifactIdRequired

  • Type: string

artifactRequired

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

Methods

Name Description
findMetadataByType No description.

findMetadataByType 

public findMetadataByType(type: string): MetadataEntryResult[]

typeRequired

  • 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.

assemblyRequired

The cloud assembly from which to load the artifact.

idRequired

  • Type: string

The artifact ID.

artifactRequired

  • 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.

assemblyRequired 

public readonly assembly: CloudAssembly;

idRequired 

public readonly id: string;
  • Type: string

manifestRequired 

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

The artifact's manifest.

messagesRequired 

public readonly messages: SynthesisMessage[];

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

dependenciesOptional 

public readonly dependencies: CloudArtifact[];

Returns all the artifacts that this artifact depends on.

displayNameRequired 

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.

originalNameRequired 

public readonly originalName: string;
  • Type: string

The original name as defined in the CDK app.

parametersRequired 

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

ROS parameters to pass to the stack.

stackNameRequired 

public readonly stackName: string;
  • Type: string

The physical name of this stack.

tagsRequired 

public readonly tags: any;
  • Type: any

templateRequired 

public readonly template: any;
  • Type: any

The ROS template for this stack.

templateFileRequired 

public readonly templateFile: string;
  • Type: string

The file name of the template.