Struct aws_sdk_ecs::model::Volume

#[non_exhaustive]
pub struct Volume {
    pub name: Option<String>,
    pub host: Option<HostVolumeProperties>,
    pub docker_volume_configuration: Option<DockerVolumeConfiguration>,
    pub efs_volume_configuration: Option<EfsVolumeConfiguration>,
    pub fsx_windows_file_server_volume_configuration: Option<FSxWindowsFileServerVolumeConfiguration>,
}

A data volume that's used in a task definition. For tasks that use the Amazon Elastic File System (Amazon EFS), specify an efsVolumeConfiguration. For Windows tasks that use Amazon FSx for Windows File Server file system, specify a fsxWindowsFileServerVolumeConfiguration. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

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.

name: Option<String>

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

host: Option<HostVolumeProperties>

This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

docker_volume_configuration: Option<DockerVolumeConfiguration>

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

efs_volume_configuration: Option<EfsVolumeConfiguration>

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

fsx_windows_file_server_volume_configuration: Option<FSxWindowsFileServerVolumeConfiguration>

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

Implementations

impl Volume

pub fn name(&self) -> Option<&str>

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

pub fn host(&self) -> Option<&HostVolumeProperties>

This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount C:\my\path:C:\my\path and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path.

pub fn docker_volume_configuration(&self) -> Option<&DockerVolumeConfiguration>

This parameter is specified when you use Docker volumes.

Windows containers only support the use of the local driver. To use bind mounts, specify the host parameter instead.

Docker volumes aren't supported by tasks run on Fargate.

pub fn efs_volume_configuration(&self) -> Option<&EfsVolumeConfiguration>

This parameter is specified when you use an Amazon Elastic File System file system for task storage.

pub fn fsx_windows_file_server_volume_configuration(
    &self
) -> Option<&FSxWindowsFileServerVolumeConfiguration>

This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage.

impl Volume

pub fn builder() -> Builder

Creates a new builder-style object to manufacture Volume

Trait Implementations

impl Clone for Volume

fn clone(&self) -> Volume

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Volume

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

Formats the value using the given formatter.

impl PartialEq<Volume> for Volume

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Volume