software.amazon.awscdk

Class DockerImageAssetSource.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.DockerImageAssetSource.Jsii$Proxy

All Implemented Interfaces:

DockerImageAssetSource, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DockerImageAssetSource

@Stability(value=Stable)
 @Internal
public static final class DockerImageAssetSource.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements DockerImageAssetSource

An implementation for DockerImageAssetSource

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.DockerImageAssetSource

DockerImageAssetSource.Builder, DockerImageAssetSource.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(DockerImageAssetSource.Builder builder) Constructor that initializes the object based on literal property values passed by the DockerImageAssetSource.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getDirectoryName() The directory where the Dockerfile is stored, must be relative to the cloud assembly root.
Map<String,String>	getDockerBuildArgs() Build args to pass to the `docker build` command.
String	getDockerBuildTarget() Docker target to build to.
String	getDockerFile() Path to the Dockerfile (relative to the directory).
List<String>	getExecutable() An external command that will produce the packaged asset.
String	getNetworkMode() Networking mode for the RUN commands during build.
String	getPlatform() Platform to build for.
String	getSourceHash() The hash of the contents of the docker build context.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.DockerImageAssetSource

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(DockerImageAssetSource.Builder builder)

Constructor that initializes the object based on literal property values passed by the DockerImageAssetSource.Builder.

Method Detail

getSourceHash

public final String getSourceHash()

Description copied from interface: DockerImageAssetSource

The hash of the contents of the docker build context.

This hash is used throughout the system to identify this image and avoid duplicate work in case the source did not change.

NOTE: this means that if you wish to update your docker image, you must make a modification to the source (e.g. add some metadata to your Dockerfile).

Specified by:

getSourceHash in interface DockerImageAssetSource

getDirectoryName

public final String getDirectoryName()

Description copied from interface: DockerImageAssetSource

The directory where the Dockerfile is stored, must be relative to the cloud assembly root.

Default: - Exactly one of `directoryName` and `executable` is required

Specified by:

getDirectoryName in interface DockerImageAssetSource

getDockerBuildArgs

public final Map<String,String> getDockerBuildArgs()

Description copied from interface: DockerImageAssetSource

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

Only allowed when directoryName is specified.

Default: - no build args are passed

Specified by:

getDockerBuildArgs in interface DockerImageAssetSource

getDockerBuildTarget

public final String getDockerBuildTarget()

Description copied from interface: DockerImageAssetSource

Docker target to build to.

Only allowed when directoryName is specified.

Default: - no target

Specified by:

getDockerBuildTarget in interface DockerImageAssetSource

getDockerFile

public final String getDockerFile()

Description copied from interface: DockerImageAssetSource

Path to the Dockerfile (relative to the directory).

Only allowed when directoryName is specified.

Default: - no file

Specified by:

getDockerFile in interface DockerImageAssetSource

getExecutable

public final List<String> getExecutable()

Description copied from interface: DockerImageAssetSource

An external command that will produce the packaged asset.

The command should produce the name of a local Docker image on stdout.

Default: - Exactly one of `directoryName` and `executable` is required

Specified by:

getExecutable in interface DockerImageAssetSource

getNetworkMode

public final String getNetworkMode()

Description copied from interface: DockerImageAssetSource

Networking mode for the RUN commands during build. _Requires Docker Engine API v1.25+_.

Specify this property to build images on a specific networking mode.

Default: - no networking mode specified

Specified by:

getNetworkMode in interface DockerImageAssetSource

getPlatform

public final String getPlatform()

Description copied from interface: DockerImageAssetSource

Platform to build for. _Requires Docker Buildx_.

Specify this property to build images on a specific platform.

Default: - no platform specified (the current machine architecture will be used)

Specified by:

getPlatform in interface DockerImageAssetSource

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object