Package software.amazon.awscdk.cloud_assembly_schema

Interface AssetManifest

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AssetManifest.Jsii$Proxy

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

Definitions for the asset manifest.

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;
 AssetManifest assetManifest = AssetManifest.builder()
         .version("version")
         // the properties below are optional
         .dockerImages(Map.of(
                 "dockerImagesKey", DockerImageAsset.builder()
                         .destinations(Map.of(
                                 "destinationsKey", DockerImageDestination.builder()
                                         .imageTag("imageTag")
                                         .repositoryName("repositoryName")
                                         // the properties below are optional
                                         .assumeRoleAdditionalOptions(Map.of(
                                                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
                                         .assumeRoleArn("assumeRoleArn")
                                         .assumeRoleExternalId("assumeRoleExternalId")
                                         .region("region")
                                         .build()))
                         .source(DockerImageSource.builder()
                                 .cacheDisabled(false)
                                 .cacheFrom(List.of(DockerCacheOption.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .params(Map.of(
                                                 "paramsKey", "params"))
                                         .build()))
                                 .cacheTo(DockerCacheOption.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .params(Map.of(
                                                 "paramsKey", "params"))
                                         .build())
                                 .directory("directory")
                                 .dockerBuildArgs(Map.of(
                                         "dockerBuildArgsKey", "dockerBuildArgs"))
                                 .dockerBuildSecrets(Map.of(
                                         "dockerBuildSecretsKey", "dockerBuildSecrets"))
                                 .dockerBuildSsh("dockerBuildSsh")
                                 .dockerBuildTarget("dockerBuildTarget")
                                 .dockerFile("dockerFile")
                                 .dockerOutputs(List.of("dockerOutputs"))
                                 .executable(List.of("executable"))
                                 .networkMode("networkMode")
                                 .platform("platform")
                                 .build())
                         // the properties below are optional
                         .displayName("displayName")
                         .build()))
         .files(Map.of(
                 "filesKey", FileAsset.builder()
                         .destinations(Map.of(
                                 "destinationsKey", FileDestination.builder()
                                         .bucketName("bucketName")
                                         .objectKey("objectKey")
                                         // the properties below are optional
                                         .assumeRoleAdditionalOptions(Map.of(
                                                 "assumeRoleAdditionalOptionsKey", assumeRoleAdditionalOptions))
                                         .assumeRoleArn("assumeRoleArn")
                                         .assumeRoleExternalId("assumeRoleExternalId")
                                         .region("region")
                                         .build()))
                         .source(FileSource.builder()
                                 .executable(List.of("executable"))
                                 .packaging(FileAssetPackaging.FILE)
                                 .path("path")
                                 .build())
                         // the properties below are optional
                         .displayName("displayName")
                         .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AssetManifest.Builder	builder()
default Map<String,DockerImageAsset>	getDockerImages()	The Docker image assets in this manifest.
default Map<String,FileAsset>	getFiles()	The file assets in this manifest.
String	getVersion()	Version of the manifest.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getVersion

@Stability(Stable)
@NotNull
String getVersion()

Version of the manifest.

getDockerImages

@Stability(Stable)
@Nullable
default Map<String,DockerImageAsset> getDockerImages()

The Docker image assets in this manifest.

Default: - No Docker images

getFiles

@Stability(Stable)
@Nullable
default Map<String,FileAsset> getFiles()

The file assets in this manifest.

Default: - No files

builder

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

Returns:

a AssetManifest.Builder of AssetManifest