#[non_exhaustive]pub struct EcsTaskPropertiesBuilder { /* private fields */ }
Expand description
A builder for EcsTaskProperties
.
Implementations§
Source§impl EcsTaskPropertiesBuilder
impl EcsTaskPropertiesBuilder
Sourcepub fn containers(self, input: TaskContainerProperties) -> Self
pub fn containers(self, input: TaskContainerProperties) -> Self
Appends an item to containers
.
To override the contents of this collection use set_containers
.
This object is a list of containers.
Sourcepub fn set_containers(self, input: Option<Vec<TaskContainerProperties>>) -> Self
pub fn set_containers(self, input: Option<Vec<TaskContainerProperties>>) -> Self
This object is a list of containers.
Sourcepub fn get_containers(&self) -> &Option<Vec<TaskContainerProperties>>
pub fn get_containers(&self) -> &Option<Vec<TaskContainerProperties>>
This object is a list of containers.
Sourcepub fn ephemeral_storage(self, input: EphemeralStorage) -> Self
pub fn ephemeral_storage(self, input: EphemeralStorage) -> Self
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
Sourcepub fn set_ephemeral_storage(self, input: Option<EphemeralStorage>) -> Self
pub fn set_ephemeral_storage(self, input: Option<EphemeralStorage>) -> Self
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
Sourcepub fn get_ephemeral_storage(&self) -> &Option<EphemeralStorage>
pub fn get_ephemeral_storage(&self) -> &Option<EphemeralStorage>
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
Sourcepub fn execution_role_arn(self, input: impl Into<String>) -> Self
pub fn execution_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.
Sourcepub fn set_execution_role_arn(self, input: Option<String>) -> Self
pub fn set_execution_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.
Sourcepub fn get_execution_role_arn(&self) -> &Option<String>
pub fn get_execution_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.
Sourcepub fn platform_version(self, input: impl Into<String>) -> Self
pub fn platform_version(self, input: impl Into<String>) -> Self
The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST
platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn set_platform_version(self, input: Option<String>) -> Self
pub fn set_platform_version(self, input: Option<String>) -> Self
The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST
platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn get_platform_version(&self) -> &Option<String>
pub fn get_platform_version(&self) -> &Option<String>
The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST
platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn ipc_mode(self, input: impl Into<String>) -> Self
pub fn ipc_mode(self, input: impl Into<String>) -> Self
The IPC resource namespace to use for the containers in the task. The valid values are host
, task
, or none
.
If host
is specified, all containers within the tasks that specified the host
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task
share the same IPC resources.
If none
is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.
If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
Sourcepub fn set_ipc_mode(self, input: Option<String>) -> Self
pub fn set_ipc_mode(self, input: Option<String>) -> Self
The IPC resource namespace to use for the containers in the task. The valid values are host
, task
, or none
.
If host
is specified, all containers within the tasks that specified the host
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task
share the same IPC resources.
If none
is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.
If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
Sourcepub fn get_ipc_mode(&self) -> &Option<String>
pub fn get_ipc_mode(&self) -> &Option<String>
The IPC resource namespace to use for the containers in the task. The valid values are host
, task
, or none
.
If host
is specified, all containers within the tasks that specified the host
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task
share the same IPC resources.
If none
is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.
If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.
Sourcepub fn task_role_arn(self, input: impl Into<String>) -> Self
pub fn task_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
This is object is comparable to ContainerProperties:jobRoleArn.
Sourcepub fn set_task_role_arn(self, input: Option<String>) -> Self
pub fn set_task_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
This is object is comparable to ContainerProperties:jobRoleArn.
Sourcepub fn get_task_role_arn(&self) -> &Option<String>
pub fn get_task_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
This is object is comparable to ContainerProperties:jobRoleArn.
Sourcepub fn pid_mode(self, input: impl Into<String>) -> Self
pub fn pid_mode(self, input: impl Into<String>) -> Self
The process namespace to use for the containers in the task. The valid values are host
or task
. For example, monitoring sidecars might need pidMode
to access information about other containers running in the same task.
If host
is specified, all containers within the tasks that specified the host
PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
Sourcepub fn set_pid_mode(self, input: Option<String>) -> Self
pub fn set_pid_mode(self, input: Option<String>) -> Self
The process namespace to use for the containers in the task. The valid values are host
or task
. For example, monitoring sidecars might need pidMode
to access information about other containers running in the same task.
If host
is specified, all containers within the tasks that specified the host
PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
Sourcepub fn get_pid_mode(&self) -> &Option<String>
pub fn get_pid_mode(&self) -> &Option<String>
The process namespace to use for the containers in the task. The valid values are host
or task
. For example, monitoring sidecars might need pidMode
to access information about other containers running in the same task.
If host
is specified, all containers within the tasks that specified the host
PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.
If task
is specified, all containers within the specified task share the same process namespace.
If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.
Sourcepub fn network_configuration(self, input: NetworkConfiguration) -> Self
pub fn network_configuration(self, input: NetworkConfiguration) -> Self
The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
Sourcepub fn set_network_configuration(
self,
input: Option<NetworkConfiguration>,
) -> Self
pub fn set_network_configuration( self, input: Option<NetworkConfiguration>, ) -> Self
The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
Sourcepub fn get_network_configuration(&self) -> &Option<NetworkConfiguration>
pub fn get_network_configuration(&self) -> &Option<NetworkConfiguration>
The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.
Sourcepub fn runtime_platform(self, input: RuntimePlatform) -> Self
pub fn runtime_platform(self, input: RuntimePlatform) -> Self
An object that represents the compute environment architecture for Batch jobs on Fargate.
Sourcepub fn set_runtime_platform(self, input: Option<RuntimePlatform>) -> Self
pub fn set_runtime_platform(self, input: Option<RuntimePlatform>) -> Self
An object that represents the compute environment architecture for Batch jobs on Fargate.
Sourcepub fn get_runtime_platform(&self) -> &Option<RuntimePlatform>
pub fn get_runtime_platform(&self) -> &Option<RuntimePlatform>
An object that represents the compute environment architecture for Batch jobs on Fargate.
Sourcepub fn volumes(self, input: Volume) -> Self
pub fn volumes(self, input: Volume) -> Self
Appends an item to volumes
.
To override the contents of this collection use set_volumes
.
A list of volumes that are associated with the job.
Sourcepub fn set_volumes(self, input: Option<Vec<Volume>>) -> Self
pub fn set_volumes(self, input: Option<Vec<Volume>>) -> Self
A list of volumes that are associated with the job.
Sourcepub fn get_volumes(&self) -> &Option<Vec<Volume>>
pub fn get_volumes(&self) -> &Option<Vec<Volume>>
A list of volumes that are associated with the job.
Sourcepub fn enable_execute_command(self, input: bool) -> Self
pub fn enable_execute_command(self, input: bool) -> Self
Determines whether execute command functionality is turned on for this task. If true
, execute command functionality is turned on all the containers in the task.
Sourcepub fn set_enable_execute_command(self, input: Option<bool>) -> Self
pub fn set_enable_execute_command(self, input: Option<bool>) -> Self
Determines whether execute command functionality is turned on for this task. If true
, execute command functionality is turned on all the containers in the task.
Sourcepub fn get_enable_execute_command(&self) -> &Option<bool>
pub fn get_enable_execute_command(&self) -> &Option<bool>
Determines whether execute command functionality is turned on for this task. If true
, execute command functionality is turned on all the containers in the task.
Sourcepub fn build(self) -> EcsTaskProperties
pub fn build(self) -> EcsTaskProperties
Consumes the builder and constructs a EcsTaskProperties
.
Trait Implementations§
Source§impl Clone for EcsTaskPropertiesBuilder
impl Clone for EcsTaskPropertiesBuilder
Source§fn clone(&self) -> EcsTaskPropertiesBuilder
fn clone(&self) -> EcsTaskPropertiesBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EcsTaskPropertiesBuilder
impl Debug for EcsTaskPropertiesBuilder
Source§impl Default for EcsTaskPropertiesBuilder
impl Default for EcsTaskPropertiesBuilder
Source§fn default() -> EcsTaskPropertiesBuilder
fn default() -> EcsTaskPropertiesBuilder
Source§impl PartialEq for EcsTaskPropertiesBuilder
impl PartialEq for EcsTaskPropertiesBuilder
impl StructuralPartialEq for EcsTaskPropertiesBuilder
Auto Trait Implementations§
impl Freeze for EcsTaskPropertiesBuilder
impl RefUnwindSafe for EcsTaskPropertiesBuilder
impl Send for EcsTaskPropertiesBuilder
impl Sync for EcsTaskPropertiesBuilder
impl Unpin for EcsTaskPropertiesBuilder
impl UnwindSafe for EcsTaskPropertiesBuilder
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);