# HostVolumeOptions

Options for configuring an ECS HostVolume.

Extends: HostVolumeOptions
Extends: EcsVolumeOptions
Used as props by: HostVolume

- Source: [`aws-batch/lib/ecs-container-definition.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-batch/lib/ecs-container-definition.ts#L337)
- Type last changed: v2.96.0 · 13 Sep 2023

## 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

- `containerPath`: string (required) — the path on the container where this volume is mounted.

- `hostPath`: 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.

- `name`: string (required) — the name of this volume.

- `readonly`: boolean = false — if set, the container will have readonly access to the volume.