Skip to content

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
)
Name Type Description
assembly CloudAssembly No description.
name 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).

assemblyRequired


nameRequired

  • Type: str

typeRequired

  • Type: ros_cdk_assembly_schema.ArtifactType

The type of artifact.


dependenciesOptional

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

IDs of artifacts that must be deployed before this artifact.


metadataOptional

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

Associated metadata.


propertiesOptional

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

typeRequired

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

assemblyRequired

The cloud assembly from which to load the artifact.


idRequired

  • Type: str

The artifact ID.


typeRequired

  • Type: ros_cdk_assembly_schema.ArtifactType

The type of artifact.


dependenciesOptional

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

IDs of artifacts that must be deployed before this artifact.


metadataOptional

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

Associated metadata.


propertiesOptional

  • 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.
directory_name str The relative directory name of the asset manifest.
display_name str Display name.
full_path str Full path to the nested assembly directory.
nested_assembly CloudAssembly The nested Assembly.

assemblyRequired

assembly: CloudAssembly

idRequired

id: str
  • Type: str

manifestRequired

manifest: ArtifactManifest
  • Type: ros_cdk_assembly_schema.ArtifactManifest

The artifact's manifest.


messagesRequired

messages: typing.List[SynthesisMessage]

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


dependenciesOptional

dependencies: typing.List[CloudArtifact]

Returns all the artifacts that this artifact depends on.


directory_nameRequired

directory_name: str
  • Type: str

The relative directory name of the asset manifest.


display_nameRequired

display_name: str
  • Type: str

Display name.


full_pathRequired

full_path: str
  • Type: str

Full path to the nested assembly directory.


nested_assemblyRequired

nested_assembly: CloudAssembly

The nested Assembly.