@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DockerVolumeConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
DockerVolumeConfiguration() |
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 doesn't 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 doesn't 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 doesn't 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 doesn't 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.
|
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.
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.Scope
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.
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.Scope
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.
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.Scope
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.
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.Scope
public void setAutoprovision(Boolean 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
is shared
.
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
is shared
.
public Boolean getAutoprovision()
If this value is true
, the Docker volume is created if it doesn't already exist.
This field is only used if the scope
is shared
.
true
, the Docker volume is created if it doesn't already exist.
This field is only used if the scope
is shared
.
public DockerVolumeConfiguration withAutoprovision(Boolean 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
is shared
.
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
is shared
.
public Boolean isAutoprovision()
If this value is true
, the Docker volume is created if it doesn't already exist.
This field is only used if the scope
is shared
.
true
, the Docker volume is created if it doesn't already exist.
This field is only used if the scope
is shared
.
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.
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.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.
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.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.
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.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.
DriverOpts
in
the Create a volume
section of the Docker Remote API and the
xxopt
option to docker volume create.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.
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.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.
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.public DockerVolumeConfiguration addDriverOptsEntry(String key, String value)
public DockerVolumeConfiguration clearDriverOptsEntries()
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.
Labels
in the Create a volume section of
the Docker Remote API and the
xxlabel
option to docker volume create.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.
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.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.
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.public DockerVolumeConfiguration addLabelsEntry(String key, String value)
public DockerVolumeConfiguration clearLabelsEntries()
public String toString()
toString
in class Object
Object.toString()
public DockerVolumeConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.