aws-cdk-lib.DockerVolume

DockerVolume Struct

A Docker volume.

Source

core/lib/bundling.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
const dockerVolume: cdk.DockerVolume = {
  containerPath: 'containerPath',
  hostPath: 'hostPath',

  // the properties below are optional
  consistency: cdk.DockerVolumeConsistency.CONSISTENT,
};

Properties

consistencyDockerVolumeConsistencyconsistencyDockerVolumeConsistencyconsistencyDockerVolumeConsistencyConsistencyDockerVolumeConsistencyConsistencyDockerVolumeConsistency= DockerConsistency.DELEGATED#

Mount consistency.

Only applicable for macOS

containerPathstringcontainer_pathstrcontainerPathStringContainerPathstringContainerPath*stringrequired#

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

hostPathstringhost_pathstrhostPathStringHostPathstringHostPath*stringrequired#

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