software.amazon.awscdk.services.lambda

Class AssetImageCode.Builder

java.lang.Object

software.amazon.awscdk.services.lambda.AssetImageCode.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AssetImageCode>

Enclosing class:

AssetImageCode

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

A fluent builder for AssetImageCode.

Method Summary

Modifier and Type	Method and Description
AssetImageCode	build()
AssetImageCode.Builder	buildArgs(Map<String,String> buildArgs) (experimental) Build args to pass to the `docker build` command.
AssetImageCode.Builder	cmd(List<String> cmd) Specify or override the CMD on the specified Docker image or Dockerfile.
static AssetImageCode.Builder	create(String directory)
AssetImageCode.Builder	entrypoint(List<String> entrypoint) Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile.
AssetImageCode.Builder	exclude(List<String> exclude) Deprecated.
AssetImageCode.Builder	extraHash(String extraHash) Deprecated.
AssetImageCode.Builder	file(String file) (experimental) Path to the Dockerfile (relative to the directory).
AssetImageCode.Builder	follow(software.amazon.awscdk.assets.FollowMode follow) Deprecated.
AssetImageCode.Builder	ignoreMode(IgnoreMode ignoreMode) Deprecated.
AssetImageCode.Builder	repositoryName(String repositoryName) Deprecated. to control the location of docker image assets, please override `Stack.addDockerImageAsset`. this feature will be removed in future releases.
AssetImageCode.Builder	target(String target) (experimental) Docker target to build to.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static AssetImageCode.Builder create(String directory)

Parameters:

directory - This parameter is required.

Returns:

a new instance of AssetImageCode.Builder.

exclude

@Stability(value=Deprecated)
 @Deprecated
public AssetImageCode.Builder exclude(List<String> exclude)

Deprecated.

(deprecated) Glob patterns to exclude from the copy.

Default: nothing is excluded

Parameters:

exclude - Glob patterns to exclude from the copy. This parameter is required.

Returns:

this

follow

@Stability(value=Deprecated)
 @Deprecated
public AssetImageCode.Builder follow(software.amazon.awscdk.assets.FollowMode follow)

Deprecated.

(deprecated) A strategy for how to handle symlinks.

Default: Never

Parameters:

follow - A strategy for how to handle symlinks. This parameter is required.

Returns:

this

ignoreMode

@Stability(value=Deprecated)
 @Deprecated
public AssetImageCode.Builder ignoreMode(IgnoreMode ignoreMode)

Deprecated.

(deprecated) The ignore behavior to use for exclude patterns.

Default: - GLOB for file assets, DOCKER or GLOB for docker assets depending on whether the '

Parameters:

ignoreMode - The ignore behavior to use for exclude patterns. This parameter is required.

Returns:

this

extraHash

@Stability(value=Deprecated)
 @Deprecated
public AssetImageCode.Builder extraHash(String extraHash)

Deprecated.

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

Default: - hash is only based on source content

Parameters:

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

Returns:

this

buildArgs

@Stability(value=Experimental)
public AssetImageCode.Builder buildArgs(Map<String,String> buildArgs)

(experimental) 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).

Default: - no build args are passed

Parameters:

buildArgs - Build args to pass to the `docker build` command. This parameter is required.

Returns:

this

file

@Stability(value=Experimental)
public AssetImageCode.Builder file(String file)

(experimental) Path to the Dockerfile (relative to the directory).

Default: 'Dockerfile'

Parameters:

file - Path to the Dockerfile (relative to the directory). This parameter is required.

Returns:

this

repositoryName

@Stability(value=Deprecated)
 @Deprecated
public AssetImageCode.Builder repositoryName(String repositoryName)

Deprecated. to control the location of docker image assets, please override `Stack.addDockerImageAsset`. this feature will be removed in future releases.

(deprecated) ECR repository name.

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: - the default ECR repository for CDK assets

Parameters:

repositoryName - ECR repository name. This parameter is required.

Returns:

this

target

@Stability(value=Experimental)
public AssetImageCode.Builder target(String target)

(experimental) Docker target to build to.

Default: - no target

Parameters:

target - Docker target to build to. This parameter is required.

Returns:

this

cmd

@Stability(value=Stable)
public AssetImageCode.Builder cmd(List<String> 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' ].

Default: - use the CMD specified in the docker image or Dockerfile.

Parameters:

cmd - Specify or override the CMD on the specified Docker image or Dockerfile. This parameter is required.

Returns:

this

See Also:

https://docs.docker.com/engine/reference/builder/#cmd

entrypoint

@Stability(value=Stable)
public AssetImageCode.Builder entrypoint(List<String> 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' ].

Default: - use the ENTRYPOINT in the docker image or Dockerfile.

Parameters:

entrypoint - Specify or override the ENTRYPOINT on the specified Docker image or Dockerfile. This parameter is required.

Returns:

this

See Also:

https://docs.docker.com/engine/reference/builder/#entrypoint

build

@Stability(value=Stable)
public AssetImageCode build()

Specified by:

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