#[non_exhaustive]pub struct EcsParametersBuilder { /* private fields */ }
Expand description
A builder for EcsParameters
.
Implementations§
Source§impl EcsParametersBuilder
impl EcsParametersBuilder
Sourcepub fn task_definition_arn(self, input: impl Into<String>) -> Self
pub fn task_definition_arn(self, input: impl Into<String>) -> Self
The ARN of the task definition to use if the event target is an Amazon ECS task.
This field is required.Sourcepub fn set_task_definition_arn(self, input: Option<String>) -> Self
pub fn set_task_definition_arn(self, input: Option<String>) -> Self
The ARN of the task definition to use if the event target is an Amazon ECS task.
Sourcepub fn get_task_definition_arn(&self) -> &Option<String>
pub fn get_task_definition_arn(&self) -> &Option<String>
The ARN of the task definition to use if the event target is an Amazon ECS task.
Sourcepub fn task_count(self, input: i32) -> Self
pub fn task_count(self, input: i32) -> Self
The number of tasks to create based on TaskDefinition
. The default is 1.
Sourcepub fn set_task_count(self, input: Option<i32>) -> Self
pub fn set_task_count(self, input: Option<i32>) -> Self
The number of tasks to create based on TaskDefinition
. The default is 1.
Sourcepub fn get_task_count(&self) -> &Option<i32>
pub fn get_task_count(&self) -> &Option<i32>
The number of tasks to create based on TaskDefinition
. The default is 1.
Sourcepub fn launch_type(self, input: LaunchType) -> Self
pub fn launch_type(self, input: LaunchType) -> Self
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 set_launch_type(self, input: Option<LaunchType>) -> Self
pub fn set_launch_type(self, input: Option<LaunchType>) -> Self
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 get_launch_type(&self) -> &Option<LaunchType>
pub fn get_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, input: NetworkConfiguration) -> Self
pub fn network_configuration(self, input: NetworkConfiguration) -> Self
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 set_network_configuration(
self,
input: Option<NetworkConfiguration>,
) -> Self
pub fn set_network_configuration( self, input: Option<NetworkConfiguration>, ) -> Self
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 get_network_configuration(&self) -> &Option<NetworkConfiguration>
pub fn get_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, input: impl Into<String>) -> Self
pub fn platform_version(self, input: impl Into<String>) -> Self
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 set_platform_version(self, input: Option<String>) -> Self
pub fn set_platform_version(self, input: Option<String>) -> Self
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 get_platform_version(&self) -> &Option<String>
pub fn get_platform_version(&self) -> &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.
Sourcepub fn group(self, input: impl Into<String>) -> Self
pub fn group(self, input: impl Into<String>) -> Self
Specifies an ECS task group for the task. The maximum length is 255 characters.
Sourcepub fn set_group(self, input: Option<String>) -> Self
pub fn set_group(self, input: Option<String>) -> Self
Specifies an ECS task group for the task. The maximum length is 255 characters.
Sourcepub fn get_group(&self) -> &Option<String>
pub fn get_group(&self) -> &Option<String>
Specifies an ECS task group for the task. The maximum length is 255 characters.
Sourcepub fn capacity_provider_strategy(
self,
input: CapacityProviderStrategyItem,
) -> Self
pub fn capacity_provider_strategy( self, input: CapacityProviderStrategyItem, ) -> Self
Appends an item to capacity_provider_strategy
.
To override the contents of this collection use set_capacity_provider_strategy
.
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.
Sourcepub fn set_capacity_provider_strategy(
self,
input: Option<Vec<CapacityProviderStrategyItem>>,
) -> Self
pub fn set_capacity_provider_strategy( self, input: Option<Vec<CapacityProviderStrategyItem>>, ) -> Self
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.
Sourcepub fn get_capacity_provider_strategy(
&self,
) -> &Option<Vec<CapacityProviderStrategyItem>>
pub fn get_capacity_provider_strategy( &self, ) -> &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.
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.
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, input: bool) -> Self
pub fn enable_execute_command(self, input: bool) -> Self
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 set_enable_execute_command(self, input: Option<bool>) -> Self
pub fn set_enable_execute_command(self, input: Option<bool>) -> Self
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 get_enable_execute_command(&self) -> &Option<bool>
pub fn get_enable_execute_command(&self) -> &Option<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, input: PlacementConstraint) -> Self
pub fn placement_constraints(self, input: PlacementConstraint) -> Self
Appends an item to placement_constraints
.
To override the contents of this collection use set_placement_constraints
.
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).
Sourcepub fn set_placement_constraints(
self,
input: Option<Vec<PlacementConstraint>>,
) -> Self
pub fn set_placement_constraints( self, input: Option<Vec<PlacementConstraint>>, ) -> Self
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).
Sourcepub fn get_placement_constraints(&self) -> &Option<Vec<PlacementConstraint>>
pub fn get_placement_constraints(&self) -> &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).
Sourcepub fn placement_strategy(self, input: PlacementStrategy) -> Self
pub fn placement_strategy(self, input: PlacementStrategy) -> Self
Appends an item to placement_strategy
.
To override the contents of this collection use set_placement_strategy
.
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
Sourcepub fn set_placement_strategy(
self,
input: Option<Vec<PlacementStrategy>>,
) -> Self
pub fn set_placement_strategy( self, input: Option<Vec<PlacementStrategy>>, ) -> Self
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
Sourcepub fn get_placement_strategy(&self) -> &Option<Vec<PlacementStrategy>>
pub fn get_placement_strategy(&self) -> &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.
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.
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, input: impl Into<String>) -> Self
pub fn reference_id(self, input: impl Into<String>) -> Self
The reference ID to use for the task.
Sourcepub fn set_reference_id(self, input: Option<String>) -> Self
pub fn set_reference_id(self, input: Option<String>) -> Self
The reference ID to use for the task.
Sourcepub fn get_reference_id(&self) -> &Option<String>
pub fn get_reference_id(&self) -> &Option<String>
The reference ID to use for the task.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
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.
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.
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.
Sourcepub fn build(self) -> Result<EcsParameters, BuildError>
pub fn build(self) -> Result<EcsParameters, BuildError>
Consumes the builder and constructs a EcsParameters
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for EcsParametersBuilder
impl Clone for EcsParametersBuilder
Source§fn clone(&self) -> EcsParametersBuilder
fn clone(&self) -> EcsParametersBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EcsParametersBuilder
impl Debug for EcsParametersBuilder
Source§impl Default for EcsParametersBuilder
impl Default for EcsParametersBuilder
Source§fn default() -> EcsParametersBuilder
fn default() -> EcsParametersBuilder
Source§impl PartialEq for EcsParametersBuilder
impl PartialEq for EcsParametersBuilder
impl StructuralPartialEq for EcsParametersBuilder
Auto Trait Implementations§
impl Freeze for EcsParametersBuilder
impl RefUnwindSafe for EcsParametersBuilder
impl Send for EcsParametersBuilder
impl Sync for EcsParametersBuilder
impl Unpin for EcsParametersBuilder
impl UnwindSafe for EcsParametersBuilder
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);