aws-cdk-lib.aws_batch.CfnJobDefinition.MountPointsProperty

interface MountPointsProperty

LanguageType name
.NETAmazon.CDK.AWS.Batch.CfnJobDefinition.MountPointsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbatch#CfnJobDefinition_MountPointsProperty
Javasoftware.amazon.awscdk.services.batch.CfnJobDefinition.MountPointsProperty
Pythonaws_cdk.aws_batch.CfnJobDefinition.MountPointsProperty
TypeScript aws-cdk-lib » aws_batch » CfnJobDefinition » MountPointsProperty

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.

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

Properties

NameTypeDescription
containerPath?stringThe path on the container where the host volume is mounted.
readOnly?boolean | IResolvableIf this value is true , the container has read-only access to the volume.
sourceVolume?stringThe name of the volume to mount.

containerPath?

Type: string (optional)

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


readOnly?

Type: boolean | IResolvable (optional)

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 .


sourceVolume?

Type: string (optional)

The name of the volume to mount.