pub struct UpdateTaskProtectionFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to UpdateTaskProtection.
Updates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the protectionEnabled property making the task eligible for termination by a subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes property. The expiresInMinutes property is always reset when you invoke this operation for a task that already has protectionEnabled set to true. You can keep extending the protection expiration period of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .
This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure reasons.
If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.
Implementations§
Source§impl UpdateTaskProtectionFluentBuilder
impl UpdateTaskProtectionFluentBuilder
Sourcepub fn as_input(&self) -> &UpdateTaskProtectionInputBuilder
pub fn as_input(&self) -> &UpdateTaskProtectionInputBuilder
Access the UpdateTaskProtection as a reference.
Sourcepub async fn send(
self,
) -> Result<UpdateTaskProtectionOutput, SdkError<UpdateTaskProtectionError, HttpResponse>>
pub async fn send( self, ) -> Result<UpdateTaskProtectionOutput, SdkError<UpdateTaskProtectionError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<UpdateTaskProtectionOutput, UpdateTaskProtectionError, Self>
pub fn customize( self, ) -> CustomizableOperation<UpdateTaskProtectionOutput, UpdateTaskProtectionError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn cluster(self, input: impl Into<String>) -> Self
pub fn cluster(self, input: impl Into<String>) -> Self
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
Sourcepub fn set_cluster(self, input: Option<String>) -> Self
pub fn set_cluster(self, input: Option<String>) -> Self
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
Sourcepub fn get_cluster(&self) -> &Option<String>
pub fn get_cluster(&self) -> &Option<String>
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
Sourcepub fn tasks(self, input: impl Into<String>) -> Self
pub fn tasks(self, input: impl Into<String>) -> Self
Appends an item to tasks.
To override the contents of this collection use set_tasks.
A list of up to 10 task IDs or full ARN entries.
Sourcepub fn set_tasks(self, input: Option<Vec<String>>) -> Self
pub fn set_tasks(self, input: Option<Vec<String>>) -> Self
A list of up to 10 task IDs or full ARN entries.
Sourcepub fn get_tasks(&self) -> &Option<Vec<String>>
pub fn get_tasks(&self) -> &Option<Vec<String>>
A list of up to 10 task IDs or full ARN entries.
Sourcepub fn protection_enabled(self, input: bool) -> Self
pub fn protection_enabled(self, input: bool) -> Self
Specify true to mark a task for protection and false to unset protection, making it eligible for termination.
Sourcepub fn set_protection_enabled(self, input: Option<bool>) -> Self
pub fn set_protection_enabled(self, input: Option<bool>) -> Self
Specify true to mark a task for protection and false to unset protection, making it eligible for termination.
Sourcepub fn get_protection_enabled(&self) -> &Option<bool>
pub fn get_protection_enabled(&self) -> &Option<bool>
Specify true to mark a task for protection and false to unset protection, making it eligible for termination.
Sourcepub fn expires_in_minutes(self, input: i32) -> Self
pub fn expires_in_minutes(self, input: i32) -> Self
If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.
If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).
Sourcepub fn set_expires_in_minutes(self, input: Option<i32>) -> Self
pub fn set_expires_in_minutes(self, input: Option<i32>) -> Self
If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.
If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).
Sourcepub fn get_expires_in_minutes(&self) -> &Option<i32>
pub fn get_expires_in_minutes(&self) -> &Option<i32>
If you set protectionEnabled to true, you can specify the duration for task protection in minutes. You can specify a value from 1 minute to up to 2,880 minutes (48 hours). During this time, your task will not be terminated by scale-in events from Service Auto Scaling or deployments. After this time period lapses, protectionEnabled will be reset to false.
If you don’t specify the time, then the task is automatically protected for 120 minutes (2 hours).
Trait Implementations§
Source§impl Clone for UpdateTaskProtectionFluentBuilder
impl Clone for UpdateTaskProtectionFluentBuilder
Source§fn clone(&self) -> UpdateTaskProtectionFluentBuilder
fn clone(&self) -> UpdateTaskProtectionFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for UpdateTaskProtectionFluentBuilder
impl !RefUnwindSafe for UpdateTaskProtectionFluentBuilder
impl Send for UpdateTaskProtectionFluentBuilder
impl Sync for UpdateTaskProtectionFluentBuilder
impl Unpin for UpdateTaskProtectionFluentBuilder
impl !UnwindSafe for UpdateTaskProtectionFluentBuilder
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);