#[non_exhaustive]pub struct LinuxParametersBuilder { /* private fields */ }
Expand description
A builder for LinuxParameters
.
Implementations§
Source§impl LinuxParametersBuilder
impl LinuxParametersBuilder
Sourcepub fn devices(self, input: Device) -> Self
pub fn devices(self, input: Device) -> Self
Appends an item to devices
.
To override the contents of this collection use set_devices
.
Any of the host devices to expose to the container. This parameter maps to Devices
in the Create a container section of the Docker Remote API and the --device
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn set_devices(self, input: Option<Vec<Device>>) -> Self
pub fn set_devices(self, input: Option<Vec<Device>>) -> Self
Any of the host devices to expose to the container. This parameter maps to Devices
in the Create a container section of the Docker Remote API and the --device
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn get_devices(&self) -> &Option<Vec<Device>>
pub fn get_devices(&self) -> &Option<Vec<Device>>
Any of the host devices to expose to the container. This parameter maps to Devices
in the Create a container section of the Docker Remote API and the --device
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn init_process_enabled(self, input: bool) -> Self
pub fn init_process_enabled(self, input: bool) -> Self
If true, run an init
process inside the container that forwards signals and reaps processes. This parameter maps to the --init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
Sourcepub fn set_init_process_enabled(self, input: Option<bool>) -> Self
pub fn set_init_process_enabled(self, input: Option<bool>) -> Self
If true, run an init
process inside the container that forwards signals and reaps processes. This parameter maps to the --init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
Sourcepub fn get_init_process_enabled(&self) -> &Option<bool>
pub fn get_init_process_enabled(&self) -> &Option<bool>
If true, run an init
process inside the container that forwards signals and reaps processes. This parameter maps to the --init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"
The value for the size (in MiB) of the /dev/shm
volume. This parameter maps to the --shm-size
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
The value for the size (in MiB) of the /dev/shm
volume. This parameter maps to the --shm-size
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
The value for the size (in MiB) of the /dev/shm
volume. This parameter maps to the --shm-size
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn tmpfs(self, input: Tmpfs) -> Self
pub fn tmpfs(self, input: Tmpfs) -> Self
Appends an item to tmpfs
.
To override the contents of this collection use set_tmpfs
.
The container path, mount options, and size (in MiB) of the tmpfs
mount. This parameter maps to the --tmpfs
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
Sourcepub fn set_tmpfs(self, input: Option<Vec<Tmpfs>>) -> Self
pub fn set_tmpfs(self, input: Option<Vec<Tmpfs>>) -> Self
The container path, mount options, and size (in MiB) of the tmpfs
mount. This parameter maps to the --tmpfs
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
Sourcepub fn get_tmpfs(&self) -> &Option<Vec<Tmpfs>>
pub fn get_tmpfs(&self) -> &Option<Vec<Tmpfs>>
The container path, mount options, and size (in MiB) of the tmpfs
mount. This parameter maps to the --tmpfs
option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.
Sourcepub fn max_swap(self, input: i32) -> Self
pub fn max_swap(self, input: i32) -> Self
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap
option to docker run where the value is the sum of the container memory plus the maxSwap
value. For more information, see --memory-swap
details in the Docker documentation.
If a maxSwap
value of 0
is specified, the container doesn't use swap. Accepted values are 0
or any positive integer. If the maxSwap
parameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. A maxSwap
value must be set for the swappiness
parameter to be used.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn set_max_swap(self, input: Option<i32>) -> Self
pub fn set_max_swap(self, input: Option<i32>) -> Self
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap
option to docker run where the value is the sum of the container memory plus the maxSwap
value. For more information, see --memory-swap
details in the Docker documentation.
If a maxSwap
value of 0
is specified, the container doesn't use swap. Accepted values are 0
or any positive integer. If the maxSwap
parameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. A maxSwap
value must be set for the swappiness
parameter to be used.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn get_max_swap(&self) -> &Option<i32>
pub fn get_max_swap(&self) -> &Option<i32>
The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap
option to docker run where the value is the sum of the container memory plus the maxSwap
value. For more information, see --memory-swap
details in the Docker documentation.
If a maxSwap
value of 0
is specified, the container doesn't use swap. Accepted values are 0
or any positive integer. If the maxSwap
parameter is omitted, the container doesn't use the swap configuration for the container instance on which it runs. A maxSwap
value must be set for the swappiness
parameter to be used.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn swappiness(self, input: i32) -> Self
pub fn swappiness(self, input: i32) -> Self
You can use this parameter to tune a container's memory swappiness behavior. A swappiness
value of 0
causes swapping to not occur unless absolutely necessary. A swappiness
value of 100
causes pages to be swapped aggressively. Valid values are whole numbers between 0
and 100
. If the swappiness
parameter isn't specified, a default value of 60
is used. If a value isn't specified for maxSwap
, then this parameter is ignored. If maxSwap
is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness
option to docker run.
Consider the following when you use a per-container swap configuration.
-
Swap space must be enabled and allocated on the container instance for the containers to use.
By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
-
The swap space parameters are only supported for job definitions using EC2 resources.
-
If the
maxSwap
andswappiness
parameters are omitted from a job definition, each container has a defaultswappiness
value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn set_swappiness(self, input: Option<i32>) -> Self
pub fn set_swappiness(self, input: Option<i32>) -> Self
You can use this parameter to tune a container's memory swappiness behavior. A swappiness
value of 0
causes swapping to not occur unless absolutely necessary. A swappiness
value of 100
causes pages to be swapped aggressively. Valid values are whole numbers between 0
and 100
. If the swappiness
parameter isn't specified, a default value of 60
is used. If a value isn't specified for maxSwap
, then this parameter is ignored. If maxSwap
is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness
option to docker run.
Consider the following when you use a per-container swap configuration.
-
Swap space must be enabled and allocated on the container instance for the containers to use.
By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
-
The swap space parameters are only supported for job definitions using EC2 resources.
-
If the
maxSwap
andswappiness
parameters are omitted from a job definition, each container has a defaultswappiness
value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn get_swappiness(&self) -> &Option<i32>
pub fn get_swappiness(&self) -> &Option<i32>
You can use this parameter to tune a container's memory swappiness behavior. A swappiness
value of 0
causes swapping to not occur unless absolutely necessary. A swappiness
value of 100
causes pages to be swapped aggressively. Valid values are whole numbers between 0
and 100
. If the swappiness
parameter isn't specified, a default value of 60
is used. If a value isn't specified for maxSwap
, then this parameter is ignored. If maxSwap
is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness
option to docker run.
Consider the following when you use a per-container swap configuration.
-
Swap space must be enabled and allocated on the container instance for the containers to use.
By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?
-
The swap space parameters are only supported for job definitions using EC2 resources.
-
If the
maxSwap
andswappiness
parameters are omitted from a job definition, each container has a defaultswappiness
value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.
Sourcepub fn build(self) -> LinuxParameters
pub fn build(self) -> LinuxParameters
Consumes the builder and constructs a LinuxParameters
.
Trait Implementations§
Source§impl Clone for LinuxParametersBuilder
impl Clone for LinuxParametersBuilder
Source§fn clone(&self) -> LinuxParametersBuilder
fn clone(&self) -> LinuxParametersBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for LinuxParametersBuilder
impl Debug for LinuxParametersBuilder
Source§impl Default for LinuxParametersBuilder
impl Default for LinuxParametersBuilder
Source§fn default() -> LinuxParametersBuilder
fn default() -> LinuxParametersBuilder
Source§impl PartialEq for LinuxParametersBuilder
impl PartialEq for LinuxParametersBuilder
impl StructuralPartialEq for LinuxParametersBuilder
Auto Trait Implementations§
impl Freeze for LinuxParametersBuilder
impl RefUnwindSafe for LinuxParametersBuilder
impl Send for LinuxParametersBuilder
impl Sync for LinuxParametersBuilder
impl Unpin for LinuxParametersBuilder
impl UnwindSafe for LinuxParametersBuilder
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);