Package io.github.cdklabs.projen

Class DockerCompose.Builder

java.lang.Object

io.github.cdklabs.projen.DockerCompose.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DockerCompose>

Enclosing class:

DockerCompose

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

(experimental) A fluent builder for DockerCompose.

Method Summary

Modifier and Type	Method	Description
DockerCompose	build()
static DockerCompose.Builder	create(Project project)
DockerCompose.Builder	nameSuffix(String nameSuffix)	(experimental) A name to add to the docker-compose.yml filename.
DockerCompose.Builder	schemaVersion(String schemaVersion)	(experimental) Docker Compose schema version do be used.
DockerCompose.Builder	services(Map<String,? extends DockerComposeServiceDescription> services)	(experimental) Service descriptions.

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 DockerCompose.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of DockerCompose.Builder.

nameSuffix

@Stability(Experimental)
public DockerCompose.Builder nameSuffix(String nameSuffix)

(experimental) A name to add to the docker-compose.yml filename.

Default: - no name is added

Example:

 'myname' yields 'docker-compose.myname.yml'
 

Parameters:

nameSuffix - A name to add to the docker-compose.yml filename. This parameter is required.

Returns:

this

schemaVersion

@Stability(Experimental)
public DockerCompose.Builder schemaVersion(String schemaVersion)

(experimental) Docker Compose schema version do be used.

Default: 3.3

Parameters:

schemaVersion - Docker Compose schema version do be used. This parameter is required.

Returns:

this

services

@Stability(Experimental)
public DockerCompose.Builder services(Map<String,? extends DockerComposeServiceDescription> services)

(experimental) Service descriptions.

Parameters:

services - Service descriptions. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public DockerCompose build()

Specified by:

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

Returns:

a newly built instance of DockerCompose.