Package software.amazon.awscdk.services.lambda

Class AssetImageCodeProps.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.AssetImageCodeProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AssetImageCodeProps>

Enclosing interface:

AssetImageCodeProps

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

A builder for AssetImageCodeProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AssetImageCodeProps.Builder	assetName(String assetName)	Sets the value of DockerImageAssetOptions.getAssetName()
AssetImageCodeProps	build()	Builds the configured instance.
AssetImageCodeProps.Builder	buildArgs(Map<String,String> buildArgs)	Sets the value of DockerImageAssetOptions.getBuildArgs()
AssetImageCodeProps.Builder	buildSecrets(Map<String,String> buildSecrets)	Sets the value of DockerImageAssetOptions.getBuildSecrets()
AssetImageCodeProps.Builder	buildSsh(String buildSsh)	Sets the value of DockerImageAssetOptions.getBuildSsh()
AssetImageCodeProps.Builder	cacheDisabled(Boolean cacheDisabled)	Sets the value of DockerImageAssetOptions.getCacheDisabled()
AssetImageCodeProps.Builder	cacheFrom(List<? extends DockerCacheOption> cacheFrom)	Sets the value of DockerImageAssetOptions.getCacheFrom()
AssetImageCodeProps.Builder	cacheTo(DockerCacheOption cacheTo)	Sets the value of DockerImageAssetOptions.getCacheTo()
AssetImageCodeProps.Builder	cmd(List<String> cmd)	Sets the value of AssetImageCodeProps.getCmd()
AssetImageCodeProps.Builder	entrypoint(List<String> entrypoint)	Sets the value of AssetImageCodeProps.getEntrypoint()
AssetImageCodeProps.Builder	exclude(List<String> exclude)	Sets the value of FileCopyOptions.getExclude()
AssetImageCodeProps.Builder	extraHash(String extraHash)	Sets the value of FileFingerprintOptions.getExtraHash()
AssetImageCodeProps.Builder	file(String file)	Sets the value of DockerImageAssetOptions.getFile()
AssetImageCodeProps.Builder	followSymlinks(SymlinkFollowMode followSymlinks)	Sets the value of FileCopyOptions.getFollowSymlinks()
AssetImageCodeProps.Builder	ignoreMode(IgnoreMode ignoreMode)	Sets the value of FileCopyOptions.getIgnoreMode()
AssetImageCodeProps.Builder	invalidation(DockerImageAssetInvalidationOptions invalidation)	Sets the value of DockerImageAssetOptions.getInvalidation()
AssetImageCodeProps.Builder	networkMode(NetworkMode networkMode)	Sets the value of DockerImageAssetOptions.getNetworkMode()
AssetImageCodeProps.Builder	outputs(List<String> outputs)	Sets the value of DockerImageAssetOptions.getOutputs()
AssetImageCodeProps.Builder	platform(Platform platform)	Sets the value of DockerImageAssetOptions.getPlatform()
AssetImageCodeProps.Builder	target(String target)	Sets the value of DockerImageAssetOptions.getTarget()
AssetImageCodeProps.Builder	workingDirectory(String workingDirectory)	Sets the value of AssetImageCodeProps.getWorkingDirectory()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

cmd

@Stability(Stable)
public AssetImageCodeProps.Builder cmd(List<String> cmd)

Sets the value of AssetImageCodeProps.getCmd()

Parameters:

cmd - Specify or override the CMD on the specified Docker image or Dockerfile. This needs to be in the 'exec form', viz., [ 'executable', 'param1', 'param2' ].

Returns:

this

entrypoint

@Stability(Stable)
public AssetImageCodeProps.Builder entrypoint(List<String> entrypoint)

Sets the value of AssetImageCodeProps.getEntrypoint()

Parameters:

entrypoint - Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile. An ENTRYPOINT allows you to configure a container that will run as an executable. This needs to be in the 'exec form', viz., [ 'executable', 'param1', 'param2' ].

Returns:

this

workingDirectory

@Stability(Stable)
public AssetImageCodeProps.Builder workingDirectory(String workingDirectory)

Sets the value of AssetImageCodeProps.getWorkingDirectory()

Parameters:

workingDirectory - Specify or override the WORKDIR on the specified Docker image or Dockerfile. A WORKDIR allows you to configure the working directory the container will use.

Returns:

