software.amazon.awssdk.services.ecs.model

Interface DockerVolumeConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DockerVolumeConfiguration.Builder,DockerVolumeConfiguration>, SdkBuilder<DockerVolumeConfiguration.Builder,DockerVolumeConfiguration>, SdkPojo

Enclosing class:

DockerVolumeConfiguration

public static interface DockerVolumeConfiguration.Builder
extends SdkPojo, CopyableBuilder<DockerVolumeConfiguration.Builder,DockerVolumeConfiguration>

Method Summary

Modifier and Type	Method and Description
DockerVolumeConfiguration.Builder	autoprovision(Boolean autoprovision) If this value is true, the Docker volume is created if it does not already exist.
DockerVolumeConfiguration.Builder	driver(String driver) The Docker volume driver to use.
DockerVolumeConfiguration.Builder	driverOpts(Map<String,String> driverOpts) A map of Docker driver-specific options passed through.
DockerVolumeConfiguration.Builder	labels(Map<String,String> labels) Custom metadata to add to your Docker volume.
DockerVolumeConfiguration.Builder	scope(Scope scope) The scope for the Docker volume that determines its lifecycle.
DockerVolumeConfiguration.Builder	scope(String scope) The scope for the Docker volume that determines its lifecycle.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

scope

DockerVolumeConfiguration.Builder scope(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, Scope

scope

DockerVolumeConfiguration.Builder scope(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, Scope

autoprovision

DockerVolumeConfiguration.Builder autoprovision(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.

driver

DockerVolumeConfiguration.Builder driver(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.

driverOpts

DockerVolumeConfiguration.Builder driverOpts(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.

labels

DockerVolumeConfiguration.Builder labels(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.