Package software.amazon.awssdk.services.ecs.model

Class Volume

java.lang.Object
software.amazon.awssdk.services.ecs.model.Volume
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Volume.Builder,Volume>
@Generated("software.amazon.awssdk:codegen") public final class Volume extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Volume.Builder,Volume>

A data volume that's used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

      This is required wwhen you use an Amazon EFS volume.

      Returns:
      The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

      This is required wwhen you use an Amazon EFS volume.

    • host

      public final HostVolumeProperties host()

      This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

      Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

      Returns:
      This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

      Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

    • dockerVolumeConfiguration

      public final DockerVolumeConfiguration dockerVolumeConfiguration()

      This parameter is specified when you use Docker volumes.

      Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

      Docker volumes aren't supported by tasks run on Fargate.

      Returns:
      This parameter is specified when you use Docker volumes.

      Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

      Docker volumes aren't supported by tasks run on Fargate.

    • efsVolumeConfiguration

      public final EFSVolumeConfiguration efsVolumeConfiguration()

      This parameter is specified when you use an Amazon Elastic File System file system for task storage.

      Returns:
      This parameter is specified when you use an Amazon Elastic File System file system for task storage.

    • fsxWindowsFileServerVolumeConfiguration

      public final FSxWindowsFileServerVolumeConfiguration fsxWindowsFileServerVolumeConfiguration()

      This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

      Returns:
      This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

    • toBuilder

      public Volume.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Volume.Builder,Volume>
      Returns:
      a builder for type T

    • builder

      public static Volume.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Volume.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.