this

assetName

@Stability(Stable)
public AssetImageCodeProps.Builder assetName(String assetName)

Sets the value of DockerImageAssetOptions.getAssetName()

Parameters:

assetName - Unique identifier of the docker image asset and its potential revisions. Required if using AppScopedStagingSynthesizer.

Returns:

this

buildArgs

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

Sets the value of DockerImageAssetOptions.getBuildArgs()

Parameters:

buildArgs - Build args to pass to the docker build command. Since Docker build arguments are resolved before deployment, keys and values cannot refer to unresolved tokens (such as lambda.functionArn or queue.queueUrl).

Returns:

this

buildSecrets

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

Sets the value of DockerImageAssetOptions.getBuildSecrets()

Parameters:

buildSecrets - Build secrets. Docker BuildKit must be enabled to use build secrets.

Returns:

this

buildSsh

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

Sets the value of DockerImageAssetOptions.getBuildSsh()

Parameters:

buildSsh - SSH agent socket or keys to pass to the docker build command. Docker BuildKit must be enabled to use the ssh flag

Returns:

this

cacheDisabled

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

Sets the value of DockerImageAssetOptions.getCacheDisabled()

Parameters:

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

Returns:

this

cacheFrom

@Stability(Stable)
public AssetImageCodeProps.Builder cacheFrom(List<? extends DockerCacheOption> cacheFrom)

Sets the value of DockerImageAssetOptions.getCacheFrom()

Parameters:

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

Returns:

this

cacheTo

@Stability(Stable)
public AssetImageCodeProps.Builder cacheTo(DockerCacheOption cacheTo)

Sets the value of DockerImageAssetOptions.getCacheTo()

Parameters:

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

Returns:

this

file

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

Sets the value of DockerImageAssetOptions.getFile()

Parameters:

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

Returns:

this

invalidation

@Stability(Stable)
public AssetImageCodeProps.Builder invalidation(DockerImageAssetInvalidationOptions invalidation)

Sets the value of DockerImageAssetOptions.getInvalidation()

Parameters:

invalidation - Options to control which parameters are used to invalidate the asset hash.

Returns:

this

networkMode

@Stability(Stable)
public AssetImageCodeProps.Builder networkMode(NetworkMode networkMode)

Sets the value of DockerImageAssetOptions.getNetworkMode()

Parameters:

networkMode - Networking mode for the RUN commands during build. Support docker API 1.25+.

Returns:

this

outputs

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

Sets the value of DockerImageAssetOptions.getOutputs()

Parameters:

outputs - Outputs to pass to the docker build command.

Returns:

this

platform

@Stability(Stable)
public AssetImageCodeProps.Builder platform(Platform platform)

Sets the value of DockerImageAssetOptions.getPlatform()

Parameters:

platform - Platform to build for. Requires Docker Buildx.

Returns:

this

target

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

Sets the value of DockerImageAssetOptions.getTarget()

Parameters:

target - Docker target to build to.

Returns:

this

extraHash

@Stability(Stable)
public AssetImageCodeProps.Builder extraHash(String extraHash)

Sets the value of FileFingerprintOptions.getExtraHash()

Parameters:

extraHash - Extra information to encode into the fingerprint (e.g. build instructions and other inputs).

Returns:

this

exclude

@Stability(Stable)
public AssetImageCodeProps.Builder exclude(List<String> exclude)

Sets the value of FileCopyOptions.getExclude()

Parameters:

exclude - File paths matching the patterns will be excluded. See ignoreMode to set the matching behavior. Has no effect on Assets bundled using the bundling property.

Returns:

this

followSymlinks

@Stability(Stable)
public AssetImageCodeProps.Builder followSymlinks(SymlinkFollowMode followSymlinks)

Sets the value of FileCopyOptions.getFollowSymlinks()

Parameters:

followSymlinks - A strategy for how to handle symlinks.

Returns:

this

ignoreMode

@Stability(Stable)
public AssetImageCodeProps.Builder ignoreMode(IgnoreMode ignoreMode)

Sets the value of FileCopyOptions.getIgnoreMode()

Parameters:

ignoreMode - The ignore behavior to use for exclude patterns.

Returns:

this

build

@Stability(Stable)
public AssetImageCodeProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AssetImageCodeProps

Throws:

NullPointerException - if any required attribute was not provided