Package software.amazon.awscdk.cloud_assembly_schema

Interface ArtifactManifest

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ArtifactManifest.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:16.181Z")
@Stability(Stable)
public interface ArtifactManifest
extends software.amazon.jsii.JsiiSerializable

A manifest for a single artifact within the cloud assembly.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloud_assembly_schema.*;
 Object assumeRoleAdditionalOptions;
 ArtifactManifest artifactManifest = ArtifactManifest.builder()
         .type(ArtifactType.NONE)
         // the properties below are optional
         .dependencies(List.of("dependencies"))
         .displayName("displayName")
         .environment("environment")
         .metadata(Map.of(
                 "metadataKey", List.of(MetadataEntry.builder()
                         .type("type")
                         // the properties below are optional
                         .data("data")
                         .trace(List.of("trace"))
                         .build())))
         .properties(AwsCloudFormationStackProperties.builder()
                 .templateFile("templateFile")
                 // the properties below are optional
                 .assumeRoleAdditionalOptions(Map.of(
                         "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
                 .assumeRoleArn("assumeRoleArn")
                 .assumeRoleExternalId("assumeRoleExternalId")
                 .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                 .cloudFormationExecutionRoleArn("cloudFormationExecutionRoleArn")
                 .lookupRole(BootstrapRole.builder()
                         .arn("arn")
                         // the properties below are optional
                         .assumeRoleAdditionalOptions(Map.of(
                                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
                         .assumeRoleExternalId("assumeRoleExternalId")
                         .bootstrapStackVersionSsmParameter("bootstrapStackVersionSsmParameter")
                         .requiresBootstrapStackVersion(123)
                         .build())
                 .notificationArns(List.of("notificationArns"))
                 .parameters(Map.of(
                         "parametersKey", "parameters"))
                 .requiresBootstrapStackVersion(123)
                 .stackName("stackName")
                 .stackTemplateAssetObjectUrl("stackTemplateAssetObjectUrl")
                 .tags(Map.of(
                         "tagsKey", "tags"))
                 .terminationProtection(false)
                 .validateOnSynth(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ArtifactManifest.Builder	builder()
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 Details

getType

@Stability(Stable)
@NotNull
ArtifactType getType()

The type of artifact.

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.

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