Package software.amazon.awscdk

Class DockerRunOptions.Builder

java.lang.Object

software.amazon.awscdk.DockerRunOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerRunOptions>

Enclosing interface:

DockerRunOptions

@Stability(Stable)
public static final class DockerRunOptions.Builder
extends Object
implements software.amazon.jsii.Builder<DockerRunOptions>

A builder for DockerRunOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DockerRunOptions	build()	Builds the configured instance.
DockerRunOptions.Builder	command(List<String> command)	Sets the value of DockerRunOptions.getCommand()
DockerRunOptions.Builder	entrypoint(List<String> entrypoint)	Sets the value of DockerRunOptions.getEntrypoint()
DockerRunOptions.Builder	environment(Map<String,String> environment)	Sets the value of DockerRunOptions.getEnvironment()
DockerRunOptions.Builder	network(String network)	Sets the value of DockerRunOptions.getNetwork()
DockerRunOptions.Builder	platform(String platform)	Sets the value of DockerRunOptions.getPlatform()
DockerRunOptions.Builder	securityOpt(String securityOpt)	Sets the value of DockerRunOptions.getSecurityOpt()
DockerRunOptions.Builder	user(String user)	Sets the value of DockerRunOptions.getUser()
DockerRunOptions.Builder	volumes(List<? extends DockerVolume> volumes)	Sets the value of DockerRunOptions.getVolumes()
DockerRunOptions.Builder	volumesFrom(List<String> volumesFrom)	Sets the value of DockerRunOptions.getVolumesFrom()
DockerRunOptions.Builder	workingDirectory(String workingDirectory)	Sets the value of DockerRunOptions.getWorkingDirectory()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

command

@Stability(Stable)
public DockerRunOptions.Builder command(List<String> command)

Sets the value of DockerRunOptions.getCommand()

Parameters:

command - The command to run in the container.

Returns:

this

entrypoint

@Stability(Stable)
public DockerRunOptions.Builder entrypoint(List<String> entrypoint)

Sets the value of DockerRunOptions.getEntrypoint()

Parameters:

entrypoint - The entrypoint to run in the container.

Returns:

this

environment

@Stability(Stable)
public DockerRunOptions.Builder environment(Map<String,String> environment)

Sets the value of DockerRunOptions.getEnvironment()

Parameters:

environment - The environment variables to pass to the container.

Returns:

this

network

@Stability(Stable)
public DockerRunOptions.Builder network(String network)

Sets the value of DockerRunOptions.getNetwork()

Parameters:

network - Docker Networking options.

Returns:

this

platform

@Stability(Stable)
public DockerRunOptions.Builder platform(String platform)

Sets the value of DockerRunOptions.getPlatform()

Parameters:

platform - Set platform if server is multi-platform capable. Requires Docker Engine API v1.38+. Example value: linux/amd64

Returns:

this

securityOpt

@Stability(Stable)
public DockerRunOptions.Builder securityOpt(String securityOpt)

Sets the value of DockerRunOptions.getSecurityOpt()

Parameters:

securityOpt - Security configuration when running the docker container.

Returns:

this

user

@Stability(Stable)
public DockerRunOptions.Builder user(String user)

Sets the value of DockerRunOptions.getUser()

Parameters:

user - The user to use when running the container.

Returns:

this

volumes

@Stability(Stable)
public DockerRunOptions.Builder volumes(List<? extends DockerVolume> volumes)

Sets the value of DockerRunOptions.getVolumes()

Parameters:

volumes - Docker volumes to mount.

Returns:

this

volumesFrom

@Stability(Stable)
public DockerRunOptions.Builder volumesFrom(List<String> volumesFrom)

Sets the value of DockerRunOptions.getVolumesFrom()

Parameters:

volumesFrom - Where to mount the specified volumes from.

Returns:

this

workingDirectory

@Stability(Stable)
public DockerRunOptions.Builder workingDirectory(String workingDirectory)

Sets the value of DockerRunOptions.getWorkingDirectory()

Parameters:

workingDirectory - Working directory inside the container.

Returns:

this

build

@Stability(Stable)
public DockerRunOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DockerRunOptions>

Returns:

a new instance of DockerRunOptions

Throws:

NullPointerException - if any required attribute was not provided