io.github.cdklabs.projen

Interface DockerComposeServiceDescription

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerComposeServiceDescription.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.393Z")
 @Stability(value=Experimental)
public interface DockerComposeServiceDescription
extends software.amazon.jsii.JsiiSerializable

(experimental) Description of a docker-compose.yml service.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DockerComposeServiceDescription.Builder	builder()
default List<String>	getCommand() (experimental) Provide a command to the docker container.
default List<IDockerComposeServiceName>	getDependsOn() (experimental) Names of other services this service depends on.
default Map<String,String>	getEnvironment() (experimental) Add environment variables.
default String	getImage() (experimental) Use a docker image.
default DockerComposeBuild	getImageBuild() (experimental) Build a docker image.
default List<DockerComposeServicePort>	getPorts() (experimental) Map some ports.
default List<IDockerComposeVolumeBinding>	getVolumes() (experimental) Mount some volumes into the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCommand

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

(experimental) Provide a command to the docker container.

Default: - use the container's default command

getDependsOn

@Stability(value=Experimental)
 @Nullable
default List<IDockerComposeServiceName> getDependsOn()

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

Default: - no dependencies

getEnvironment

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

(experimental) Add environment variables.

Default: - no environment variables are provided

getImage

@Stability(value=Experimental)
 @Nullable
default String getImage()

(experimental) Use a docker image.

Note: You must specify either build or image key.

See Also:

imageBuild

getImageBuild

@Stability(value=Experimental)
 @Nullable
default DockerComposeBuild getImageBuild()

(experimental) Build a docker image.

Note: You must specify either imageBuild or image key.

See Also:

image

getPorts

@Stability(value=Experimental)
 @Nullable
default List<DockerComposeServicePort> getPorts()

(experimental) Map some ports.

Default: - no ports are mapped

getVolumes

@Stability(value=Experimental)
 @Nullable
default List<IDockerComposeVolumeBinding> getVolumes()

(experimental) Mount some volumes into the service.

Use one of the following to create volumes:

See Also:

to create & mount a named volume

builder

@Stability(value=Experimental)
static DockerComposeServiceDescription.Builder builder()

Returns:

a DockerComposeServiceDescription.Builder of DockerComposeServiceDescription