Class Volume
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Volume.Builder,
Volume>
A data volume that's used in a job's container properties.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Volume.Builder
builder()
final EFSVolumeConfiguration
This parameter is specified when you're using an Amazon Elastic File System file system for job storage.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Host
host()
The contents of thehost
parameter determine whether your data volume persists on the host container instance and where it's stored.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
-
host
The contents of the
host
parameter determine whether your data 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.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
- Returns:
- The contents of the
host
parameter determine whether your data 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.This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
-
name
The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the
sourceVolume
parameter of container definitionmountPoints
.- Returns:
- The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase
letters, numbers, hyphens (-), and underscores (_). This name is referenced in the
sourceVolume
parameter of container definitionmountPoints
.
-
efsVolumeConfiguration
This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a
platformVersion
of at least1.4.0
.- Returns:
- This parameter is specified when you're using an Amazon Elastic File System file system for job storage.
Jobs that are running on Fargate resources must specify a
platformVersion
of at least1.4.0
.
-
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
-