Package software.amazon.awscdk.services.batch

Class EfsVolume

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.batch.EcsVolume
software.amazon.awscdk.services.batch.EfsVolume
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-09-11T18:01:12.002Z") @Stability(Stable) public class EfsVolume extends EcsVolume
A Volume that uses an AWS Elastic File System (EFS);

this volume can grow and shrink as needed

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.*;
 import software.amazon.awscdk.services.efs.*;
 FileSystem fileSystem;
 EfsVolume efsVolume = EfsVolume.Builder.create()
         .containerPath("containerPath")
         .fileSystem(fileSystem)
         .name("name")
         // the properties below are optional
         .accessPointId("accessPointId")
         .enableTransitEncryption(false)
         .readonly(false)
         .rootDirectory("rootDirectory")
         .transitEncryptionPort(123)
         .useJobRole(false)
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    EfsVolume.Builder
    A fluent builder for EfsVolume.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    EfsVolume(EfsVolumeOptions options)
     
    protected
    EfsVolume(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    EfsVolume(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAccessPointId()
    The Amazon EFS access point ID to use.
    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.
    String
    getRootDirectory()
    The directory within the Amazon EFS file system to mount as the root directory inside the host.
    Number
    getTransitEncryptionPort()
    The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
    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.
    static Boolean
    isEfsVolume(Object x)
    Returns true if x is an EfsVolume, false otherwise.

    Methods inherited from class software.amazon.awscdk.services.batch.EcsVolume

    efs, getContainerPath, getName, getReadonly, host

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • EfsVolume

      protected EfsVolume(software.amazon.jsii.JsiiObjectRef objRef)

    • EfsVolume

      protected EfsVolume(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • EfsVolume

      @Stability(Stable) public EfsVolume(@NotNull EfsVolumeOptions options)
      Parameters:
      options - This parameter is required.

  • Method Details

    • isEfsVolume

      @Stability(Stable) @NotNull public static Boolean isEfsVolume(@NotNull Object x)
      Returns true if x is an EfsVolume, false otherwise.

      Parameters:
      x - This parameter is required.

    • getFileSystem

      @Stability(Stable) @NotNull public IFileSystem getFileSystem()
      The EFS File System that supports this volume.

    • getAccessPointId

      @Stability(Stable) @Nullable public 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:

    • getEnableTransitEncryption

      @Stability(Stable) @Nullable public Boolean getEnableTransitEncryption()
      Enables encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.

      Default: false

      See Also:

    • getRootDirectory

      @Stability(Stable) @Nullable public 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 public 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:

    • getUseJobRole

      @Stability(Stable) @Nullable public 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: