Package software.amazon.awscdk.cloud_assembly_schema

Class DockerImageSource.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cloud_assembly_schema.DockerImageSource.Jsii$Proxy

All Implemented Interfaces:

DockerImageSource, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DockerImageSource

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

An implementation for DockerImageSource

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.cloud_assembly_schema.DockerImageSource

DockerImageSource.Builder, DockerImageSource.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DockerImageSource.Builder builder)	Constructor that initializes the object based on literal property values passed by the DockerImageSource.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	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getCacheDisabled()	Disable the cache and pass --no-cache to the docker build command.
final List<DockerCacheOption>	getCacheFrom()	Cache from options to pass to the docker build command.
final DockerCacheOption	getCacheTo()	Cache to options to pass to the docker build command.
final String	getDirectory()	The directory containing the Docker image build instructions.
final Map<String,String>	getDockerBuildArgs()	Additional build arguments.
final Map<String,String>	getDockerBuildSecrets()	Additional build secrets.
final String	getDockerBuildSsh()	SSH agent socket or keys.
final String	getDockerBuildTarget()	Target build stage in a Dockerfile with multiple build stages.
final String	getDockerFile()	The name of the file with build instructions.
final List<String>	getDockerOutputs()	Outputs.
final List<String>	getExecutable()	A command-line executable that returns the name of a local Docker image on stdout after being run.
final String	getNetworkMode()	Networking mode for the RUN commands during build.
final String	getPlatform()	Platform to build for.
final 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

Constructor Details

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(DockerImageSource.Builder builder)

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

Method Details

getCacheDisabled

public final Boolean getCacheDisabled()

Description copied from interface: DockerImageSource

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

Default: - cache is used

Specified by:

getCacheDisabled in interface DockerImageSource

getCacheFrom

public final List<DockerCacheOption> getCacheFrom()

Description copied from interface: DockerImageSource

Cache from options to pass to the docker build command.

Default: - no cache from options are passed to the build command

Specified by:

getCacheFrom in interface DockerImageSource

See Also:

• https://docs.docker.com/build/cache/backends/

getCacheTo

public final DockerCacheOption getCacheTo()

Description copied from interface: DockerImageSource

Cache to options to pass to the docker build command.

Default: - no cache to options are passed to the build command

Specified by:

getCacheTo in interface DockerImageSource

See Also:

• https://docs.docker.com/build/cache/backends/

getDirectory

public final String getDirectory()

Description copied from interface: DockerImageSource

The directory containing the Docker image build instructions.

This path is relative to the asset manifest location.

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

Specified by:

getDirectory in interface DockerImageSource

getDockerBuildArgs

public final Map<String,String> getDockerBuildArgs()

Description copied from interface: DockerImageSource

Additional build arguments.

Only allowed when directory is set.

Default: - No additional build arguments

Specified by:

getDockerBuildArgs in interface DockerImageSource

getDockerBuildSecrets

public final Map<String,String> getDockerBuildSecrets()

Description copied from interface: DockerImageSource

Additional build secrets.

Only allowed when directory is set.

Default: - No additional build secrets

Specified by:

getDockerBuildSecrets in interface DockerImageSource

getDockerBuildSsh

public final String getDockerBuildSsh()

Description copied from interface: DockerImageSource

SSH agent socket or keys.

Requires building with docker buildkit.

Default: - No ssh flag is set

Specified by:

getDockerBuildSsh in interface DockerImageSource

getDockerBuildTarget

public final String getDockerBuildTarget()

Description copied from interface: DockerImageSource

Target build stage in a Dockerfile with multiple build stages.

Only allowed when directory is set.

Default: - The last stage in the Dockerfile

Specified by:

getDockerBuildTarget in interface DockerImageSource

getDockerFile

public final String getDockerFile()

Description copied from interface: DockerImageSource

The name of the file with build instructions.

Only allowed when directory is set.

Default: "Dockerfile"

Specified by:

getDockerFile in interface DockerImageSource

getDockerOutputs

public final List<String> getDockerOutputs()

Description copied from interface: DockerImageSource

Outputs.

Default: - no outputs are passed to the build command (default outputs are used)

Specified by:

getDockerOutputs in interface DockerImageSource

See Also:

• https://docs.docker.com/engine/reference/commandline/build/#custom-build-outputs

getExecutable

public final List<String> getExecutable()

Description copied from interface: DockerImageSource

A command-line executable that returns the name of a local Docker image on stdout after being run.

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

Specified by:

getExecutable in interface DockerImageSource

getNetworkMode

public final String getNetworkMode()

Description copied from interface: DockerImageSource

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 DockerImageSource

getPlatform

public final String getPlatform()

Description copied from interface: DockerImageSource

Platform to build for. Requires Docker Buildx.

Specify this property to build images on a specific platform/architecture.

Default: - current machine platform

Specified by:

getPlatform in interface DockerImageSource

$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