aws-cdk-lib.aws_batch.CfnJobDefinition.MountPointProperty

MountPointProperty Struct

Details for 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.

Source

Generated code

Type last changed

v2.174.0 · 4 Jan 2025

Example

// 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 mountPointProperty: batch.CfnJobDefinition.MountPointProperty = {
  containerPath: 'containerPath',
  readOnly: false,
  sourceVolume: 'sourceVolume',
};

Properties

containerPathstringcontainer_pathstrcontainerPathStringContainerPathstringContainerPath*string#

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

readOnlyboolean | IResolvableread_onlytyping.Union[bool, IResolvable]readOnlyBooleanReadOnlyboolReadOnlyinterface{}#

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 .

sourceVolumestringsource_volumestrsourceVolumeStringSourceVolumestringSourceVolume*string#

The name of the volume to mount.