Package io.github.cdklabs.projen

Interface DockerComposeVolumeConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerComposeVolumeConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.749Z")
@Stability(Experimental)
public interface DockerComposeVolumeConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Volume configuration.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DockerComposeVolumeConfig.Builder	builder()
default String	getDriver()	(experimental) Driver to use for the volume.
default Map<String,String>	getDriverOpts()	(experimental) Options to provide to the driver.
default Boolean	getExternal()	(experimental) Set to true to indicate that the volume is externally created.
default String	getName()	(experimental) Name of the volume for when the volume name isn't going to work in YAML.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDriver

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

(experimental) Driver to use for the volume.

Default: - value is not provided

getDriverOpts

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

(experimental) Options to provide to the driver.

getExternal

@Stability(Experimental)
@Nullable
default Boolean getExternal()

(experimental) Set to true to indicate that the volume is externally created.

Default: - unset, indicating that docker-compose creates the volume

getName

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

(experimental) Name of the volume for when the volume name isn't going to work in YAML.

Default: - unset, indicating that docker-compose creates volumes as usual

builder

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

Returns:

a DockerComposeVolumeConfig.Builder of DockerComposeVolumeConfig