software.amazon.awscdk

Interface BundlingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BundlingOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.795Z")
 @Stability(value=Stable)
public interface BundlingOptions
extends software.amazon.jsii.JsiiSerializable

Bundling options.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 Asset asset = Asset.Builder.create(this, "BundledAsset")
         .path("/path/to/asset")
         .bundling(BundlingOptions.builder()
                 .image(ambda.getRuntime().getPYTHON_3_9().getBundlingImage())
                 .command(List.of("bash", "-c", "pip install -r requirements.txt -t /asset-output && cp -au . /asset-output"))
                 .securityOpt("no-new-privileges:true") // https://docs.docker.com/engine/reference/commandline/run/#optional-security-options---security-opt
                 .network("host")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BundlingOptions.Builder A builder for BundlingOptions
static class	BundlingOptions.Jsii$Proxy An implementation for BundlingOptions

Method Summary

Modifier and Type	Method and Description
static BundlingOptions.Builder	builder()
default List<String>	getCommand() The command to run in the Docker container.
default List<String>	getEntrypoint() The entrypoint to run in the Docker container.
default Map<String,String>	getEnvironment() The environment variables to pass to the Docker container.
DockerImage	getImage() The Docker image where the command will run.
default ILocalBundling	getLocal() Local bundling provider.
default String	getNetwork() Docker [Networking options](https://docs.docker.com/engine/reference/commandline/run/#connect-a-container-to-a-network---network).
default BundlingOutput	getOutputType() The type of output that this bundling operation is producing.
default String	getSecurityOpt() [Security configuration](https://docs.docker.com/engine/reference/run/#security-configuration) when running the docker container.
default String	getUser() The user to use when running the Docker container.
default List<DockerVolume>	getVolumes() Additional Docker volumes to mount.
default String	getWorkingDirectory() Working directory inside the Docker container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getImage

@Stability(value=Stable)
 @NotNull
DockerImage getImage()

The Docker image where the command will run.

getCommand

@Stability(value=Stable)
 @Nullable
default List<String> getCommand()

The command to run in the Docker container.

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

Default: - run the command defined in the image

See Also:

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

getEntrypoint

@Stability(value=Stable)
 @Nullable
default List<String> getEntrypoint()

The entrypoint to run in the Docker container.

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

Default: - run the entrypoint defined in the image

See Also:

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

getEnvironment

@Stability(value=Stable)
 @Nullable
default Map<String,String> getEnvironment()

The environment variables to pass to the Docker container.

Default: - no environment variables.

getLocal

@Stability(value=Stable)
 @Nullable
default ILocalBundling getLocal()

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

getNetwork

@Stability(value=Stable)
 @Nullable
default String getNetwork()

Docker [Networking options](https://docs.docker.com/engine/reference/commandline/run/#connect-a-container-to-a-network---network).

Default: - no networking options

getOutputType

@Stability(value=Stable)
 @Nullable
default BundlingOutput getOutputType()

The type of output that this bundling operation is producing.

Default: BundlingOutput.AUTO_DISCOVER

getSecurityOpt

@Stability(value=Stable)
 @Nullable
default String getSecurityOpt()

[Security configuration](https://docs.docker.com/engine/reference/run/#security-configuration) when running the docker container.

Default: - no security options

getUser

@Stability(value=Stable)
 @Nullable
default String getUser()

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

See Also:

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

getVolumes

@Stability(value=Stable)
 @Nullable
default List<DockerVolume> getVolumes()

Additional Docker volumes to mount.

Default: - no additional volumes are mounted

getWorkingDirectory

@Stability(value=Stable)
 @Nullable
default String getWorkingDirectory()

Working directory inside the Docker container.

Default: /asset-input

builder

@Stability(value=Stable)
static BundlingOptions.Builder builder()

Returns:

a BundlingOptions.Builder of BundlingOptions