Package io.github.cdklabs.projen

Interface DockerComposeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerComposeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.100.0 (build 6a776be)",
           date="2024-06-21T23:10:11.660Z")
@Stability(Experimental)
public interface DockerComposeProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Props for DockerCompose.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DockerComposeProps.Builder	builder()
default String	getNameSuffix()	(experimental) A name to add to the docker-compose.yml filename.
default String	getSchemaVersion()	Deprecated. - The top level `version` field is obsolete per the Compose Specification.
default Map<String,DockerComposeServiceDescription>	getServices()	(experimental) Service descriptions.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNameSuffix

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

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

Default: - no name is added

Example:

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

getSchemaVersion

@Stability(Deprecated)
@Deprecated
@Nullable
default String getSchemaVersion()

Deprecated.

- The top level `version` field is obsolete per the Compose Specification. {@link https://github.com/compose-spec/compose-spec/blob/master/spec.md#version-and-name-top-level-elements Compose Specification}

(deprecated) Docker Compose schema version do be used.

Default: - no version is provided

getServices

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

(experimental) Service descriptions.

builder

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

Returns:

a DockerComposeProps.Builder of DockerComposeProps