Interface DockerVolumeConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DockerVolumeConfiguration.Builder,
,DockerVolumeConfiguration> SdkBuilder<DockerVolumeConfiguration.Builder,
,DockerVolumeConfiguration> SdkPojo
- Enclosing class:
DockerVolumeConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionautoprovision
(Boolean autoprovision) If this value istrue
, the Docker volume is created if it doesn't already exist.The Docker volume driver to use.driverOpts
(Map<String, String> driverOpts) A map of Docker driver-specific options passed through.Custom metadata to add to your Docker volume.The scope for the Docker volume that determines its lifecycle.The scope for the Docker volume that determines its lifecycle.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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.- Parameters:
scope
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to atask
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
scope
- The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to atask
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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
.- Parameters:
autoprovision
- If this value istrue
, the Docker volume is created if it doesn't already exist.This field is only used if the
scope
isshared
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- 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, usedocker 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
driverOpts
- A map of Docker driver-specific options passed through. This parameter maps toDriverOpts
in the Create a volume section of the Docker Remote API and thexxopt
option to docker volume create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
labels
- Custom metadata to add to your Docker volume. This parameter maps toLabels
in the Create a volume section of the Docker Remote API and thexxlabel
option to docker volume create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-