[−][src]Struct rusoto_autoscaling::LifecycleHookSpecification
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
impl Clone for LifecycleHookSpecification
[src]
pub fn clone(&self) -> LifecycleHookSpecification
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for LifecycleHookSpecification
[src]
impl Default for LifecycleHookSpecification
[src]
pub fn default() -> LifecycleHookSpecification
[src]
impl PartialEq<LifecycleHookSpecification> for LifecycleHookSpecification
[src]
pub fn eq(&self, other: &LifecycleHookSpecification) -> bool
[src]
pub fn ne(&self, other: &LifecycleHookSpecification) -> bool
[src]
impl StructuralPartialEq for LifecycleHookSpecification
[src]
Auto Trait Implementations
impl RefUnwindSafe for LifecycleHookSpecification
[src]
impl Send for LifecycleHookSpecification
[src]
impl Sync for LifecycleHookSpecification
[src]
impl Unpin for LifecycleHookSpecification
[src]
impl UnwindSafe for LifecycleHookSpecification
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,