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.139.0 (build 26a6b54)",
           date="2026-07-30T08:06:26.671Z")
@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.cloudassembly.schema.*;
 Object assumeRoleAdditionalOptions;
 ArtifactManifest artifactManifest = ArtifactManifest.builder()
         .type(ArtifactType.NONE)
         // the properties below are optional
         .additionalMetadataFile("additionalMetadataFile")
         .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();

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