Package software.amazon.awscdk

Class DockerRunOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.DockerRunOptions.Jsii$Proxy

All Implemented Interfaces:

DockerRunOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DockerRunOptions

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

An implementation for DockerRunOptions

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

DockerRunOptions.Builder, DockerRunOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(DockerRunOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the DockerRunOptions.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 List<String>	getCommand()	The command to run in the container.
final List<String>	getEntrypoint()	The entrypoint to run in the container.
final Map<String,String>	getEnvironment()	The environment variables to pass to the container.
final String	getNetwork()	Docker Networking options.
final String	getPlatform()	Set platform if server is multi-platform capable.
final String	getSecurityOpt()	Security configuration when running the docker container.
final String	getUser()	The user to use when running the container.
final List<DockerVolume>	getVolumes()	Docker volumes to mount.
final List<String>	getVolumesFrom()	Where to mount the specified volumes from.
final String	getWorkingDirectory()	Working directory inside the 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(DockerRunOptions.Builder builder)

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

Method Details

getCommand

public final List<String> getCommand()

Description copied from interface: DockerRunOptions

The command to run in the container.

Default: - run the command defined in the image

Specified by:

getCommand in interface DockerRunOptions

getEntrypoint

public final List<String> getEntrypoint()

Description copied from interface: DockerRunOptions

The entrypoint to run in the container.

Default: - run the entrypoint defined in the image

Specified by:

getEntrypoint in interface DockerRunOptions

getEnvironment

public final Map<String,String> getEnvironment()

Description copied from interface: DockerRunOptions

The environment variables to pass to the container.

Default: - no environment variables.

Specified by:

getEnvironment in interface DockerRunOptions

getNetwork

public final String getNetwork()

Description copied from interface: DockerRunOptions

Docker Networking options.

Default: - no networking options

Specified by:

getNetwork in interface DockerRunOptions

getPlatform

public final String getPlatform()

Description copied from interface: DockerRunOptions

Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+.

Example value: linux/amd64

Default: - no platform specified

Specified by:

getPlatform in interface DockerRunOptions

getSecurityOpt

public final String getSecurityOpt()

Description copied from interface: DockerRunOptions

Security configuration when running the docker container.

Default: - no security options

Specified by:

getSecurityOpt in interface DockerRunOptions

getUser

public final String getUser()

Description copied from interface: DockerRunOptions

The user to use when running the container.

Default: - root or image default

Specified by:

getUser in interface DockerRunOptions

getVolumes

public final List<DockerVolume> getVolumes()

Description copied from interface: DockerRunOptions

Docker volumes to mount.

Default: - no volumes are mounted

Specified by:

getVolumes in interface DockerRunOptions

getVolumesFrom

public final List<String> getVolumesFrom()

Description copied from interface: DockerRunOptions

Where to mount the specified volumes from.

Default: - no containers are specified to mount volumes from

Specified by:

getVolumesFrom in interface DockerRunOptions

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: DockerRunOptions

Working directory inside the container.

Default: - image default

Specified by:

getWorkingDirectory in interface DockerRunOptions

$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