#[non_exhaustive]pub struct EcsTaskProperties {
pub containers: Option<Vec<TaskContainerProperties>>,
pub ephemeral_storage: Option<EphemeralStorage>,
pub execution_role_arn: Option<String>,
pub platform_version: Option<String>,
pub ipc_mode: Option<String>,
pub task_role_arn: Option<String>,
pub pid_mode: Option<String>,
pub network_configuration: Option<NetworkConfiguration>,
pub runtime_platform: Option<RuntimePlatform>,
pub volumes: Option<Vec<Volume>>,
pub enable_execute_command: Option<bool>,
}Expand description
The properties for a task definition that describes the container and volume definitions of an Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.containers: Option<Vec<TaskContainerProperties>>This object is a list of containers.
ephemeral_storage: 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.
execution_role_arn: 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.
platform_version: 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.
ipc_mode: 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.
task_role_arn: Option<String>The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
This is object is comparable to ContainerProperties:jobRoleArn.
pid_mode: 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.
network_configuration: 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.
runtime_platform: Option<RuntimePlatform>An object that represents the compute environment architecture for Batch jobs on Fargate.
volumes: Option<Vec<Volume>>A list of volumes that are associated with the job.
enable_execute_command: 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.
Implementations§
Source§impl EcsTaskProperties
impl EcsTaskProperties
Sourcepub fn containers(&self) -> &[TaskContainerProperties]
pub fn containers(&self) -> &[TaskContainerProperties]
This object is a list of containers.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .containers.is_none().
Sourcepub fn ephemeral_storage(&self) -> Option<&EphemeralStorage>
pub fn 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) -> Option<&str>
pub fn execution_role_arn(&self) -> Option<&str>
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) -> Option<&str>
pub fn platform_version(&self) -> Option<&str>
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) -> Option<&str>
pub fn ipc_mode(&self) -> Option<&str>
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) -> Option<&str>
pub fn task_role_arn(&self) -> Option<&str>
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) -> Option<&str>
pub fn pid_mode(&self) -> Option<&str>
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) -> Option<&NetworkConfiguration>
pub fn 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) -> Option<&RuntimePlatform>
pub fn runtime_platform(&self) -> Option<&RuntimePlatform>
An object that represents the compute environment architecture for Batch jobs on Fargate.
Sourcepub fn volumes(&self) -> &[Volume]
pub fn volumes(&self) -> &[Volume]
A list of volumes that are associated with the job.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .volumes.is_none().
Sourcepub fn enable_execute_command(&self) -> Option<bool>
pub fn 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.
Source§impl EcsTaskProperties
impl EcsTaskProperties
Sourcepub fn builder() -> EcsTaskPropertiesBuilder
pub fn builder() -> EcsTaskPropertiesBuilder
Creates a new builder-style object to manufacture EcsTaskProperties.
Trait Implementations§
Source§impl Clone for EcsTaskProperties
impl Clone for EcsTaskProperties
Source§fn clone(&self) -> EcsTaskProperties
fn clone(&self) -> EcsTaskProperties
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for EcsTaskProperties
impl Debug for EcsTaskProperties
Source§impl PartialEq for EcsTaskProperties
impl PartialEq for EcsTaskProperties
impl StructuralPartialEq for EcsTaskProperties
Auto Trait Implementations§
impl Freeze for EcsTaskProperties
impl RefUnwindSafe for EcsTaskProperties
impl Send for EcsTaskProperties
impl Sync for EcsTaskProperties
impl Unpin for EcsTaskProperties
impl UnwindSafe for EcsTaskProperties
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);