interface HostPathVolumeOptions

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

Options for a kubernetes HostPath volume.

Example

declare const jobDefn: batch.EksJobDefinition;
jobDefn.container.addVolume(batch.EksVolume.emptyDir({
  name: 'emptyDir',
  mountPath: '/Volumes/emptyDir',
}));
jobDefn.container.addVolume(batch.EksVolume.hostPath({
  name: 'hostPath',
  hostPath: '/sys',
  mountPath: '/Volumes/hostPath',
}));
jobDefn.container.addVolume(batch.EksVolume.secret({
  name: 'secret',
  optional: true,
  mountPath: '/Volumes/secret',
  secretName: 'mySecret',
}));

Properties

Name	Type	Description
hostPath	`string`	The path of the file or directory on the host to mount into containers on the pod.
name	`string`	The name of this volume.
mountPath?	`string`	The path on the container where the volume is mounted.
readonly?	`boolean`	If specified, the container has readonly access to the volume.

hostPath

Type: string

The path of the file or directory on the host to mount into containers on the pod.

Note: HothPath Volumes present many security risks, and should be avoided when possible.

name

Type: string

The name of this volume.

The name must be a valid DNS subdomain name.

mountPath?

Type: string (optional, default: the volume is not mounted)

The path on the container where the volume is mounted.

readonly?

Type: boolean (optional, default: false)

If specified, the container has readonly access to the volume.

Otherwise, the container has read/write access.