Package software.amazon.awscdk.cloudassembly.schema

Class ContainerImageAssetMetadataEntry.Builder

java.lang.Object

software.amazon.awscdk.cloudassembly.schema.ContainerImageAssetMetadataEntry.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ContainerImageAssetMetadataEntry>

Enclosing interface:

ContainerImageAssetMetadataEntry

@Stability(Stable)
public static final class ContainerImageAssetMetadataEntry.Builder
extends Object
implements software.amazon.jsii.Builder<ContainerImageAssetMetadataEntry>

A builder for ContainerImageAssetMetadataEntry

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ContainerImageAssetMetadataEntry	build()	Builds the configured instance.
ContainerImageAssetMetadataEntry.Builder	buildArgs(Map<String,String> buildArgs)	Sets the value of ContainerImageAssetMetadataEntry.getBuildArgs()
ContainerImageAssetMetadataEntry.Builder	buildSecrets(Map<String,String> buildSecrets)	Sets the value of ContainerImageAssetMetadataEntry.getBuildSecrets()
ContainerImageAssetMetadataEntry.Builder	buildSsh(String buildSsh)	Sets the value of ContainerImageAssetMetadataEntry.getBuildSsh()
ContainerImageAssetMetadataEntry.Builder	cacheDisabled(Boolean cacheDisabled)	Sets the value of ContainerImageAssetMetadataEntry.getCacheDisabled()
ContainerImageAssetMetadataEntry.Builder	cacheFrom(List<? extends ContainerImageAssetCacheOption> cacheFrom)	Sets the value of ContainerImageAssetMetadataEntry.getCacheFrom()
ContainerImageAssetMetadataEntry.Builder	cacheTo(ContainerImageAssetCacheOption cacheTo)	Sets the value of ContainerImageAssetMetadataEntry.getCacheTo()
ContainerImageAssetMetadataEntry.Builder	file(String file)	Sets the value of ContainerImageAssetMetadataEntry.getFile()
ContainerImageAssetMetadataEntry.Builder	id(String id)	Sets the value of ContainerImageAssetMetadataEntry.getId()
ContainerImageAssetMetadataEntry.Builder	imageNameParameter(String imageNameParameter)	Deprecated. specify `repositoryName` and `imageTag` instead, and then you know where the image will go.
ContainerImageAssetMetadataEntry.Builder	imageTag(String imageTag)	Sets the value of ContainerImageAssetMetadataEntry.getImageTag()
ContainerImageAssetMetadataEntry.Builder	networkMode(String networkMode)	Sets the value of ContainerImageAssetMetadataEntry.getNetworkMode()
ContainerImageAssetMetadataEntry.Builder	outputs(List<String> outputs)	Sets the value of ContainerImageAssetMetadataEntry.getOutputs()
ContainerImageAssetMetadataEntry.Builder	packaging(String packaging)	Sets the value of ContainerImageAssetMetadataEntry.getPackaging()
ContainerImageAssetMetadataEntry.Builder	path(String path)	Sets the value of ContainerImageAssetMetadataEntry.getPath()
ContainerImageAssetMetadataEntry.Builder	platform(String platform)	Sets the value of ContainerImageAssetMetadataEntry.getPlatform()
ContainerImageAssetMetadataEntry.Builder	repositoryName(String repositoryName)	Sets the value of ContainerImageAssetMetadataEntry.getRepositoryName()
ContainerImageAssetMetadataEntry.Builder	sourceHash(String sourceHash)	Sets the value of ContainerImageAssetMetadataEntry.getSourceHash()
ContainerImageAssetMetadataEntry.Builder	target(String target)	Sets the value of ContainerImageAssetMetadataEntry.getTarget()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder id(String id)

Sets the value of ContainerImageAssetMetadataEntry.getId()

Parameters:

id - Logical identifier for the asset. This parameter is required.

Returns:

this

packaging

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder packaging(String packaging)

Sets the value of ContainerImageAssetMetadataEntry.getPackaging()

Parameters:

packaging - Type of asset. This parameter is required.

Returns:

