Class DockerVolumeConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DockerVolumeConfiguration.Builder,
DockerVolumeConfiguration>
This parameter is specified when you're using Docker volumes. Docker volumes are only supported when you're using the
EC2 launch type. Windows containers only support the use of the local
driver. To use bind mounts,
specify a host
instead.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
If this value istrue
, the Docker volume is created if it doesn't already exist.builder()
final String
driver()
The Docker volume driver to use.A map of Docker driver-specific options passed through.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 boolean
For responses, this returns true if the service returned a value for the DriverOpts property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Labels property.labels()
Custom metadata to add to your Docker volume.final Scope
scope()
The scope for the Docker volume that determines its lifecycle.final String
The scope for the Docker volume that determines its lifecycle.static Class
<? extends DockerVolumeConfiguration.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
-
scope
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops.If the service returns an enum value that is not available in the current SDK version,
scope
will returnScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscopeAsString()
.- Returns:
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops. - See Also:
-
scopeAsString
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops.If the service returns an enum value that is not available in the current SDK version,
scope
will returnScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromscopeAsString()
.- Returns:
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops. - See Also:
-
autoprovision
If this value is
true
, the Docker volume is created if it doesn't already exist.This field is only used if the
scope
isshared
.- Returns:
- If this value is
true
, the Docker volume is created if it doesn't already exist.This field is only used if the
scope
isshared
.
-
driver
The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriver
in the Create a volume section of the Docker Remote API and thexxdriver
option to docker volume create.- Returns:
- The Docker volume driver to use. The driver value must match the driver name provided by Docker because
it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriver
in the Create a volume section of the Docker Remote API and thexxdriver
option to docker volume create.
-
hasDriverOpts
public final boolean hasDriverOpts()For responses, this returns true if the service returned a value for the DriverOpts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
driverOpts
A map of Docker driver-specific options passed through. This parameter maps to
DriverOpts
in the Create a volume section of the Docker Remote API and thexxopt
option to docker volume create.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDriverOpts()
method.- Returns:
- A map of Docker driver-specific options passed through. This parameter maps to
DriverOpts
in the Create a volume section of the Docker Remote API and thexxopt
option to docker volume create.
-
hasLabels
public final boolean hasLabels()For responses, this returns true if the service returned a value for the Labels property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
labels
Custom metadata to add to your Docker volume. This parameter maps to
Labels
in the Create a volume section of the Docker Remote API and thexxlabel
option to docker volume create.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLabels()
method.- Returns:
- Custom metadata to add to your Docker volume. This parameter maps to
Labels
in the Create a volume section of the Docker Remote API and thexxlabel
option to docker volume create.
-
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<DockerVolumeConfiguration.Builder,
DockerVolumeConfiguration> - 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
-