TreeCloudArtifact

class aws_cdk.cx_api.TreeCloudArtifact(assembly, name, *, type, dependencies=None, display_name=None, environment=None, metadata=None, properties=None)

Bases: aws_cdk.cx_api.CloudArtifact

Parameters
  • assembly (CloudAssembly) –

  • name (str) –

  • type (ArtifactType) – The type of artifact.

  • dependencies (Optional[Sequence[str]]) – IDs of artifacts that must be deployed before this artifact. Default: - no dependencies.

  • display_name (Optional[str]) – A string that represents this artifact. Should only be used in user interfaces. Default: - no display name

  • environment (Optional[str]) – The environment into which this artifact is deployed. Default: - no envrionment.

  • metadata (Optional[Mapping[str, Sequence[MetadataEntry]]]) – Associated metadata. Default: - no metadata.

  • properties (Union[AwsCloudFormationStackProperties, AssetManifestProperties, TreeArtifactProperties, NestedCloudAssemblyProperties, None]) – The set of properties for this artifact (depends on type). Default: - no properties.

Methods

find_metadata_by_type(type)
Parameters

type (str) –

Return type

List[MetadataEntryResult]

Returns

all the metadata entries of a specific type in this artifact.

Attributes

assembly
Return type

CloudAssembly

dependencies

Returns all the artifacts that this artifact depends on.

Return type

List[CloudArtifact]

file
Return type

str

hierarchical_id

An identifier that shows where this artifact is located in the tree of nested assemblies, based on their manifests.

Defaults to the normal id. Should only be used in user interfaces.

Return type

str

id
Return type

str

manifest

The artifact’s manifest.

Return type

ArtifactManifest

messages

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

Return type

List[SynthesisMessage]

Static Methods

classmethod from_manifest(assembly, id, *, type, dependencies=None, display_name=None, environment=None, metadata=None, properties=None)

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

Parameters
  • assembly (CloudAssembly) – The cloud assembly from which to load the artifact.

  • id (str) – The artifact ID.

  • type (ArtifactType) – The type of artifact.

  • dependencies (Optional[Sequence[str]]) – IDs of artifacts that must be deployed before this artifact. Default: - no dependencies.

  • display_name (Optional[str]) – A string that represents this artifact. Should only be used in user interfaces. Default: - no display name

  • environment (Optional[str]) – The environment into which this artifact is deployed. Default: - no envrionment.

  • metadata (Optional[Mapping[str, Sequence[MetadataEntry]]]) – Associated metadata. Default: - no metadata.

  • properties (Union[AwsCloudFormationStackProperties, AssetManifestProperties, TreeArtifactProperties, NestedCloudAssemblyProperties, None]) – The set of properties for this artifact (depends on type). Default: - no properties.

Return type

Optional[CloudArtifact]

Returns

the CloudArtifact that matches the artifact type or undefined if it’s an artifact type that is unrecognized by this module.