#[non_exhaustive]pub struct EcsParameters {Show 14 fields
pub task_definition_arn: String,
pub task_count: Option<i32>,
pub launch_type: Option<LaunchType>,
pub network_configuration: Option<NetworkConfiguration>,
pub platform_version: Option<String>,
pub group: Option<String>,
pub capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>,
pub enable_ecs_managed_tags: bool,
pub enable_execute_command: bool,
pub placement_constraints: Option<Vec<PlacementConstraint>>,
pub placement_strategy: Option<Vec<PlacementStrategy>>,
pub propagate_tags: Option<PropagateTags>,
pub reference_id: Option<String>,
pub tags: Option<Vec<Tag>>,
}Expand description
The custom parameters to be used when the target is an Amazon ECS 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.task_definition_arn: StringThe ARN of the task definition to use if the event target is an Amazon ECS task.
task_count: Option<i32>The number of tasks to create based on TaskDefinition. The default is 1.
launch_type: Option<LaunchType>Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
network_configuration: Option<NetworkConfiguration>Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.
platform_version: Option<String>Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
group: Option<String>Specifies an ECS task group for the task. The maximum length is 255 characters.
capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
enable_execute_command: boolWhether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
placement_constraints: Option<Vec<PlacementConstraint>>An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
placement_strategy: Option<Vec<PlacementStrategy>>The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
reference_id: Option<String>The reference ID to use for the task.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
Implementations§
Source§impl EcsParameters
impl EcsParameters
Sourcepub fn task_definition_arn(&self) -> &str
pub fn task_definition_arn(&self) -> &str
The ARN of the task definition to use if the event target is an Amazon ECS task.
Sourcepub fn task_count(&self) -> Option<i32>
pub fn task_count(&self) -> Option<i32>
The number of tasks to create based on TaskDefinition. The default is 1.
Sourcepub fn launch_type(&self) -> Option<&LaunchType>
pub fn launch_type(&self) -> Option<&LaunchType>
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn network_configuration(&self) -> Option<&NetworkConfiguration>
pub fn network_configuration(&self) -> Option<&NetworkConfiguration>
Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.
If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.
Sourcepub fn platform_version(&self) -> Option<&str>
pub fn platform_version(&self) -> Option<&str>
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn group(&self) -> Option<&str>
pub fn group(&self) -> Option<&str>
Specifies an ECS task group for the task. The maximum length is 255 characters.
Sourcepub fn capacity_provider_strategy(&self) -> &[CapacityProviderStrategyItem]
pub fn capacity_provider_strategy(&self) -> &[CapacityProviderStrategyItem]
The capacity provider strategy to use for the task.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .capacity_provider_strategy.is_none().
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
Sourcepub fn enable_execute_command(&self) -> bool
pub fn enable_execute_command(&self) -> bool
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
Sourcepub fn placement_constraints(&self) -> &[PlacementConstraint]
pub fn placement_constraints(&self) -> &[PlacementConstraint]
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .placement_constraints.is_none().
Sourcepub fn placement_strategy(&self) -> &[PlacementStrategy]
pub fn placement_strategy(&self) -> &[PlacementStrategy]
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .placement_strategy.is_none().
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
Sourcepub fn reference_id(&self) -> Option<&str>
pub fn reference_id(&self) -> Option<&str>
The reference ID to use for the task.
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().
Source§impl EcsParameters
impl EcsParameters
Sourcepub fn builder() -> EcsParametersBuilder
pub fn builder() -> EcsParametersBuilder
Creates a new builder-style object to manufacture EcsParameters.
Trait Implementations§
Source§impl Clone for EcsParameters
impl Clone for EcsParameters
Source§fn clone(&self) -> EcsParameters
fn clone(&self) -> EcsParameters
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 EcsParameters
impl Debug for EcsParameters
Source§impl PartialEq for EcsParameters
impl PartialEq for EcsParameters
impl StructuralPartialEq for EcsParameters
Auto Trait Implementations§
impl Freeze for EcsParameters
impl RefUnwindSafe for EcsParameters
impl Send for EcsParameters
impl Sync for EcsParameters
impl Unpin for EcsParameters
impl UnwindSafe for EcsParameters
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);