Package software.amazon.awscdk.services.batch

Class EcsVolume

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.batch.EcsVolume
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
Direct Known Subclasses:
EfsVolume, HostVolume
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:33.345Z") @Stability(Stable) public abstract class EcsVolume extends software.amazon.jsii.JsiiObject
Represents a Volume that can be mounted to a container that uses ECS.

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/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static EfsVolume
    efs(EfsVolumeOptions options)
    Creates a Volume that uses an AWS Elastic File System (EFS);
    String
    getContainerPath()
    The path on the container that this volume will be mounted to.
    String
    getName()
    The name of this volume.
    Boolean
    getReadonly()
    Whether or not the container has readonly access to this volume.
    static HostVolume
    host(HostVolumeOptions options)
    Creates a Host volume.

    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

    • EcsVolume

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

    • EcsVolume

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

    • EcsVolume

      @Stability(Stable) protected EcsVolume(@NotNull EcsVolumeOptions options)
      Parameters:
      options - This parameter is required.

  • Method Details

    • efs

      @Stability(Stable) @NotNull public static EfsVolume efs(@NotNull EfsVolumeOptions options)
      Creates a Volume that uses an AWS Elastic File System (EFS);

      this volume can grow and shrink as needed

      Parameters:
      options - This parameter is required.
      See Also:

    • host

      @Stability(Stable) @NotNull public static HostVolume host(@NotNull HostVolumeOptions options)
      Creates a Host volume.

      This volume will persist on the host at the specified hostPath. If the hostPath is not specified, Docker will choose the host path. In this case, the data may not persist after the containers that use it stop running.

      Parameters:
      options - This parameter is required.

    • getContainerPath

      @Stability(Stable) @NotNull public String getContainerPath()
      The path on the container that this volume will be mounted to.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of this volume.

    • getReadonly

      @Stability(Stable) @Nullable public Boolean getReadonly()
      Whether or not the container has readonly access to this volume.

      Default: false