Package software.amazon.awscdk.cloudassembly.schema

Interface ArtifactManifest

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ArtifactManifest.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2026-02-23T17:23:13.488Z")
@Stability(Stable)
public interface ArtifactManifest
extends software.amazon.jsii.JsiiSerializable

A manifest for a single artifact within the cloud assembly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ArtifactManifest.Builder	A builder for ArtifactManifest
static class	ArtifactManifest.Jsii$Proxy	An implementation for ArtifactManifest

Method Summary

Modifier and Type	Method	Description
static ArtifactManifest.Builder	builder()
default String	getAdditionalMetadataFile()	A file with additional metadata entries.
default List<String>	getDependencies()	IDs of artifacts that must be deployed before this artifact.
default String	getDisplayName()	A string that can be shown to a user to uniquely identify this artifact inside a cloud assembly tree.
default String	getEnvironment()	The environment into which this artifact is deployed.
default Map<String,List<MetadataEntry>>	getMetadata()	Associated metadata.
default Object	getProperties()	The set of properties for this artifact (depends on type).
ArtifactType	getType()	The type of artifact.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getType

@Stability(Stable)
@NotNull
ArtifactType getType()

The type of artifact.

getAdditionalMetadataFile

@Stability(Stable)
@Nullable
default String getAdditionalMetadataFile()

A file with additional metadata entries.

The schema of this file is exactly the same as the type of the metadata field. In other words, that file contains an object mapping construct paths to arrays of metadata entries.

Default: - no additional metadata

getDependencies

@Stability(Stable)
@Nullable
default List<String> getDependencies()

IDs of artifacts that must be deployed before this artifact.

Default: - no dependencies.

getDisplayName

@Stability(Stable)
@Nullable
default String getDisplayName()

A string that can be shown to a user to uniquely identify this artifact inside a cloud assembly tree.

Is used by the CLI to present a list of stacks to the user in a way that makes sense to them. Even though the property name "display name" doesn't imply it, this field is used to select stacks as well, so all stacks should have a unique display name.

Default: - no display name

getEnvironment

@Stability(Stable)
@Nullable
default String getEnvironment()

The environment into which this artifact is deployed.

Default: - no envrionment.

getMetadata

@Stability(Stable)
@Nullable
default Map<String,List<MetadataEntry>> getMetadata()

Associated metadata.

Metadata can be stored directly in the assembly manifest, as well as in a separate file (see additionalMetadataFile). It should prefer to be stored in the additional file, as that will reduce the size of the assembly manifest in cases of a lot of metdata (which CDK does emit by default).

Default: - no metadata.

getProperties

@Stability(Stable)
@Nullable
default Object getProperties()

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

Returns union: either AwsCloudFormationStackProperties or AssetManifestProperties or TreeArtifactProperties or NestedCloudAssemblyProperties or FeatureFlagReportProperties

Default: - no properties.

builder

@Stability(Stable)
static ArtifactManifest.Builder builder()

Returns:

a ArtifactManifest.Builder of ArtifactManifest