software.amazon.awssdk.services.ecs.model

Class DockerVolumeConfiguration

java.lang.Object

software.amazon.awssdk.services.ecs.model.DockerVolumeConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DockerVolumeConfiguration.Builder,DockerVolumeConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class DockerVolumeConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DockerVolumeConfiguration.Builder,DockerVolumeConfiguration>

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DockerVolumeConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	autoprovision() If this value is true, the Docker volume is created if it does not already exist.
static DockerVolumeConfiguration.Builder	builder()
String	driver() The Docker volume driver to use.
Map<String,String>	driverOpts() A map of Docker driver-specific options passed through.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDriverOpts() For responses, this returns true if the service returned a value for the DriverOpts property.
int	hashCode()
boolean	hasLabels() For responses, this returns true if the service returned a value for the Labels property.
Map<String,String>	labels() Custom metadata to add to your Docker volume.
Scope	scope() The scope for the Docker volume that determines its lifecycle.
String	scopeAsString() The scope for the Docker volume that determines its lifecycle.
List<SdkField<?>>	sdkFields()
static Class<? extends DockerVolumeConfiguration.Builder>	serializableBuilderClass()
DockerVolumeConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

scope

public final Scope 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 as shared persist after the task stops.

If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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 as shared persist after the task stops.

See Also:

Scope

scopeAsString

public final String 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 as shared persist after the task stops.

If the service returns an enum value that is not available in the current SDK version, scope will return Scope.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scopeAsString().

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 as shared persist after the task stops.

See Also:

Scope

autoprovision

public final Boolean autoprovision()

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

Returns:

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

driver

public final String 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 to Driver in the Create a volume section of the Docker Remote API and the xxdriver 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 to Driver in the Create a volume section of the Docker Remote API and the xxdriver 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 the isEmpty() 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

public final Map<String,String> 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 the xxopt 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 the xxopt 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 the isEmpty() 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

public final Map<String,String> 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 the xxlabel 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 the xxlabel option to docker volume create.

toBuilder

public DockerVolumeConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DockerVolumeConfiguration.Builder,DockerVolumeConfiguration>

builder

public static DockerVolumeConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends DockerVolumeConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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