Package io.github.cdklabs.projen

Class DockerComposeService

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.DockerComposeService

All Implemented Interfaces:

IDockerComposeServiceName, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.745Z")
@Stability(Experimental)
public class DockerComposeService
extends software.amazon.jsii.JsiiObject
implements IDockerComposeServiceName

(experimental) A docker-compose service.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockerComposeService.Builder	(experimental) A fluent builder for DockerComposeService.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.IDockerComposeServiceName

IDockerComposeServiceName.Jsii$Default, IDockerComposeServiceName.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	DockerComposeService(String serviceName, DockerComposeServiceDescription serviceDescription)
protected	DockerComposeService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DockerComposeService(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addDependsOn(IDockerComposeServiceName serviceName)	(experimental) Make the service depend on another service.
void	addEnvironment(String name, String value)	(experimental) Add an environment variable.
void	addLabel(String name, String value)	(experimental) Add a label.
void	addNetwork(IDockerComposeNetworkBinding network)	(experimental) Add a network to the service.
void	addPort(Number publishedPort, Number targetPort)	(experimental) Add a port mapping.
void	addPort(Number publishedPort, Number targetPort, DockerComposePortMappingOptions options)	(experimental) Add a port mapping.
void	addVolume(IDockerComposeVolumeBinding volume)	(experimental) Add a volume to the service.
List<String>	getCommand()	(experimental) Command to run in the container.
List<IDockerComposeServiceName>	getDependsOn()	(experimental) Other services that this service depends on.
List<String>	getEntrypoint()	(experimental) Entrypoint to run in the container.
Map<String,String>	getEnvironment()	(experimental) Environment variables.
String	getImage()	(experimental) Docker image.
DockerComposeBuild	getImageBuild()	(experimental) Docker image build instructions.
Map<String,String>	getLabels()	(experimental) Attached labels.
List<IDockerComposeNetworkBinding>	getNetworks()	(experimental) Networks mounted in the container.
String	getPlatform()	(experimental) Target platform.
List<DockerComposeServicePort>	getPorts()	(experimental) Published ports.
String	getServiceName()	(experimental) Name of the service.
List<IDockerComposeVolumeBinding>	getVolumes()	(experimental) Volumes mounted in the container.

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DockerComposeService

protected DockerComposeService(software.amazon.jsii.JsiiObjectRef objRef)

DockerComposeService

protected DockerComposeService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

DockerComposeService

@Stability(Experimental)
public DockerComposeService(@NotNull
                            String serviceName,
                            @NotNull
                            DockerComposeServiceDescription serviceDescription)

Parameters:

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

serviceDescription - This parameter is required.

Method Detail

addDependsOn

@Stability(Experimental)
public void addDependsOn(@NotNull
                         IDockerComposeServiceName serviceName)

(experimental) Make the service depend on another service.

Parameters:

serviceName - This parameter is required.

addEnvironment

@Stability(Experimental)
public void addEnvironment(@NotNull
                           String name,
                           @NotNull
                           String value)

(experimental) Add an environment variable.

Parameters:

name - environment variable name. This parameter is required.

value - value of the environment variable. This parameter is required.

addLabel

@Stability(Experimental)
public void addLabel(@NotNull
                     String name,
                     @NotNull
                     String value)

(experimental) Add a label.

Parameters:

name - environment variable name. This parameter is required.

value - value of the environment variable. This parameter is required.

addNetwork

@Stability(Experimental)
public void addNetwork(@NotNull
                       IDockerComposeNetworkBinding network)

(experimental) Add a network to the service.

Parameters:

network - This parameter is required.

addPort

@Stability(Experimental)
public void addPort(@NotNull
                    Number publishedPort,
                    @NotNull
                    Number targetPort,
                    @Nullable
                    DockerComposePortMappingOptions options)

(experimental) Add a port mapping.

Parameters:

publishedPort - Published port number. This parameter is required.

targetPort - Container's port number. This parameter is required.

options - Port mapping options.

addPort

@Stability(Experimental)
public void addPort(@NotNull
                    Number publishedPort,
                    @NotNull
                    Number targetPort)

(experimental) Add a port mapping.

Parameters:

publishedPort - Published port number. This parameter is required.

targetPort - Container's port number. This parameter is required.

addVolume

@Stability(Experimental)
public void addVolume(@NotNull
                      IDockerComposeVolumeBinding volume)

(experimental) Add a volume to the service.

Parameters:

volume - This parameter is required.

getDependsOn

@Stability(Experimental)
@NotNull
public List<IDockerComposeServiceName> getDependsOn()

(experimental) Other services that this service depends on.

getEnvironment

@Stability(Experimental)
@NotNull
public Map<String,String> getEnvironment()

(experimental) Environment variables.

getLabels

@Stability(Experimental)
@NotNull
public Map<String,String> getLabels()

(experimental) Attached labels.

getNetworks

@Stability(Experimental)
@NotNull
public List<IDockerComposeNetworkBinding> getNetworks()

(experimental) Networks mounted in the container.

getPorts

@Stability(Experimental)
@NotNull
public List<DockerComposeServicePort> getPorts()

(experimental) Published ports.

getServiceName

@Stability(Experimental)
@NotNull
public String getServiceName()

(experimental) Name of the service.

Specified by:

getServiceName in interface IDockerComposeServiceName

getVolumes

@Stability(Experimental)
@NotNull
public List<IDockerComposeVolumeBinding> getVolumes()

(experimental) Volumes mounted in the container.

getCommand

@Stability(Experimental)
@Nullable
public List<String> getCommand()

(experimental) Command to run in the container.

getEntrypoint

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

(experimental) Entrypoint to run in the container.

getImage

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

(experimental) Docker image.

getImageBuild

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

(experimental) Docker image build instructions.

getPlatform

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

(experimental) Target platform.