Package software.amazon.awscdk.services.batch

Interface Device

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
Device.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-15T10:24:55.394Z") @Stability(Stable) public interface Device extends software.amazon.jsii.JsiiSerializable
A container instance host device.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 Device device = Device.builder()
         .hostPath("hostPath")
         // the properties below are optional
         .containerPath("containerPath")
         .permissions(List.of(DevicePermission.READ))
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    Device.Builder
    A builder for Device
    static final class 
    Device.Jsii$Proxy
    An implementation for Device

  • Method Summary

    Modifier and Type
    Method
    Description
    static Device.Builder
    builder()
     
    default String
    getContainerPath()
    The path inside the container at which to expose the host device.
    String
    getHostPath()
    The path for the device on the host container instance.
    default List<DevicePermission>
    getPermissions()
    The explicit permissions to provide to the container for the device.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getHostPath

      @Stability(Stable) @NotNull String getHostPath()
      The path for the device on the host container instance.

    • getContainerPath

      @Stability(Stable) @Nullable default String getContainerPath()
      The path inside the container at which to expose the host device.

      Default: Same path as the host

    • getPermissions

      @Stability(Stable) @Nullable default List<DevicePermission> getPermissions()
      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.

      Default: Readonly

    • builder

      @Stability(Stable) static Device.Builder builder()
      Returns:
      a Device.Builder of Device