Struct aws_sdk_ecs::types::builders::VolumeBuilder

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

A builder for Volume.

Implementations

impl VolumeBuilder

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

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

When using a volume configured at launch, the name is required and must also be specified as the volume name in the ServiceVolumeConfiguration or TaskVolumeConfiguration parameter when creating your service or standalone task.

For all other types of volumes, this name is referenced in the sourceVolume parameter of the mountPoints object in the container definition.

When a volume is using the efsVolumeConfiguration, the name is required.

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

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

When using a volume configured at launch, the name is required and must also be specified as the volume name in the ServiceVolumeConfiguration or TaskVolumeConfiguration parameter when creating your service or standalone task.

For all other types of volumes, this name is referenced in the sourceVolume parameter of the mountPoints object in the container definition.

When a volume is using the efsVolumeConfiguration, the name is required.

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

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

When using a volume configured at launch, the name is required and must also be specified as the volume name in the ServiceVolumeConfiguration or TaskVolumeConfiguration parameter when creating your service or standalone task.

For all other types of volumes, this name is referenced in the sourceVolume parameter of the mountPoints object in the container definition.

When a volume is using the efsVolumeConfiguration, the name is required.

pub fn host(self, input: HostVolumeProperties) -> Self

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 set_host(self, input: Option<HostVolumeProperties>) -> Self

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 get_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, input: DockerVolumeConfiguration ) -> Self

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 set_docker_volume_configuration( self, input: Option<DockerVolumeConfiguration> ) -> Self

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 get_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, input: EfsVolumeConfiguration) -> Self

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

pub fn set_efs_volume_configuration( self, input: Option<EfsVolumeConfiguration> ) -> Self

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

pub fn get_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, input: FSxWindowsFileServerVolumeConfiguration ) -> Self

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

pub fn set_fsx_windows_file_server_volume_configuration( self, input: Option<FSxWindowsFileServerVolumeConfiguration> ) -> Self

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

pub fn get_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.

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

Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.

To configure a volume at launch time, use this task definition revision and specify a volumeConfigurations object when calling the CreateService, UpdateService, RunTask or StartTask APIs.

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

Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.

To configure a volume at launch time, use this task definition revision and specify a volumeConfigurations object when calling the CreateService, UpdateService, RunTask or StartTask APIs.

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

Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration.

To configure a volume at launch time, use this task definition revision and specify a volumeConfigurations object when calling the CreateService, UpdateService, RunTask or StartTask APIs.

pub fn build(self) -> Volume

Consumes the builder and constructs a Volume.

Trait Implementations

impl Clone for VolumeBuilder

fn clone(&self) -> VolumeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VolumeBuilder

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

Formats the value using the given formatter.

impl Default for VolumeBuilder

fn default() -> VolumeBuilder

Returns the “default value” for a type.

impl PartialEq for VolumeBuilder

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

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

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

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

impl StructuralPartialEq for VolumeBuilder