Struct DockerVolumeConfigurationBuilder

#[non_exhaustive]
pub struct DockerVolumeConfigurationBuilder { /* private fields */ }

A builder for DockerVolumeConfiguration.

Implementations

impl DockerVolumeConfigurationBuilder

pub fn scope(self, input: Scope) -> Self

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.

pub fn set_scope(self, input: Option<Scope>) -> Self

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.

pub fn get_scope(&self) -> &Option<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.

pub fn autoprovision(self, input: bool) -> Self

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.

pub fn set_autoprovision(self, input: Option<bool>) -> Self

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.

pub fn get_autoprovision(&self) -> &Option<bool>

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.

pub fn driver(self, input: impl Into<String>) -> Self

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. This parameter maps to Driver in the docker container create command and the xxdriver option to docker volume create.

pub fn set_driver(self, input: Option<String>) -> Self

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. This parameter maps to Driver in the docker container create command and the xxdriver option to docker volume create.

pub fn get_driver(&self) -> &Option<String>

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. This parameter maps to Driver in the docker container create command and the xxdriver option to docker volume create.

pub fn driver_opts(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to driver_opts.

To override the contents of this collection use set_driver_opts.

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the docker create-volume command and the xxopt option to docker volume create.

pub fn set_driver_opts(self, input: Option<HashMap<String, String>>) -> Self

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the docker create-volume command and the xxopt option to docker volume create.

pub fn get_driver_opts(&self) -> &Option<HashMap<String, String>>

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the docker create-volume command and the xxopt option to docker volume create.

pub fn labels(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to labels.

To override the contents of this collection use set_labels.

Custom metadata to add to your Docker volume. This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.

pub fn set_labels(self, input: Option<HashMap<String, String>>) -> Self

Custom metadata to add to your Docker volume. This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.

pub fn get_labels(&self) -> &Option<HashMap<String, String>>

Custom metadata to add to your Docker volume. This parameter maps to Labels in the docker container create command and the xxlabel option to docker volume create.

pub fn build(self) -> DockerVolumeConfiguration

Consumes the builder and constructs a DockerVolumeConfiguration.

Trait Implementations

impl Clone for DockerVolumeConfigurationBuilder

fn clone(&self) -> DockerVolumeConfigurationBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DockerVolumeConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DockerVolumeConfigurationBuilder

fn default() -> DockerVolumeConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for DockerVolumeConfigurationBuilder

fn eq(&self, other: &DockerVolumeConfigurationBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DockerVolumeConfigurationBuilder