pub struct LifecycleHookSpecification {
pub default_result: Option<String>,
pub heartbeat_timeout: Option<i64>,
pub lifecycle_hook_name: String,
pub lifecycle_transition: String,
pub notification_metadata: Option<String>,
pub notification_target_arn: Option<String>,
pub role_arn: Option<String>,
}
Expand description
Describes information used to specify a lifecycle hook for an Auto Scaling group.
A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).
This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:
-
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
-
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
-
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
-
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
-
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
Fields
default_result: Option<String>
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE
and ABANDON
. The default value is ABANDON
.
heartbeat_timeout: Option<i64>
The maximum time, in seconds, that can elapse before the lifecycle hook times out.
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult
parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
lifecycle_hook_name: String
The name of the lifecycle hook.
lifecycle_transition: String
The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:
-
autoscaling:EC2INSTANCELAUNCHING
-
autoscaling:EC2INSTANCETERMINATING
notification_metadata: Option<String>
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
notification_target_arn: Option<String>
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
role_arn: Option<String>
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
Trait Implementations
sourceimpl Clone for LifecycleHookSpecification
impl Clone for LifecycleHookSpecification
sourcefn clone(&self) -> LifecycleHookSpecification
fn clone(&self) -> LifecycleHookSpecification
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for LifecycleHookSpecification
impl Debug for LifecycleHookSpecification
sourceimpl Default for LifecycleHookSpecification
impl Default for LifecycleHookSpecification
sourcefn default() -> LifecycleHookSpecification
fn default() -> LifecycleHookSpecification
Returns the “default value” for a type. Read more
sourceimpl PartialEq<LifecycleHookSpecification> for LifecycleHookSpecification
impl PartialEq<LifecycleHookSpecification> for LifecycleHookSpecification
sourcefn eq(&self, other: &LifecycleHookSpecification) -> bool
fn eq(&self, other: &LifecycleHookSpecification) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &LifecycleHookSpecification) -> bool
fn ne(&self, other: &LifecycleHookSpecification) -> bool
This method tests for !=
.
impl StructuralPartialEq for LifecycleHookSpecification
Auto Trait Implementations
impl RefUnwindSafe for LifecycleHookSpecification
impl Send for LifecycleHookSpecification
impl Sync for LifecycleHookSpecification
impl Unpin for LifecycleHookSpecification
impl UnwindSafe for LifecycleHookSpecification
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more