software.amazon.awscdk.core

Interface DockerRunOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerRunOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-05-25T18:24:00.669Z")
 @Stability(value=Stable)
public interface DockerRunOptions
extends software.amazon.jsii.JsiiSerializable

Docker run options.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DockerRunOptions.Builder	builder()
default List<String>	getCommand() The command to run in the container.
default List<String>	getEntrypoint() The entrypoint to run in the container.
default Map<String,String>	getEnvironment() The environment variables to pass to the container.
default String	getUser() The user to use when running the container.
default List<DockerVolume>	getVolumes() Docker volumes to mount.
default String	getWorkingDirectory() Working directory inside the container.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCommand

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

The command to run in the container.

Default: - run the command defined in the image

getEntrypoint

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

The entrypoint to run in the container.

Default: - run the entrypoint defined in the image

getEnvironment

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

The environment variables to pass to the container.

Default: - no environment variables.

getUser

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

The user to use when running the container.

Default: - root or image default

getVolumes

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

Docker volumes to mount.

Default: - no volumes are mounted

getWorkingDirectory

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

Working directory inside the container.

Default: - image default

builder

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

Returns:

a DockerRunOptions.Builder of DockerRunOptions