@aws-cdk_aws-batch-alpha.HostVolumeOptions

interface HostVolumeOptions ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.HostVolumeOptions
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#HostVolumeOptions
Javasoftware.amazon.awscdk.services.batch.alpha.HostVolumeOptions
Pythonaws_cdk.aws_batch_alpha.HostVolumeOptions
TypeScript (source)@aws-cdk/aws-batch-alpha ยป 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 * as batch_alpha from '@aws-cdk/aws-batch-alpha';
const hostVolumeOptions: batch_alpha.HostVolumeOptions = {
  containerPath: 'containerPath',
  name: 'name',

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

Properties

NameTypeDescription
containerPath๐Ÿ”นstringthe path on the container where this volume is mounted.
name๐Ÿ”นstringthe name of this volume.
hostPath?๐Ÿ”นstringThe path on the host machine this container will have access to.
readonly?๐Ÿ”นbooleanif 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.