Struct DockerVolumeConfiguration

#[non_exhaustive]
pub struct DockerVolumeConfiguration {
    pub scope: Option<Scope>,
    pub autoprovision: Option<bool>,
    pub driver: Option<String>,
    pub driver_opts: Option<HashMap<String, String>>,
    pub labels: Option<HashMap<String, String>>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

scope: 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.

autoprovision: 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.

driver: 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.

driver_opts: 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.

labels: 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.

Implementations

impl DockerVolumeConfiguration

pub fn 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) -> 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) -> Option<&str>

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) -> 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) -> 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.

impl DockerVolumeConfiguration

pub fn builder() -> DockerVolumeConfigurationBuilder

Creates a new builder-style object to manufacture DockerVolumeConfiguration.

Trait Implementations

impl Clone for DockerVolumeConfiguration

fn clone(&self) -> DockerVolumeConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockerVolumeConfiguration

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

Formats the value using the given formatter.

impl PartialEq for DockerVolumeConfiguration

fn eq(&self, other: &DockerVolumeConfiguration) -> 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 DockerVolumeConfiguration