RosStackArtifact

Initializers

import ros_cdk_cxapi
ros_cdk_cxapi.RosStackArtifact(
  assembly: CloudAssembly,
  artifact_id: str,
  type: ArtifactType,
  dependencies: typing.List[str] = None,
  metadata: typing.Mapping[typing.List[MetadataEntry]] = None,
  properties: typing.Union[AliyunRosStackProperties, TreeArtifactProperties, NestedCloudAssemblyProperties] = None
)

Name	Type	Description
assembly	CloudAssembly	No description.
artifact_id	str	No description.
type	ros_cdk_assembly_schema.ArtifactType	The type of artifact.
dependencies	typing.List[str]	IDs of artifacts that must be deployed before this artifact.
metadata	typing.Mapping[typing.List[ros_cdk_assembly_schema.MetadataEntry]]	Associated metadata.
properties	typing.Union[ros_cdk_assembly_schema.AliyunRosStackProperties, ros_cdk_assembly_schema.TreeArtifactProperties, ros_cdk_assembly_schema.NestedCloudAssemblyProperties]	The set of properties for this artifact (depends on type).

---

assembly^Required

• Type: CloudAssembly

---

artifact_id^Required

• Type: str

---

type^Required

• Type: ros_cdk_assembly_schema.ArtifactType

The type of artifact.

---

dependencies^Optional

• Type: typing.List[str]
• Default: no dependencies.

IDs of artifacts that must be deployed before this artifact.

---

metadata^Optional

• Type: typing.Mapping[typing.List[ros_cdk_assembly_schema.MetadataEntry]]
• Default: no metadata.

Associated metadata.

---

properties^Optional

• Type: typing.Union[ros_cdk_assembly_schema.AliyunRosStackProperties, ros_cdk_assembly_schema.TreeArtifactProperties, ros_cdk_assembly_schema.NestedCloudAssemblyProperties]
• Default: no properties.

The set of properties for this artifact (depends on type).

---

Methods

Name	Description
find_metadata_by_type	No description.

---

find_metadata_by_type

def find_metadata_by_type(
  type: str
) -> typing.List[MetadataEntryResult]

type^Required

• Type: str

---

Static Functions

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

---

from_manifest

import ros_cdk_cxapi
ros_cdk_cxapi.RosStackArtifact.from_manifest(
  assembly: CloudAssembly,
  id: str,
  type: ArtifactType,
  dependencies: typing.List[str] = None,
  metadata: typing.Mapping[typing.List[MetadataEntry]] = None,
  properties: typing.Union[AliyunRosStackProperties, TreeArtifactProperties, NestedCloudAssemblyProperties] = None
)

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: str

The artifact ID.

---

type^Required

• Type: ros_cdk_assembly_schema.ArtifactType

The type of artifact.

---

dependencies^Optional

• Type: typing.List[str]
• Default: no dependencies.

IDs of artifacts that must be deployed before this artifact.

---

metadata^Optional

• Type: typing.Mapping[typing.List[ros_cdk_assembly_schema.MetadataEntry]]
• Default: no metadata.

Associated metadata.

---

properties^Optional

• Type: typing.Union[ros_cdk_assembly_schema.AliyunRosStackProperties, ros_cdk_assembly_schema.TreeArtifactProperties, ros_cdk_assembly_schema.NestedCloudAssemblyProperties]
• Default: no properties.

The set of properties for this artifact (depends on type).

---

Properties

Name	Type	Description
assembly	CloudAssembly	No description.
id	str	No description.
manifest	ros_cdk_assembly_schema.ArtifactManifest	The artifact's manifest.
messages	typing.List[SynthesisMessage]	The set of messages extracted from the artifact's metadata.
dependencies	typing.List[CloudArtifact]	Returns all the artifacts that this artifact depends on.
display_name	str	A string that represents this stack.
name	str	The physical name of this stack.
original_name	str	The original name as defined in the CDK app.
parameters	typing.Mapping[str]	ROS parameters to pass to the stack.
stack_name	str	The physical name of this stack.
tags	typing.Any	No description.
template	typing.Any	The ROS template for this stack.
template_file	str	The file name of the template.

---

assembly^Required

assembly: CloudAssembly

• Type: CloudAssembly

---

id^Required

id: str

• Type: str

---

manifest^Required

manifest: ArtifactManifest

• Type: ros_cdk_assembly_schema.ArtifactManifest

The artifact's manifest.

---

messages^Required

messages: typing.List[SynthesisMessage]

• Type: typing.List[SynthesisMessage]

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

---

dependencies^Optional

dependencies: typing.List[CloudArtifact]

• Type: typing.List[CloudArtifact]

Returns all the artifacts that this artifact depends on.

---

display_name^Required

display_name: str

• Type: str

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

name: str

• Type: str

The physical name of this stack.

---

original_name^Required

original_name: str

• Type: str

The original name as defined in the CDK app.

---

parameters^Required

parameters: typing.Mapping[str]

• Type: typing.Mapping[str]

ROS parameters to pass to the stack.

---

stack_name^Required

stack_name: str

• Type: str

The physical name of this stack.

---

tags^Required

tags: typing.Any

• Type: typing.Any

---

template^Required

template: typing.Any

• Type: typing.Any

The ROS template for this stack.

---

template_file^Required

template_file: str

• Type: str

The file name of the template.

---