Package software.amazon.awscdk.services.ecr.assets

Class DockerImageAssetProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecr.assets.DockerImageAssetProps.Jsii$Proxy

All Implemented Interfaces:

FileCopyOptions, FileFingerprintOptions, DockerImageAssetOptions, DockerImageAssetProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DockerImageAssetProps

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

An implementation for DockerImageAssetProps

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.services.ecr.assets.DockerImageAssetProps

DockerImageAssetProps.Builder, DockerImageAssetProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DockerImageAssetProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the DockerImageAssetProps.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 String	getAssetName()	Unique identifier of the docker image asset and its potential revisions.
final Map<String,String>	getBuildArgs()	Build args to pass to the docker build command.
final Map<String,String>	getBuildSecrets()	Build secrets.
final String	getBuildSsh()	SSH agent socket or keys to pass to the docker build command.
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 where the Dockerfile is stored.
final String	getDisplayName()	A display name for this asset.
final List<String>	getExclude()	File paths matching the patterns will be excluded.
final String	getExtraHash()	Extra information to encode into the fingerprint (e.g.
final String	getFile()	Path to the Dockerfile (relative to the directory).
final SymlinkFollowMode	getFollowSymlinks()	A strategy for how to handle symlinks.
final IgnoreMode	getIgnoreMode()	The ignore behavior to use for exclude patterns.
final DockerImageAssetInvalidationOptions	getInvalidation()	Options to control which parameters are used to invalidate the asset hash.
final NetworkMode	getNetworkMode()	Networking mode for the RUN commands during build.
final List<String>	getOutputs()	Outputs to pass to the docker build command.
final Platform	getPlatform()	Platform to build for.
final String	getTarget()	Docker target to build to.
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(DockerImageAssetProps.Builder builder)

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

Method Details

getDirectory

public final String getDirectory()

Description copied from interface: DockerImageAssetProps

The directory where the Dockerfile is stored.

Any directory inside with a name that matches the CDK output folder (cdk.out by default) will be excluded from the asset

Specified by:

getDirectory in interface DockerImageAssetProps

getAssetName

public final String getAssetName()

Description copied from interface: DockerImageAssetOptions

Unique identifier of the docker image asset and its potential revisions.

Required if using AppScopedStagingSynthesizer.

Default: - no asset name

Specified by:

getAssetName in interface DockerImageAssetOptions

getBuildArgs

public final Map<String,String> getBuildArgs()

Description copied from interface: DockerImageAssetOptions

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

Specified by:

getBuildArgs in interface DockerImageAssetOptions

getBuildSecrets

public final Map<String,String> getBuildSecrets()

Description copied from interface: DockerImageAssetOptions

Build secrets.

Docker BuildKit must be enabled to use build secrets.

Default: - no build secrets

Example:

 import software.amazon.awscdk.DockerBuildSecret;
 Map<String, String> buildSecrets = Map.of(
         "MY_SECRET", DockerBuildSecret.fromSrc("file.txt"));
 

Specified by:

getBuildSecrets in interface DockerImageAssetOptions

See Also:

• https://docs.docker.com/build/buildkit/

getBuildSsh

public final String getBuildSsh()

Description copied from interface: DockerImageAssetOptions

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

Docker BuildKit must be enabled to use the ssh flag

Default: - no --ssh flag

Specified by:

getBuildSsh in interface DockerImageAssetOptions

See Also:

• https://docs.docker.com/build/buildkit/

getCacheDisabled

public final Boolean getCacheDisabled()

Description copied from interface: DockerImageAssetOptions

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

Default: - cache is used

Specified by:

getCacheDisabled in interface DockerImageAssetOptions

getCacheFrom

public final List<DockerCacheOption> getCacheFrom()

Description copied from interface: DockerImageAssetOptions

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 DockerImageAssetOptions

See Also:

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

getCacheTo

public final DockerCacheOption getCacheTo()

Description copied from interface: DockerImageAssetOptions

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 DockerImageAssetOptions

See Also:

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

getDisplayName

public final String getDisplayName()

Description copied from interface: DockerImageAssetOptions

A display name for this asset.

If supplied, the display name will be used in locations where the asset identifier is printed, like in the CLI progress information. If the same asset is added multiple times, the display name of the first occurrence is used.

If assetName is given, it will also be used as the default displayName. Otherwise, the default is the construct path of the ImageAsset construct, with respect to the enclosing stack. If the asset is produced by a construct helper function (such as lambda.Code.fromAssetImage()), this will look like MyFunction/AssetImage.

We use the stack-relative construct path so that in the common case where you have multiple stacks with the same asset, we won't show something like /MyBetaStack/MyFunction/Code when you are actually deploying to production.

Default: - Stack-relative construct path

Specified by:

getDisplayName in interface DockerImageAssetOptions

getFile

public final String getFile()

Description copied from interface: DockerImageAssetOptions

Path to the Dockerfile (relative to the directory).

Default: 'Dockerfile'

Specified by:

getFile in interface DockerImageAssetOptions

getInvalidation

public final DockerImageAssetInvalidationOptions getInvalidation()

Description copied from interface: DockerImageAssetOptions

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

Default: - hash all parameters

Specified by:

getInvalidation in interface DockerImageAssetOptions

getNetworkMode

public final NetworkMode getNetworkMode()

Description copied from interface: DockerImageAssetOptions

Networking mode for the RUN commands during build.

Support docker API 1.25+.

Default: - no networking mode specified (the default networking mode `NetworkMode.DEFAULT` will be used)

Specified by:

getNetworkMode in interface DockerImageAssetOptions

getOutputs

public final List<String> getOutputs()

Description copied from interface: DockerImageAssetOptions

Outputs to pass to the docker build command.

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

Specified by:

getOutputs in interface DockerImageAssetOptions

See Also:

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

getPlatform

public final Platform getPlatform()

Description copied from interface: DockerImageAssetOptions

Platform to build for.

Requires Docker Buildx.

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

Specified by:

getPlatform in interface DockerImageAssetOptions

getTarget

public final String getTarget()

Description copied from interface: DockerImageAssetOptions

Docker target to build to.

Default: - no target

Specified by:

getTarget in interface DockerImageAssetOptions

getExtraHash

public final String getExtraHash()

Description copied from interface: FileFingerprintOptions

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

Default: - hash is only based on source content

Specified by:

getExtraHash in interface FileFingerprintOptions

getExclude

public final List<String> getExclude()

Description copied from interface: FileCopyOptions

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.

Default: - nothing is excluded

Specified by:

getExclude in interface FileCopyOptions

getFollowSymlinks

public final SymlinkFollowMode getFollowSymlinks()

Description copied from interface: FileCopyOptions

A strategy for how to handle symlinks.

Default: SymlinkFollowMode.NEVER

Specified by:

getFollowSymlinks in interface FileCopyOptions

getIgnoreMode

public final IgnoreMode getIgnoreMode()

Description copied from interface: FileCopyOptions

The ignore behavior to use for exclude patterns.

Default: IgnoreMode.GLOB

Specified by:

getIgnoreMode in interface FileCopyOptions

$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