Package software.amazon.awscdk.services.batch

Interface EfsVolumeOptions

All Superinterfaces:

EcsVolumeOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EfsVolumeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:05.914Z")
@Stability(Stable)
public interface EfsVolumeOptions
extends software.amazon.jsii.JsiiSerializable, EcsVolumeOptions

Options for configuring an EfsVolume.

Example:

 IFileSystem myFileSystem;
 Role myJobRole;
 myFileSystem.grantRead(myJobRole);
 EcsJobDefinition jobDefn = EcsJobDefinition.Builder.create(this, "JobDefn")
         .container(EcsEc2ContainerDefinition.Builder.create(this, "containerDefn")
                 .image(ContainerImage.fromRegistry("public.ecr.aws/amazonlinux/amazonlinux:latest"))
                 .memory(Size.mebibytes(2048))
                 .cpu(256)
                 .volumes(List.of(EcsVolume.efs(EfsVolumeOptions.builder()
                         .name("myVolume")
                         .fileSystem(myFileSystem)
                         .containerPath("/Volumes/myVolume")
                         .useJobRole(true)
                         .build())))
                 .jobRole(myJobRole)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static EfsVolumeOptions.Builder	builder()
default String	getAccessPointId()	The Amazon EFS access point ID to use.
default Boolean	getEnableTransitEncryption()	Enables encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
IFileSystem	getFileSystem()	The EFS File System that supports this volume.
default String	getRootDirectory()	The directory within the Amazon EFS file system to mount as the root directory inside the host.
default Number	getTransitEncryptionPort()	The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
default Boolean	getUseJobRole()	Whether or not to use the AWS Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.

Methods inherited from interface software.amazon.awscdk.services.batch.EcsVolumeOptions

getContainerPath, getName, getReadonly

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFileSystem

@Stability(Stable)
@NotNull
IFileSystem getFileSystem()

The EFS File System that supports this volume.

getAccessPointId

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

The Amazon EFS access point ID to use.

If an access point is specified, rootDirectory must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, enableTransitEncryption must be true.

Default: - no accessPointId

See Also:

• https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html

getEnableTransitEncryption

@Stability(Stable)
@Nullable
default Boolean getEnableTransitEncryption()

Enables encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.

Default: false

See Also:

• https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html

getRootDirectory

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

The directory within the Amazon EFS file system to mount as the root directory inside the host.

If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

Default: - root of the EFS File System

getTransitEncryptionPort

@Stability(Stable)
@Nullable
default Number getTransitEncryptionPort()

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.

The value must be between 0 and 65,535.

Default: - chosen by the EFS Mount Helper

See Also:

• https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html

getUseJobRole

@Stability(Stable)
@Nullable
default Boolean getUseJobRole()

Whether or not to use the AWS Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.

If specified, enableTransitEncryption must be true.

Default: false

See Also:

• https://docs.aws.amazon.com/batch/latest/userguide/efs-volumes.html#efs-volume-accesspoints

builder

@Stability(Stable)
static EfsVolumeOptions.Builder builder()

Returns:

a EfsVolumeOptions.Builder of EfsVolumeOptions