Package software.amazon.awscdk

Class BundlingOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.BundlingOptions.Jsii$Proxy

All Implemented Interfaces:

BundlingOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

BundlingOptions

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

An implementation for BundlingOptions

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

BundlingOptions.Builder, BundlingOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(BundlingOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the BundlingOptions.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 BundlingFileAccess	getBundlingFileAccess()	The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.
final List<String>	getCommand()	The command to run in the Docker container.
final List<String>	getEntrypoint()	The entrypoint to run in the Docker container.
final Map<String,String>	getEnvironment()	The environment variables to pass to the Docker container.
final DockerImage	getImage()	The Docker image where the command will run.
final ILocalBundling	getLocal()	Local bundling provider.
final String	getNetwork()	Docker Networking options.
final BundlingOutput	getOutputType()	The type of output that this bundling operation is producing.
final String	getPlatform()	Platform to build for.
final String	getSecurityOpt()	Security configuration when running the docker container.
final String	getUser()	The user to use when running the Docker container.
final List<DockerVolume>	getVolumes()	Additional Docker volumes to mount.
final List<String>	getVolumesFrom()	Where to mount the specified volumes from.
final String	getWorkingDirectory()	Working directory inside the Docker container.
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(BundlingOptions.Builder builder)

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

Method Details

getImage

public final DockerImage getImage()

Description copied from interface: BundlingOptions

The Docker image where the command will run.

Specified by:

getImage in interface BundlingOptions

getBundlingFileAccess

public final BundlingFileAccess getBundlingFileAccess()

Description copied from interface: BundlingOptions

The access mechanism used to make source files available to the bundling container and to return the bundling output back to the host.

Default: - BundlingFileAccess.BIND_MOUNT

Specified by:

getBundlingFileAccess in interface BundlingOptions

getCommand

public final List<String> getCommand()

Description copied from interface: BundlingOptions

The command to run in the Docker container.

Example value: ['npm', 'install']

Default: - run the command defined in the image

Specified by:

getCommand in interface BundlingOptions

See Also:

• https://docs.docker.com/engine/reference/run/

getEntrypoint

public final List<String> getEntrypoint()

Description copied from interface: BundlingOptions

The entrypoint to run in the Docker container.

Example value: ['/bin/sh', '-c']

Default: - run the entrypoint defined in the image

Specified by:

getEntrypoint in interface BundlingOptions

See Also:

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

getEnvironment

public final Map<String,String> getEnvironment()

Description copied from interface: BundlingOptions

The environment variables to pass to the Docker container.

Default: - no environment variables.

Specified by:

getEnvironment in interface BundlingOptions

getLocal

public final ILocalBundling getLocal()

Description copied from interface: BundlingOptions

Local bundling provider.

The provider implements a method tryBundle() which should return true if local bundling was performed. If false is returned, docker bundling will be done.

Default: - bundling will only be performed in a Docker container

Specified by:

getLocal in interface BundlingOptions

getNetwork

public final String getNetwork()

Description copied from interface: BundlingOptions

Docker Networking options.

Default: - no networking options

Specified by:

getNetwork in interface BundlingOptions

getOutputType

public final BundlingOutput getOutputType()

Description copied from interface: BundlingOptions

The type of output that this bundling operation is producing.

Default: BundlingOutput.AUTO_DISCOVER

Specified by:

getOutputType in interface BundlingOptions

getPlatform

public final String getPlatform()

Description copied from interface: BundlingOptions

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 BundlingOptions

getSecurityOpt

public final String getSecurityOpt()

Description copied from interface: BundlingOptions

Security configuration when running the docker container.

Default: - no security options

Specified by:

getSecurityOpt in interface BundlingOptions

getUser

public final String getUser()

Description copied from interface: BundlingOptions

The user to use when running the Docker container.

user | user:group | uid | uid:gid | user:gid | uid:group

Default: - uid:gid of the current user or 1000:1000 on Windows

Specified by:

getUser in interface BundlingOptions

See Also:

• https://docs.docker.com/engine/reference/run/#user

getVolumes

public final List<DockerVolume> getVolumes()

Description copied from interface: BundlingOptions

Additional Docker volumes to mount.

Default: - no additional volumes are mounted

Specified by:

getVolumes in interface BundlingOptions

getVolumesFrom

public final List<String> getVolumesFrom()

Description copied from interface: BundlingOptions

Where to mount the specified volumes from.

Default: - no containers are specified to mount volumes from

Specified by:

getVolumesFrom in interface BundlingOptions

See Also:

• https://docs.docker.com/engine/reference/commandline/run/#mount-volumes-from-container---volumes-from

getWorkingDirectory

public final String getWorkingDirectory()

Description copied from interface: BundlingOptions

Working directory inside the Docker container.

Default: /asset-input

Specified by:

getWorkingDirectory in interface BundlingOptions

$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