this

path

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder path(String path)

Sets the value of ContainerImageAssetMetadataEntry.getPath()

Parameters:

path - Path on disk to the asset. This parameter is required.

Returns:

this

sourceHash

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder sourceHash(String sourceHash)

Sets the value of ContainerImageAssetMetadataEntry.getSourceHash()

Parameters:

sourceHash - The hash of the asset source. This parameter is required.

Returns:

this

buildArgs

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder buildArgs(Map<String,String> buildArgs)

Sets the value of ContainerImageAssetMetadataEntry.getBuildArgs()

Parameters:

buildArgs - Build args to pass to the docker build command.

Returns:

this

buildSecrets

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder buildSecrets(Map<String,String> buildSecrets)

Sets the value of ContainerImageAssetMetadataEntry.getBuildSecrets()

Parameters:

buildSecrets - Build secrets to pass to the docker build command.

Returns:

this

buildSsh

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder buildSsh(String buildSsh)

Sets the value of ContainerImageAssetMetadataEntry.getBuildSsh()

Parameters:

buildSsh - SSH agent socket or keys to pass to the docker build command.

Returns:

this

cacheDisabled

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder cacheDisabled(Boolean cacheDisabled)

Sets the value of ContainerImageAssetMetadataEntry.getCacheDisabled()

Parameters:

cacheDisabled - Disable the cache and pass --no-cache to the docker build command.

Returns:

this

cacheFrom

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder cacheFrom(List<? extends ContainerImageAssetCacheOption> cacheFrom)

Sets the value of ContainerImageAssetMetadataEntry.getCacheFrom()

Parameters:

cacheFrom - Cache from options to pass to the docker build command.

Returns:

this

cacheTo

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder cacheTo(ContainerImageAssetCacheOption cacheTo)

Sets the value of ContainerImageAssetMetadataEntry.getCacheTo()

Parameters:

cacheTo - Cache to options to pass to the docker build command.

Returns:

this

file

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder file(String file)

Sets the value of ContainerImageAssetMetadataEntry.getFile()

Parameters:

file - Path to the Dockerfile (relative to the directory).

Returns:

this

imageNameParameter

@Stability(Deprecated)
@Deprecated
public ContainerImageAssetMetadataEntry.Builder imageNameParameter(String imageNameParameter)

Deprecated.

specify `repositoryName` and `imageTag` instead, and then you know where the image will go.

Sets the value of ContainerImageAssetMetadataEntry.getImageNameParameter()

Parameters:

imageNameParameter - ECR Repository name and repo digest (separated by "@sha256:") where this image is stored.

Returns:

this

imageTag

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder imageTag(String imageTag)

Sets the value of ContainerImageAssetMetadataEntry.getImageTag()

Parameters:

imageTag - 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).

Returns:

this

networkMode

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder networkMode(String networkMode)

Sets the value of ContainerImageAssetMetadataEntry.getNetworkMode()

Parameters:

networkMode - Networking mode for the RUN commands during build.

Returns:

this

outputs

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder outputs(List<String> outputs)

Sets the value of ContainerImageAssetMetadataEntry.getOutputs()

Parameters:

outputs - Outputs to pass to the docker build command.

Returns:

this

platform

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder platform(String platform)

Sets the value of ContainerImageAssetMetadataEntry.getPlatform()

Parameters:

platform - Platform to build for. Requires Docker Buildx.

Returns:

this

repositoryName

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder repositoryName(String repositoryName)

Sets the value of ContainerImageAssetMetadataEntry.getRepositoryName()

Parameters:

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

Returns:

this

target

@Stability(Stable)
public ContainerImageAssetMetadataEntry.Builder target(String target)

Sets the value of ContainerImageAssetMetadataEntry.getTarget()

Parameters:

target - Docker target to build to.

Returns:

this

build

@Stability(Stable)
public ContainerImageAssetMetadataEntry build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ContainerImageAssetMetadataEntry>

Returns:

a new instance of ContainerImageAssetMetadataEntry

Throws:

NullPointerException - if any required attribute was not provided