Skip to content
v2.277.0

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.

Example ​

ts
// 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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_batch as batch

mount_point_property = batch.CfnJobDefinition.MountPointProperty(
    container_path="containerPath",
    read_only=False,
    source_volume="sourceVolume"
)
java
// 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.*;

MountPointProperty mountPointProperty = MountPointProperty.builder()
        .containerPath("containerPath")
        .readOnly(false)
        .sourceVolume("sourceVolume")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Batch;

var mountPointProperty = new MountPointProperty {
    ContainerPath = "containerPath",
    ReadOnly = false,
    SourceVolume = "sourceVolume"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

mountPointProperty := &MountPointProperty{
	ContainerPath: jsii.String("containerPath"),
	ReadOnly: jsii.Boolean(false),
	SourceVolume: jsii.String("sourceVolume"),
}

Properties ​

containerPathoptionalstringcontainer_pathoptionalstrcontainerPathoptionalStringContainerPathoptionalstringContainerPathoptional*string#
The path on the container where the host volume is mounted.
readOnlyoptionalboolean | IResolvableread_onlyoptionaltyping.Union[bool, IResolvable]readOnlyoptionalBooleanReadOnlyoptionalboolReadOnlyoptionalinterface{}#
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 .

sourceVolumeoptionalstringsource_volumeoptionalstrsourceVolumeoptionalStringSourceVolumeoptionalstringSourceVolumeoptional*string#
The name of the volume to mount.