Package software.amazon.awscdk.cloudassembly.schema

Interface AssemblyManifest

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AssemblyManifest.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-07-30T08:06:26.674Z")
@Stability(Stable)
public interface AssemblyManifest
extends software.amazon.jsii.JsiiSerializable

A manifest which describes 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;
 AssemblyManifest assemblyManifest = AssemblyManifest.builder()
         .version("version")
         // the properties below are optional
         .artifacts(Map.of(
                 "artifactsKey", 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()))
         .minimumCliVersion("minimumCliVersion")
         .missing(List.of(MissingContext.builder()
                 .key("key")
                 .props(AmiContextQuery.builder()
                         .account("account")
                         .filters(Map.of(
                                 "filtersKey", List.of("filters")))
                         .region("region")
                         // the properties below are optional
                         .assumeRoleAdditionalOptions(Map.of(
                                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
                         .lookupRoleArn("lookupRoleArn")
                         .lookupRoleExternalId("lookupRoleExternalId")
                         .owners(List.of("owners"))
                         .build())
                 .provider(ContextProvider.AMI_PROVIDER)
                 .build()))
         .runtime(RuntimeInfo.builder()
                 .libraries(Map.of(
                         "librariesKey", "libraries"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AssemblyManifest.Builder	builder()
default Map<String,ArtifactManifest>	getArtifacts()	The set of artifacts in this assembly.
default String	getMinimumCliVersion()	Required CLI version, if available.
default List<MissingContext>	getMissing()	Missing context information.
default RuntimeInfo	getRuntime()	Runtime information.
String	getVersion()	Protocol version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getVersion

@Stability(Stable)
@NotNull
String getVersion()

Protocol version.

getArtifacts

@Stability(Stable)
@Nullable
default Map<String,ArtifactManifest> getArtifacts()

The set of artifacts in this assembly.

Default: - no artifacts.

getMinimumCliVersion

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

Required CLI version, if available.

If the manifest producer knows, it can put the minimum version of the CLI here that supports reading this assembly.

If set, it can be used to show a more informative error message to users.

Default: - Minimum CLI version unknown

getMissing

@Stability(Stable)
@Nullable
default List<MissingContext> getMissing()

Missing context information.

If this field has values, it means that the cloud assembly is not complete and should not be deployed.

Default: - no missing context.

getRuntime

@Stability(Stable)
@Nullable
default RuntimeInfo getRuntime()

Runtime information.

Default: - no info.

builder

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

Returns:

a AssemblyManifest.Builder of AssemblyManifest