software.amazon.awscdk

Interface DockerVolume

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DockerVolume.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:35.891Z")
 @Stability(value=Stable)
public interface DockerVolume
extends software.amazon.jsii.JsiiSerializable

A Docker volume.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 DockerVolume dockerVolume = DockerVolume.builder()
         .containerPath("containerPath")
         .hostPath("hostPath")
         // the properties below are optional
         .consistency(DockerVolumeConsistency.CONSISTENT)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DockerVolume.Builder	builder()
default DockerVolumeConsistency	getConsistency() Mount consistency.
String	getContainerPath() The path where the file or directory is mounted in the container.
String	getHostPath() The path to the file or directory on the host machine.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContainerPath

@Stability(value=Stable)
 @NotNull
String getContainerPath()

The path where the file or directory is mounted in the container.

getHostPath

@Stability(value=Stable)
 @NotNull
String getHostPath()

The path to the file or directory on the host machine.

getConsistency

@Stability(value=Stable)
 @Nullable
default DockerVolumeConsistency getConsistency()

Mount consistency.

Only applicable for macOS

Default: DockerConsistency.DELEGATED

See Also:

https://docs.docker.com/storage/bind-mounts/#configure-mount-consistency-for-macos

builder

@Stability(value=Stable)
static DockerVolume.Builder builder()

Returns:

a DockerVolume.Builder of DockerVolume