Skip to content
v2.275.0

HostVolumeOptions Struct ​

Options for configuring an ECS HostVolume.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_batch as batch } from 'aws-cdk-lib';
const hostVolumeOptions: batch.HostVolumeOptions = {
  containerPath: 'containerPath',
  name: 'name',

  // the properties below are optional
  hostPath: 'hostPath',
  readonly: false,
};

Properties ​

containerPathstringcontainer_pathstrcontainerPathStringContainerPathstringContainerPath*stringrequired#
the path on the container where this volume is mounted.
hostPathoptionalstringhost_pathoptionalstrhostPathoptionalStringHostPathoptionalstringHostPathoptional*string#
The path on the host machine this container will have access to.

Default: Docker will choose the host path. The data may not persist after the containers that use it stop running.

namestringnamestrnameStringNamestringName*stringrequired#
the name of this volume.
readonlyoptionalbooleanreadonlyoptionalboolreadonlyoptionalBooleanReadonlyoptionalboolReadonlyoptional*bool= false#
if set, the container will have readonly access to the volume.