Package io.github.cdklabs.projen

Class DockerComposeService.Builder

java.lang.Object

io.github.cdklabs.projen.DockerComposeService.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerComposeService>

Enclosing class:

DockerComposeService

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

(experimental) A fluent builder for DockerComposeService.

Method Summary

Modifier and Type	Method	Description
DockerComposeService	build()
DockerComposeService.Builder	command(List<String> command)	(experimental) Provide a command to the docker container.
static DockerComposeService.Builder	create(String serviceName)
DockerComposeService.Builder	dependsOn(List<? extends IDockerComposeServiceName> dependsOn)	(experimental) Names of other services this service depends on.
DockerComposeService.Builder	entrypoint(List<String> entrypoint)	(experimental) Entrypoint to run in the container.
DockerComposeService.Builder	environment(Map<String,String> environment)	(experimental) Add environment variables.
DockerComposeService.Builder	image(String image)	(experimental) Use a docker image.
DockerComposeService.Builder	imageBuild(DockerComposeBuild imageBuild)	(experimental) Build a docker image.
DockerComposeService.Builder	labels(Map<String,String> labels)	(experimental) Add labels.
DockerComposeService.Builder	networks(List<? extends IDockerComposeNetworkBinding> networks)	(experimental) Add some networks to the service.
DockerComposeService.Builder	platform(String platform)	(experimental) Add platform.
DockerComposeService.Builder	ports(List<? extends DockerComposeServicePort> ports)	(experimental) Map some ports.
DockerComposeService.Builder	privileged(Boolean privileged)	(experimental) Run in privileged mode.
DockerComposeService.Builder	volumes(List<? extends IDockerComposeVolumeBinding> volumes)	(experimental) Mount some volumes into the service.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static DockerComposeService.Builder create(String serviceName)

Parameters:

serviceName - The name of the docker compose service. This parameter is required.

Returns:

a new instance of DockerComposeService.Builder.

command

@Stability(Experimental)
public DockerComposeService.Builder command(List<String> command)

(experimental) Provide a command to the docker container.

Default: - use the container's default command

Parameters:

command - Provide a command to the docker container. This parameter is required.

Returns:

this

dependsOn

@Stability(Experimental)
public DockerComposeService.Builder dependsOn(List<? extends IDockerComposeServiceName> dependsOn)

(experimental) Names of other services this service depends on.

Default: - no dependencies

Parameters:

dependsOn - Names of other services this service depends on. This parameter is required.

Returns:

this

entrypoint

@Stability(Experimental)
public DockerComposeService.Builder entrypoint(List<String> entrypoint)

(experimental) Entrypoint to run in the container.

Parameters:

entrypoint - Entrypoint to run in the container. This parameter is required.

Returns:

this

environment

@Stability(Experimental)
public DockerComposeService.Builder environment(Map<String,String> environment)

(experimental) Add environment variables.

Default: - no environment variables are provided

Parameters:

environment - Add environment variables. This parameter is required.

Returns:

this

image

@Stability(Experimental)
public DockerComposeService.Builder image(String image)

(experimental) Use a docker image.

Note: You must specify either build or image key.

Parameters:

image - Use a docker image. This parameter is required.

Returns:

this

See Also:

imageBuild

imageBuild

@Stability(Experimental)
public DockerComposeService.Builder imageBuild(DockerComposeBuild imageBuild)

(experimental) Build a docker image.

Note: You must specify either imageBuild or image key.

Parameters:

imageBuild - Build a docker image. This parameter is required.

Returns:

this

See Also:

image

labels

@Stability(Experimental)
public DockerComposeService.Builder labels(Map<String,String> labels)

(experimental) Add labels.

Default: - no labels are provided

Parameters:

labels - Add labels. This parameter is required.

Returns:

this

networks

@Stability(Experimental)
public DockerComposeService.Builder networks(List<? extends IDockerComposeNetworkBinding> networks)

(experimental) Add some networks to the service.

Parameters:

networks - Add some networks to the service. This parameter is required.

Returns:

this

See Also:

DockerCompose.network () to create & mount a named network

platform

@Stability(Experimental)
public DockerComposeService.Builder platform(String platform)

(experimental) Add platform.

Default: - no platform is provided

Parameters:

platform - Add platform. This parameter is required.

Returns:

this

ports

@Stability(Experimental)
public DockerComposeService.Builder ports(List<? extends DockerComposeServicePort> ports)

(experimental) Map some ports.

Default: - no ports are mapped

Parameters:

ports - Map some ports. This parameter is required.

Returns:

this

privileged

@Stability(Experimental)
public DockerComposeService.Builder privileged(Boolean privileged)

(experimental) Run in privileged mode.

Default: - no privileged mode flag is provided

Parameters:

privileged - Run in privileged mode. This parameter is required.

Returns:

this

volumes

@Stability(Experimental)
public DockerComposeService.Builder volumes(List<? extends IDockerComposeVolumeBinding> volumes)

(experimental) Mount some volumes into the service.

Use one of the following to create volumes:

Parameters:

volumes - Mount some volumes into the service. This parameter is required.

Returns:

this

See Also:

DockerCompose.namedVolume () to create & mount a named volume

build

@Stability(Experimental)
public DockerComposeService build()

Specified by:

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

Returns:

a newly built instance of DockerComposeService.