Class Volume
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Volume.Builder,
Volume>
The data volume configuration for tasks launched using this task definition. Specifying a volume configuration in a
task definition is optional. The volume configuration may contain multiple volumes but only one volume configured at
launch is supported. Each volume defined in the volume configuration may only specify a name
and one of
either configuredAtLaunch
, dockerVolumeConfiguration
, efsVolumeConfiguration
,
fsxWindowsFileServerVolumeConfiguration
, or host
. If an empty volume configuration is
specified, by default Amazon ECS uses a host volume. For more information, see Using data volumes in
tasks.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Volume.Builder
builder()
final Boolean
Indicates whether the volume should be configured at launch time.This parameter is specified when you use Docker volumes.final EFSVolumeConfiguration
This parameter is specified when you use an Amazon Elastic File System file system for task storage.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final HostVolumeProperties
host()
This parameter is specified when you use bind mount host volumes.final String
name()
The name of the volume.static Class
<? extends Volume.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
When using a volume configured at launch, the
name
is required and must also be specified as the volume name in theServiceVolumeConfiguration
orTaskVolumeConfiguration
parameter when creating your service or standalone task.For all other types of volumes, this name is referenced in the
sourceVolume
parameter of themountPoints
object in the container definition.When a volume is using the
efsVolumeConfiguration
, the name is required.- Returns:
- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens
are allowed.
When using a volume configured at launch, the
name
is required and must also be specified as the volume name in theServiceVolumeConfiguration
orTaskVolumeConfiguration
parameter when creating your service or standalone task.For all other types of volumes, this name is referenced in the
sourceVolume
parameter of themountPoints
object in the container definition.When a volume is using the
efsVolumeConfiguration
, the name is required.
-
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 thehost
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 mountC:\my\path:C:\my\path
andD:\:D:\
, but notD:\my\path:C:\my\path
orD:\: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 thehost
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 mountC:\my\path:C:\my\path
andD:\:D:\
, but notD:\my\path:C:\my\path
orD:\:C:\my\path
.
-
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 thehost
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 thehost
parameter instead.Docker volumes aren't supported by tasks run on Fargate.
-
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
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.
-
configuredAtLaunch
Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.
To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurations
object when calling theCreateService
,UpdateService
,RunTask
orStartTask
APIs.- Returns:
- Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS
volumes for standalone tasks or tasks created as part of a service. Each task definition revision may
only have one volume configured at launch in the volume configuration.
To configure a volume at launch time, use this task definition revision and specify a
volumeConfigurations
object when calling theCreateService
,UpdateService
,RunTask
orStartTask
APIs.
-
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 interfaceToCopyableBuilder<Volume.Builder,
Volume> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-