Skip to content
v2.274.0

Device Struct ​

A container instance host device.

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 device: batch.Device = {
  hostPath: 'hostPath',

  // the properties below are optional
  containerPath: 'containerPath',
  permissions: [batch.DevicePermission.READ],
};

Properties ​

containerPathoptionalstringcontainer_pathoptionalstrcontainerPathoptionalStringContainerPathoptionalstringContainerPathoptional*string#
The path inside the container at which to expose the host device.

Default: Same path as the host

hostPathstringhost_pathstrhostPathStringHostPathstringHostPath*stringrequired#
The path for the device on the host container instance.
permissionsoptionalDevicePermission[]permissionsoptionaltyping.List[DevicePermission]permissionsoptionalList<DevicePermission>PermissionsoptionalDevicePermission[]Permissionsoptional*[]DevicePermission= Readonly#
The explicit permissions to provide to the container for the device.

By default, the container has permissions for read, write, and mknod for the device.