NestedCloudAssemblyArtifact

Asset manifest is a description of a set of assets which need to be built and published.

Initializers

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

assembly^Required

• Type: CloudAssembly

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

find_metadata_by_type

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

type^Required

• Type: str

Static Functions

from_manifest

import ros_cdk_cxapi
ros_cdk_cxapi.NestedCloudAssemblyArtifact.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

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.

directory_name^Required

directory_name: str

• Type: str

The relative directory name of the asset manifest.

display_name^Required

display_name: str

• Type: str

Display name.

full_path^Required

full_path: str

• Type: str

Full path to the nested assembly directory.

nested_assembly^Required

nested_assembly: CloudAssembly

• Type: CloudAssembly

The nested Assembly.