software.amazon.awscdk.services.batch

Interface CfnJobDefinition.MountPointsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.MountPointsProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(value=Stable)
public static interface CfnJobDefinition.MountPointsProperty
extends software.amazon.jsii.JsiiSerializable

Details on a Docker volume mount point that's used in a job's container properties.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

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.*;
 MountPointsProperty mountPointsProperty = MountPointsProperty.builder()
         .containerPath("containerPath")
         .readOnly(false)
         .sourceVolume("sourceVolume")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnJobDefinition.MountPointsProperty.Builder	builder()
default String	getContainerPath() The path on the container where the host volume is mounted.
default Object	getReadOnly() If this value is `true` , the container has read-only access to the volume.
default String	getSourceVolume() The name of the volume to mount.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContainerPath

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

The path on the container where the host volume is mounted.

getReadOnly

@Stability(value=Stable)
 @Nullable
default Object getReadOnly()

If this value is `true` , the container has read-only access to the volume.

Otherwise, the container can write to the volume. The default value is false .

getSourceVolume

@Stability(value=Stable)
 @Nullable
default String getSourceVolume()

The name of the volume to mount.

builder

@Stability(value=Stable)
static CfnJobDefinition.MountPointsProperty.Builder builder()

Returns:

a CfnJobDefinition.MountPointsProperty.Builder of CfnJobDefinition.MountPointsProperty