#[non_exhaustive]pub struct LifecycleHookSpecification { /* private fields */ }Expand description
Describes information used to specify a lifecycle hook for an Auto Scaling group.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
Implementations§
source§impl LifecycleHookSpecification
impl LifecycleHookSpecification
sourcepub fn lifecycle_hook_name(&self) -> Option<&str>
pub fn lifecycle_hook_name(&self) -> Option<&str>
The name of the lifecycle hook.
sourcepub fn lifecycle_transition(&self) -> Option<&str>
pub fn lifecycle_transition(&self) -> Option<&str>
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.
sourcepub fn notification_metadata(&self) -> Option<&str>
pub fn notification_metadata(&self) -> Option<&str>
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) -> Option<i32>
pub fn 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) -> Option<&str>
pub fn default_result(&self) -> Option<&str>
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 notification_target_arn(&self) -> Option<&str>
pub fn notification_target_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
source§impl LifecycleHookSpecification
impl LifecycleHookSpecification
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture LifecycleHookSpecification.
Trait Implementations§
source§impl Clone for LifecycleHookSpecification
impl Clone for LifecycleHookSpecification
source§fn clone(&self) -> LifecycleHookSpecification
fn clone(&self) -> LifecycleHookSpecification
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more