Package io.github.cdklabs.projen

Interface DockerComposeNetworkConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerComposeNetworkConfig.Jsii$Proxy

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

(experimental) Network configuration.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DockerComposeNetworkConfig.Builder	builder()
default Boolean	getAttachable()	(experimental) Set to true to indicate that standalone containers can attach to this network, in addition to services.
default Boolean	getBridge()	(experimental) Set to true to indicate that the network is a bridge network.
default String	getDriver()	(experimental) Driver to use for the network.
default com.fasterxml.jackson.databind.node.ObjectNode	getDriverOpts()	(experimental) Options for the configured driver.
default Boolean	getExternal()	(experimental) Set to true to indicate that the network is externally created.
default Boolean	getInternal()	(experimental) Set to true to indicate that you want to create an externally isolated overlay network.
default DockerComposeNetworkIpamConfig	getIpam()	(experimental) Specify custom IPAM config.
default List<String>	getLabels()	(experimental) Attach labels to the network.
default String	getName()	(experimental) Name of the network for when the network name isn't going to work in YAML.
default Boolean	getOverlay()	(experimental) Set to true to indicate that the network is an overlay network.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttachable

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

(experimental) Set to true to indicate that standalone containers can attach to this network, in addition to services.

Default: - unset

getBridge

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

(experimental) Set to true to indicate that the network is a bridge network.

Default: - unset

getDriver

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

(experimental) Driver to use for the network.

Default: - value is not provided

getDriverOpts

@Stability(Experimental)
@Nullable
default com.fasterxml.jackson.databind.node.ObjectNode getDriverOpts()

(experimental) Options for the configured driver.

Those options are driver-dependent - consult the driver’s documentation for more information

Default: - value is not provided

getExternal

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

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

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

getInternal

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

(experimental) Set to true to indicate that you want to create an externally isolated overlay network.

Default: - unset

getIpam

@Stability(Experimental)
@Nullable
default DockerComposeNetworkIpamConfig getIpam()

(experimental) Specify custom IPAM config.

Default: - unset

getLabels

@Stability(Experimental)
@Nullable
default List<String> getLabels()

(experimental) Attach labels to the network.

Default: - unset

getName

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

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

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

getOverlay

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

(experimental) Set to true to indicate that the network is an overlay network.

Default: - unset

builder

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

Returns:

a DockerComposeNetworkConfig.Builder of DockerComposeNetworkConfig