interface HostVolumeOptions

Language	Type name
.NET	Amazon.CDK.AWS.Batch.HostVolumeOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#HostVolumeOptions
Java	software.amazon.awscdk.services.batch.HostVolumeOptions
Python	aws_cdk.aws_batch.HostVolumeOptions
TypeScript (source)	aws-cdk-lib » aws_batch » HostVolumeOptions

Options for configuring an ECS HostVolume.

Example

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

Name	Type	Description
containerPath	string	the path on the container where this volume is mounted.
name	string	the name of this volume.
hostPath?	string	The path on the host machine this container will have access to.
readonly?	boolean	if set, the container will have readonly access to the volume.

---

containerPath

Type: string

the path on the container where this volume is mounted.

---

name

Type: string

the name of this volume.

---

hostPath?

Type: string (optional, default: Docker will choose the host path. The data may not persist after the containers that use it stop running.)

The path on the host machine this container will have access to.

---

readonly?

Type: boolean (optional, default: false)

if set, the container will have readonly access to the volume.