Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.DeviceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.DeviceProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(Stable)
public static interface CfnJobDefinition.DeviceProperty
extends software.amazon.jsii.JsiiSerializable

An object that represents a container instance host device.

This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

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.*;
 DeviceProperty deviceProperty = DeviceProperty.builder()
         .containerPath("containerPath")
         .hostPath("hostPath")
         .permissions(List.of("permissions"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnJobDefinition.DeviceProperty.Builder	A builder for CfnJobDefinition.DeviceProperty
static final class	CfnJobDefinition.DeviceProperty.Jsii$Proxy	An implementation for CfnJobDefinition.DeviceProperty

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.DeviceProperty.Builder	builder()
default String	getContainerPath()	The path inside the container that's used to expose the host device.
default String	getHostPath()	The path for the device on the host container instance.
default List<String>	getPermissions()	The explicit permissions to provide to the container for the device.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainerPath

@Stability(Stable)
@Nullable
default String getContainerPath()

The path inside the container that's used to expose the host device.

By default, the hostPath value is used.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-containerpath

getHostPath

@Stability(Stable)
@Nullable
default String getHostPath()

The path for the device on the host container instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-hostpath

getPermissions

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-device.html#cfn-batch-jobdefinition-device-permissions

builder

@Stability(Stable)
static CfnJobDefinition.DeviceProperty.Builder builder()

Returns:

a CfnJobDefinition.DeviceProperty.Builder of CfnJobDefinition.DeviceProperty