#[non_exhaustive]pub struct VolumeBuilder { /* private fields */ }
Expand description
A builder for Volume
.
Implementations§
Source§impl VolumeBuilder
impl VolumeBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_name(&self) -> &Option<String>
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.
Sourcepub fn host(self, input: HostVolumeProperties) -> Self
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
.
Sourcepub fn set_host(self, input: Option<HostVolumeProperties>) -> Self
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
.
Sourcepub fn get_host(&self) -> &Option<HostVolumeProperties>
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
.
Sourcepub fn docker_volume_configuration(
self,
input: DockerVolumeConfiguration,
) -> Self
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.
Sourcepub fn set_docker_volume_configuration(
self,
input: Option<DockerVolumeConfiguration>,
) -> Self
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.
Sourcepub fn get_docker_volume_configuration(
&self,
) -> &Option<DockerVolumeConfiguration>
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.
Sourcepub fn efs_volume_configuration(self, input: EfsVolumeConfiguration) -> Self
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.
Sourcepub fn set_efs_volume_configuration(
self,
input: Option<EfsVolumeConfiguration>,
) -> Self
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.
Sourcepub fn get_efs_volume_configuration(&self) -> &Option<EfsVolumeConfiguration>
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.
Sourcepub fn fsx_windows_file_server_volume_configuration(
self,
input: FSxWindowsFileServerVolumeConfiguration,
) -> Self
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.
Sourcepub fn set_fsx_windows_file_server_volume_configuration(
self,
input: Option<FSxWindowsFileServerVolumeConfiguration>,
) -> Self
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.
Sourcepub fn get_fsx_windows_file_server_volume_configuration(
&self,
) -> &Option<FSxWindowsFileServerVolumeConfiguration>
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.
Sourcepub fn configured_at_launch(self, input: bool) -> Self
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.
Sourcepub fn set_configured_at_launch(self, input: Option<bool>) -> Self
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.
Sourcepub fn get_configured_at_launch(&self) -> &Option<bool>
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.
Trait Implementations§
Source§impl Clone for VolumeBuilder
impl Clone for VolumeBuilder
Source§fn clone(&self) -> VolumeBuilder
fn clone(&self) -> VolumeBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for VolumeBuilder
impl Debug for VolumeBuilder
Source§impl Default for VolumeBuilder
impl Default for VolumeBuilder
Source§fn default() -> VolumeBuilder
fn default() -> VolumeBuilder
Source§impl PartialEq for VolumeBuilder
impl PartialEq for VolumeBuilder
impl StructuralPartialEq for VolumeBuilder
Auto Trait Implementations§
impl Freeze for VolumeBuilder
impl RefUnwindSafe for VolumeBuilder
impl Send for VolumeBuilder
impl Sync for VolumeBuilder
impl Unpin for VolumeBuilder
impl UnwindSafe for VolumeBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);