io.github.cdklabs.projen

Interface DockerComposeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerComposeProps.Jsii$Proxy

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

(experimental) Props for DockerCompose.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DockerComposeProps.Builder	builder()
default String	getNameSuffix() (experimental) A name to add to the docker-compose.yml filename.
default String	getSchemaVersion() (experimental) Docker Compose schema version do be used.
default Map<String,DockerComposeServiceDescription>	getServices() (experimental) Service descriptions.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNameSuffix

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

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

Default: - no name is added

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 'myname' yields 'docker-compose.myname.yml'
 

getSchemaVersion

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

(experimental) Docker Compose schema version do be used.

Default: 3.3

getServices

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

(experimental) Service descriptions.

builder

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

Returns:

a DockerComposeProps.Builder of DockerComposeProps