DockerVolumeConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ecs.model.DockerVolumeConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DockerVolumeConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DockerVolumeConfiguration()

Constructors
Constructor and Description
`DockerVolumeConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DockerVolumeConfiguration`	`addDriverOptsEntry(String key, String value)` Add a single DriverOpts entry
`DockerVolumeConfiguration`	`addLabelsEntry(String key, String value)` Add a single Labels entry
`DockerVolumeConfiguration`	`clearDriverOptsEntries()` Removes all the entries added into DriverOpts.
`DockerVolumeConfiguration`	`clearLabelsEntries()` Removes all the entries added into Labels.
`DockerVolumeConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAutoprovision()` If this value is `true`, the Docker volume is created if it does not already exist.
`String`	`getDriver()` The Docker volume driver to use.
`Map<String,String>`	`getDriverOpts()` A map of Docker driver-specific options passed through.
`Map<String,String>`	`getLabels()` Custom metadata to add to your Docker volume.
`String`	`getScope()` The scope for the Docker volume that determines its lifecycle.
`int`	`hashCode()`
`Boolean`	`isAutoprovision()` If this value is `true`, the Docker volume is created if it does not already exist.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAutoprovision(Boolean autoprovision)` If this value is `true`, the Docker volume is created if it does not already exist.
`void`	`setDriver(String driver)` The Docker volume driver to use.
`void`	`setDriverOpts(Map<String,String> driverOpts)` A map of Docker driver-specific options passed through.
`void`	`setLabels(Map<String,String> labels)` Custom metadata to add to your Docker volume.
`void`	`setScope(String scope)` The scope for the Docker volume that determines its lifecycle.
`String`	`toString()` Returns a string representation of this object.
`DockerVolumeConfiguration`	`withAutoprovision(Boolean autoprovision)` If this value is `true`, the Docker volume is created if it does not already exist.
`DockerVolumeConfiguration`	`withDriver(String driver)` The Docker volume driver to use.
`DockerVolumeConfiguration`	`withDriverOpts(Map<String,String> driverOpts)` A map of Docker driver-specific options passed through.
`DockerVolumeConfiguration`	`withLabels(Map<String,String> labels)` Custom metadata to add to your Docker volume.
`DockerVolumeConfiguration`	`withScope(Scope scope)` The scope for the Docker volume that determines its lifecycle.
`DockerVolumeConfiguration`	`withScope(String scope)` The scope for the Docker volume that determines its lifecycle.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DockerVolumeConfiguration
```
public DockerVolumeConfiguration()
```
- Method Detail
  - setScope
```
public void setScope(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    Scope
  - getScope
```
public String getScope()
```
    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.
    
    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
  - withScope
```
public DockerVolumeConfiguration withScope(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Scope
  - withScope
```
public DockerVolumeConfiguration withScope(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Scope
  - setAutoprovision
```
public void setAutoprovision(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.
    
    Parameters:
    
    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.
  - getAutoprovision
```
public Boolean getAutoprovision()
```
    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.
  - withAutoprovision
```
public DockerVolumeConfiguration withAutoprovision(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutoprovision
```
public Boolean isAutoprovision()
```
    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.
  - setDriver
```
public void setDriver(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.
    
    Parameters:
    
    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.
  - getDriver
```
public String getDriver()
```
    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.
  - withDriver
```
public DockerVolumeConfiguration withDriver(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDriverOpts
```
public Map<String,String> getDriverOpts()
```
    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.
    
    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.
  - setDriverOpts
```
public void setDriverOpts(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.
    
    Parameters:
    
    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.
  - withDriverOpts
```
public DockerVolumeConfiguration withDriverOpts(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDriverOptsEntry
```
public DockerVolumeConfiguration addDriverOptsEntry(String key,
                                                    String value)
```
    Add a single DriverOpts entry
    
    See Also:
    
    withDriverOpts(java.util.Map<java.lang.String, java.lang.String>)
  - clearDriverOptsEntries
```
public DockerVolumeConfiguration clearDriverOptsEntries()
```
    Removes all the entries added into DriverOpts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLabels
```
public Map<String,String> getLabels()
```
    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.
    
    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.
  - setLabels
```
public void setLabels(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.
    
    Parameters:
    
    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.
  - withLabels
```
public DockerVolumeConfiguration withLabels(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addLabelsEntry
```
public DockerVolumeConfiguration addLabelsEntry(String key,
                                                String value)
```
    Add a single Labels entry
    
    See Also:
    
    withLabels(java.util.Map<java.lang.String, java.lang.String>)
  - clearLabelsEntries
```
public DockerVolumeConfiguration clearLabelsEntries()
```
    Removes all the entries added into Labels.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DockerVolumeConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DockerVolumeConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DockerVolumeConfiguration

Method Detail

setScope

getScope

withScope

withScope

setAutoprovision

getAutoprovision

withAutoprovision

isAutoprovision

setDriver

getDriver

withDriver

getDriverOpts

setDriverOpts

withDriverOpts

addDriverOptsEntry

clearDriverOptsEntries

getLabels

setLabels

withLabels

addLabelsEntry

clearLabelsEntries

toString

equals

hashCode

clone

marshall