TreeCloudArtifact

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

Bases: aws_cdk.cx_api.CloudArtifact

stability :stability: experimental

Parameters

stability :stability: experimental

Methods

find_metadata_by_type(type)
Parameters

type (str) –

return :rtype: List[MetadataEntryResult] :return: all the metadata entries of a specific type in this artifact.

stability :stability: experimental

Attributes

assembly

stability :stability: experimental

Return type

CloudAssembly

dependencies

Returns all the artifacts that this artifact depends on.

stability :stability: experimental

Return type

List[CloudArtifact]

file

stability :stability: experimental

Return type

str

id

stability :stability: experimental

Return type

str

manifest

The artifact’s manifest.

stability :stability: experimental

Return type

ArtifactManifest

messages

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

stability :stability: experimental

Return type

List[SynthesisMessage]

Static Methods

classmethod from_manifest(assembly, id, *, type, dependencies=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[List[str]]) – IDs of artifacts that must be deployed before this artifact. Default: - no dependencies.

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

  • metadata (Optional[Mapping[str, List[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 :rtype: Optional[CloudArtifact] :return: the CloudArtifact that matches the artifact type or undefined if it’s an artifact type that is unrecognized by this module.

stability :stability: experimental