io.github.cdklabs.projen

Class DockerCompose

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.DockerCompose

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.388Z")
 @Stability(value=Experimental)
public class DockerCompose
extends Component

(experimental) Create a docker-compose YAML file.

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DockerCompose(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DockerCompose(software.amazon.jsii.JsiiObjectRef objRef)
	DockerCompose(Project project)
	DockerCompose(Project project, DockerComposeProps props)

Method Summary

Modifier and Type	Method and Description
DockerComposeService	addService(String serviceName, DockerComposeServiceDescription description) (experimental) Add a service to the docker-compose file.
static IDockerComposeVolumeBinding	bindVolume(String sourcePath, String targetPath) (experimental) Create a bind volume that binds a host path to the target path in the container.
static IDockerComposeVolumeBinding	namedVolume(String volumeName, String targetPath) (experimental) Create a named volume and mount it to the target path.
static IDockerComposeVolumeBinding	namedVolume(String volumeName, String targetPath, DockerComposeVolumeConfig options) (experimental) Create a named volume and mount it to the target path.
static DockerComposeServicePort	portMapping(Number publishedPort, Number targetPort) (experimental) Create a port mapping.
static DockerComposeServicePort	portMapping(Number publishedPort, Number targetPort, DockerComposePortMappingOptions options) (experimental) Create a port mapping.
static IDockerComposeServiceName	serviceName(String serviceName) (experimental) Depends on a service name.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, postSynthesize, preSynthesize, synthesize

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

DockerCompose

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

DockerCompose

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

DockerCompose

@Stability(value=Experimental)
public DockerCompose(@NotNull
                                                    Project project,
                                                    @Nullable
                                                    DockerComposeProps props)

Parameters:

project - This parameter is required.

props -

DockerCompose

@Stability(value=Experimental)
public DockerCompose(@NotNull
                                                    Project project)

Parameters:

project - This parameter is required.

Method Detail

bindVolume

@Stability(value=Experimental)
 @NotNull
public static IDockerComposeVolumeBinding bindVolume(@NotNull
                                                                                              String sourcePath,
                                                                                              @NotNull
                                                                                              String targetPath)

(experimental) Create a bind volume that binds a host path to the target path in the container.

Parameters:

sourcePath - Host path name. This parameter is required.

targetPath - Target path name. This parameter is required.

namedVolume

@Stability(value=Experimental)
 @NotNull
public static IDockerComposeVolumeBinding namedVolume(@NotNull
                                                                                               String volumeName,
                                                                                               @NotNull
                                                                                               String targetPath,
                                                                                               @Nullable
                                                                                               DockerComposeVolumeConfig options)

(experimental) Create a named volume and mount it to the target path.

If you use this named volume in several services, the volume will be shared. In this case, the volume configuration of the first-provided options are used.

Parameters:

volumeName - Name of the volume. This parameter is required.

targetPath - Target path. This parameter is required.

options - volume configuration (default: docker compose defaults).

namedVolume

@Stability(value=Experimental)
 @NotNull
public static IDockerComposeVolumeBinding namedVolume(@NotNull
                                                                                               String volumeName,
                                                                                               @NotNull
                                                                                               String targetPath)

(experimental) Create a named volume and mount it to the target path.

If you use this named volume in several services, the volume will be shared. In this case, the volume configuration of the first-provided options are used.

Parameters:

volumeName - Name of the volume. This parameter is required.

targetPath - Target path. This parameter is required.

portMapping

@Stability(value=Experimental)
 @NotNull
public static DockerComposeServicePort portMapping(@NotNull
                                                                                            Number publishedPort,
                                                                                            @NotNull
                                                                                            Number targetPort,
                                                                                            @Nullable
                                                                                            DockerComposePortMappingOptions options)

(experimental) Create 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.

portMapping

@Stability(value=Experimental)
 @NotNull
public static DockerComposeServicePort portMapping(@NotNull
                                                                                            Number publishedPort,
                                                                                            @NotNull
                                                                                            Number targetPort)

(experimental) Create a port mapping.

Parameters:

publishedPort - Published port number. This parameter is required.

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

serviceName

@Stability(value=Experimental)
 @NotNull
public static IDockerComposeServiceName serviceName(@NotNull
                                                                                             String serviceName)

(experimental) Depends on a service name.

Parameters:

serviceName - This parameter is required.

addService

@Stability(value=Experimental)
 @NotNull
public DockerComposeService addService(@NotNull
                                                                                String serviceName,
                                                                                @NotNull
                                                                                DockerComposeServiceDescription description)

(experimental) Add a service to the docker-compose file.

Parameters:

serviceName - name of the service. This parameter is required.

description - a service description. This parameter is required.