#[non_exhaustive]pub struct PutLifecycleHookInputBuilder { /* private fields */ }
Expand description
A builder for PutLifecycleHookInput
.
Implementations§
Source§impl PutLifecycleHookInputBuilder
impl PutLifecycleHookInputBuilder
Sourcepub fn lifecycle_hook_name(self, input: impl Into<String>) -> Self
pub fn lifecycle_hook_name(self, input: impl Into<String>) -> Self
The name of the lifecycle hook.
This field is required.Sourcepub fn set_lifecycle_hook_name(self, input: Option<String>) -> Self
pub fn set_lifecycle_hook_name(self, input: Option<String>) -> Self
The name of the lifecycle hook.
Sourcepub fn get_lifecycle_hook_name(&self) -> &Option<String>
pub fn get_lifecycle_hook_name(&self) -> &Option<String>
The name of the lifecycle hook.
Sourcepub fn auto_scaling_group_name(self, input: impl Into<String>) -> Self
pub fn auto_scaling_group_name(self, input: impl Into<String>) -> Self
The name of the Auto Scaling group.
This field is required.Sourcepub fn set_auto_scaling_group_name(self, input: Option<String>) -> Self
pub fn set_auto_scaling_group_name(self, input: Option<String>) -> Self
The name of the Auto Scaling group.
Sourcepub fn get_auto_scaling_group_name(&self) -> &Option<String>
pub fn get_auto_scaling_group_name(&self) -> &Option<String>
The name of the Auto Scaling group.
Sourcepub fn lifecycle_transition(self, input: impl Into<String>) -> Self
pub fn lifecycle_transition(self, input: impl Into<String>) -> Self
The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
-
To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING
. -
To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING
.
Required for new lifecycle hooks, but optional when updating existing hooks.
Sourcepub fn set_lifecycle_transition(self, input: Option<String>) -> Self
pub fn set_lifecycle_transition(self, input: Option<String>) -> Self
The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
-
To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING
. -
To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING
.
Required for new lifecycle hooks, but optional when updating existing hooks.
Sourcepub fn get_lifecycle_transition(&self) -> &Option<String>
pub fn get_lifecycle_transition(&self) -> &Option<String>
The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
-
To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING
. -
To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING
.
Required for new lifecycle hooks, but optional when updating existing hooks.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.
Sourcepub fn notification_target_arn(self, input: impl Into<String>) -> Self
pub fn notification_target_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.
If you specify an empty string, this overrides the current ARN.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION"
.
Sourcepub fn set_notification_target_arn(self, input: Option<String>) -> Self
pub fn set_notification_target_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.
If you specify an empty string, this overrides the current ARN.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION"
.
Sourcepub fn get_notification_target_arn(&self) -> &Option<String>
pub fn get_notification_target_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in a wait state for the lifecycle hook. You can specify either an Amazon SNS topic or an Amazon SQS queue.
If you specify an empty string, this overrides the current ARN.
This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.
When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION"
.
Sourcepub fn notification_metadata(self, input: impl Into<String>) -> Self
pub fn notification_metadata(self, input: impl Into<String>) -> Self
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
Sourcepub fn set_notification_metadata(self, input: Option<String>) -> Self
pub fn set_notification_metadata(self, input: Option<String>) -> Self
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
Sourcepub fn get_notification_metadata(&self) -> &Option<String>
pub fn get_notification_metadata(&self) -> &Option<String>
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
Sourcepub fn heartbeat_timeout(self, input: i32) -> Self
pub fn heartbeat_timeout(self, input: i32) -> Self
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30
to 7200
seconds. The default value is 3600
seconds (1 hour).
Sourcepub fn set_heartbeat_timeout(self, input: Option<i32>) -> Self
pub fn set_heartbeat_timeout(self, input: Option<i32>) -> Self
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30
to 7200
seconds. The default value is 3600
seconds (1 hour).
Sourcepub fn get_heartbeat_timeout(&self) -> &Option<i32>
pub fn get_heartbeat_timeout(&self) -> &Option<i32>
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30
to 7200
seconds. The default value is 3600
seconds (1 hour).
Sourcepub fn default_result(self, input: impl Into<String>) -> Self
pub fn default_result(self, input: impl Into<String>) -> Self
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON
.
Valid values: CONTINUE
| ABANDON
Sourcepub fn set_default_result(self, input: Option<String>) -> Self
pub fn set_default_result(self, input: Option<String>) -> Self
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON
.
Valid values: CONTINUE
| ABANDON
Sourcepub fn get_default_result(&self) -> &Option<String>
pub fn get_default_result(&self) -> &Option<String>
The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON
.
Valid values: CONTINUE
| ABANDON
Sourcepub fn build(self) -> Result<PutLifecycleHookInput, BuildError>
pub fn build(self) -> Result<PutLifecycleHookInput, BuildError>
Consumes the builder and constructs a PutLifecycleHookInput
.
Source§impl PutLifecycleHookInputBuilder
impl PutLifecycleHookInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<PutLifecycleHookOutput, SdkError<PutLifecycleHookError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<PutLifecycleHookOutput, SdkError<PutLifecycleHookError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for PutLifecycleHookInputBuilder
impl Clone for PutLifecycleHookInputBuilder
Source§fn clone(&self) -> PutLifecycleHookInputBuilder
fn clone(&self) -> PutLifecycleHookInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PutLifecycleHookInputBuilder
impl Debug for PutLifecycleHookInputBuilder
Source§impl Default for PutLifecycleHookInputBuilder
impl Default for PutLifecycleHookInputBuilder
Source§fn default() -> PutLifecycleHookInputBuilder
fn default() -> PutLifecycleHookInputBuilder
Source§impl PartialEq for PutLifecycleHookInputBuilder
impl PartialEq for PutLifecycleHookInputBuilder
Source§fn eq(&self, other: &PutLifecycleHookInputBuilder) -> bool
fn eq(&self, other: &PutLifecycleHookInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for PutLifecycleHookInputBuilder
Auto Trait Implementations§
impl Freeze for PutLifecycleHookInputBuilder
impl RefUnwindSafe for PutLifecycleHookInputBuilder
impl Send for PutLifecycleHookInputBuilder
impl Sync for PutLifecycleHookInputBuilder
impl Unpin for PutLifecycleHookInputBuilder
impl UnwindSafe for PutLifecycleHookInputBuilder
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);