All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: ContainerImageAssetMetadataEntry.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-06T20:25:05.772Z")
@Stability(Stable)
public interface ContainerImageAssetMetadataEntry
extends software.amazon.jsii.JsiiSerializable

Metadata Entry spec for container images.

Example:

 Map<String, String> entry = Map.of(
         "packaging", "container-image",
         "repositoryName", "repository-name",
         "imageTag", "tag");

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`ContainerImageAssetMetadataEntry.Builder`	A builder for `ContainerImageAssetMetadataEntry`
`static class`	`ContainerImageAssetMetadataEntry.Jsii$Proxy`	An implementation for `ContainerImageAssetMetadataEntry`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`static ContainerImageAssetMetadataEntry.Builder`	`builder()`
`default Map<String,String>`	`getBuildArgs()`	Build args to pass to the `docker build` command.
`default Map<String,String>`	`getBuildSecrets()`	Build secrets to pass to the `docker build` command.
`default String`	`getBuildSsh()`	SSH agent socket or keys to pass to the `docker build` command.
`default Boolean`	`getCacheDisabled()`	Disable the cache and pass `--no-cache` to the `docker build` command.
`default List<ContainerImageAssetCacheOption>`	`getCacheFrom()`	Cache from options to pass to the `docker build` command.
`default ContainerImageAssetCacheOption`	`getCacheTo()`	Cache to options to pass to the `docker build` command.
`default String`	`getFile()`	Path to the Dockerfile (relative to the directory).
`String`	`getId()`	Logical identifier for the asset.
`default String`	`getImageNameParameter()`	Deprecated. specify `repositoryName` and `imageTag` instead, and then you know where the image will go.
`default String`	`getImageTag()`	The docker image tag to use for tagging pushed images.
`default String`	`getNetworkMode()`	Networking mode for the RUN commands during build.
`default List<String>`	`getOutputs()`	Outputs to pass to the `docker build` command.
`String`	`getPackaging()`	Type of asset.
`String`	`getPath()`	Path on disk to the asset.
`default String`	`getPlatform()`	Platform to build for.
`default String`	`getRepositoryName()`	ECR repository name, if omitted a default name based on the asset's ID is used instead.
`String`	`getSourceHash()`	The hash of the asset source.
`default String`	`getTarget()`	Docker target to build to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getId
```
@Stability(Stable)
@NotNull
String getId()
```
    Logical identifier for the asset.
  - getPackaging
```
@Stability(Stable)
@NotNull
String getPackaging()
```
    Type of asset.
  - getPath
```
@Stability(Stable)
@NotNull
String getPath()
```
    Path on disk to the asset.
  - getSourceHash
```
@Stability(Stable)
@NotNull
String getSourceHash()
```
    The hash of the asset source.
  - getBuildArgs
```
@Stability(Stable)
@Nullable
default Map<String,String> getBuildArgs()
```
    Build args to pass to the docker build command.
    Default: no build args are passed
  - getBuildSecrets
```
@Stability(Stable)
@Nullable
default Map<String,String> getBuildSecrets()
```
    Build secrets to pass to the docker build command.
    Default: no build secrets are passed
  - getBuildSsh
```
@Stability(Stable)
@Nullable
default String getBuildSsh()
```
    SSH agent socket or keys to pass to the docker build command.
    Default: no ssh arg is passed
  - getCacheDisabled
```
@Stability(Stable)
@Nullable
default Boolean getCacheDisabled()
```
    Disable the cache and pass --no-cache to the docker build command.
    Default: - cache is used
  - getCacheFrom
```
@Stability(Stable)
@Nullable
default List<ContainerImageAssetCacheOption> getCacheFrom()
```
    Cache from options to pass to the docker build command.
    Default: - no cache from options are passed to the build command
    
    See Also:
    
    https://docs.docker.com/build/cache/backends/
  - getCacheTo
```
@Stability(Stable)
@Nullable
default ContainerImageAssetCacheOption getCacheTo()
```
    Cache to options to pass to the docker build command.
    Default: - no cache to options are passed to the build command
    
    See Also:
    
    https://docs.docker.com/build/cache/backends/
  - getFile
```
@Stability(Stable)
@Nullable
default String getFile()
```
    Path to the Dockerfile (relative to the directory).
    Default: - no file is passed
  - getImageNameParameter
```
@Stability(Deprecated)
@Deprecated
@Nullable
default String getImageNameParameter()
```
    Deprecated.
    specify repositoryName and imageTag instead, and then you know where the image will go.
    
    (deprecated) ECR Repository name and repo digest (separated by "@sha256:") where this image is stored.
    Default: undefined If not specified, `repositoryName` and `imageTag` are required because otherwise how will the stack know where to find the asset, ha?
  - getImageTag
```
@Stability(Stable)
@Nullable
default String getImageTag()
```
    The docker image tag to use for tagging pushed images.
    This field is required if imageParameterName is ommited (otherwise, the app won't be able to find the image).
    Default: - this parameter is REQUIRED after 1.21.0
  - getNetworkMode
```
@Stability(Stable)
@Nullable
default String getNetworkMode()
```
    Networking mode for the RUN commands during build.
    Default: - no networking mode specified
  - getOutputs
```
@Stability(Stable)
@Nullable
default List<String> getOutputs()
```
    Outputs to pass to the docker build command.
    Default: - no outputs are passed to the build command (default outputs are used)
    
    See Also:
    
    https://docs.docker.com/engine/reference/commandline/build/#custom-build-outputs
  - getPlatform
```
@Stability(Stable)
@Nullable
default String getPlatform()
```
    Platform to build for.
    Requires Docker Buildx.
    Default: - current machine platform
  - getRepositoryName
```
@Stability(Stable)
@Nullable
default String getRepositoryName()
```
    ECR repository name, if omitted a default name based on the asset's ID is used instead.
    Specify this property if you need to statically address the image, e.g. from a Kubernetes Pod. Note, this is only the repository name, without the registry and the tag parts.
    Default: - this parameter is REQUIRED after 1.21.0
  - getTarget
```
@Stability(Stable)
@Nullable
default String getTarget()
```
    Docker target to build to.
    Default: no build target
  - builder
```
@Stability(Stable)
static ContainerImageAssetMetadataEntry.Builder builder()
```
    Returns:
    
    a ContainerImageAssetMetadataEntry.Builder of ContainerImageAssetMetadataEntry

Interface ContainerImageAssetMetadataEntry

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getId

getPackaging

getPath

getSourceHash

getBuildArgs

getBuildSecrets

getBuildSsh

getCacheDisabled

getCacheFrom

getCacheTo

getFile

getImageNameParameter

getImageTag

getNetworkMode

getOutputs

getPlatform

getRepositoryName

getTarget

builder