Package io.github.cdklabs.projen

Interface DockerComposeServiceDescription

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerComposeServiceDescription.Jsii$Proxy

@Generated(value="jsii-pacmak/1.100.0 (build 6a776be)",
           date="2024-06-21T23:10:11.663Z")
@Stability(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	Description
static class	DockerComposeServiceDescription.Builder	A builder for DockerComposeServiceDescription
static class	DockerComposeServiceDescription.Jsii$Proxy	An implementation for DockerComposeServiceDescription

Method Summary

Modifier and Type	Method	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 List<String>	getEntrypoint()	(experimental) Entrypoint to run in the container.
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 Map<String,String>	getLabels()	(experimental) Add labels.
default List<IDockerComposeNetworkBinding>	getNetworks()	(experimental) Add some networks to the service.
default String	getPlatform()	(experimental) Add platform.
default List<DockerComposeServicePort>	getPorts()	(experimental) Map some ports.
default Boolean	getPrivileged()	(experimental) Run in privileged mode.
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(Experimental)
@Nullable
default List<String> getCommand()

(experimental) Provide a command to the docker container.

Default: - use the container's default command

getDependsOn

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

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

Default: - no dependencies

getEntrypoint

@Stability(Experimental)
@Nullable
default List<String> getEntrypoint()

(experimental) Entrypoint to run in the container.

getEnvironment

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

(experimental) Add environment variables.

Default: - no environment variables are provided

getImage

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

(experimental) Use a docker image.

Note: You must specify either build or image key.

See Also:

imageBuild

getImageBuild

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

(experimental) Build a docker image.

Note: You must specify either imageBuild or image key.

See Also:

image

getLabels

@Stability(Experimental)
@Nullable
default Map<String,String> getLabels()

(experimental) Add labels.

Default: - no labels are provided

getNetworks

@Stability(Experimental)
@Nullable
default List<IDockerComposeNetworkBinding> getNetworks()

(experimental) Add some networks to the service.

See Also:

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

getPlatform

@Stability(Experimental)
@Nullable
default String getPlatform()

(experimental) Add platform.

Default: - no platform is provided

getPorts

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

(experimental) Map some ports.

Default: - no ports are mapped

getPrivileged

@Stability(Experimental)
@Nullable
default Boolean getPrivileged()

(experimental) Run in privileged mode.

Default: - no privileged mode flag is provided

getVolumes

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

(experimental) Mount some volumes into the service.

Use one of the following to create volumes:

See Also:

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

builder

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

Returns:

a DockerComposeServiceDescription.Builder of DockerComposeServiceDescription