Struct LifecycleHook 

#[non_exhaustive]
pub struct LifecycleHook {
    pub lifecycle_hook_name: Option<String>,
    pub auto_scaling_group_name: Option<String>,
    pub lifecycle_transition: Option<String>,
    pub notification_target_arn: Option<String>,
    pub role_arn: Option<String>,
    pub notification_metadata: Option<String>,
    pub heartbeat_timeout: Option<i32>,
    pub global_timeout: Option<i32>,
    pub default_result: Option<String>,
}

Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

lifecycle_hook_name: Option<String>

The name of the lifecycle hook.

auto_scaling_group_name: Option<String>

The name of the Auto Scaling group for the lifecycle hook.

lifecycle_transition: Option<String>

The lifecycle transition.

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

notification_target_arn: Option<String>

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

role_arn: Option<String>

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target (an Amazon SNS topic or an Amazon SQS queue).

notification_metadata: Option<String>

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

heartbeat_timeout: Option<i32>

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 property.

global_timeout: Option<i32>

The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

default_result: Option<String>

The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs.

Valid values: CONTINUE | ABANDON

Implementations

impl LifecycleHook

pub fn lifecycle_hook_name(&self) -> Option<&str>

The name of the lifecycle hook.

pub fn auto_scaling_group_name(&self) -> Option<&str>

The name of the Auto Scaling group for the lifecycle hook.

pub fn lifecycle_transition(&self) -> Option<&str>

The lifecycle transition.

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

pub fn notification_target_arn(&self) -> Option<&str>

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook.

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 (an Amazon SNS topic or an Amazon SQS queue).

pub fn notification_metadata(&self) -> Option<&str>

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

pub fn heartbeat_timeout(&self) -> Option<i32>

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 property.

pub fn global_timeout(&self) -> Option<i32>

The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

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.

Valid values: CONTINUE | ABANDON

impl LifecycleHook

pub fn builder() -> LifecycleHookBuilder

Creates a new builder-style object to manufacture LifecycleHook.

Trait Implementations

impl Clone for LifecycleHook

fn clone(&self) -> LifecycleHook

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LifecycleHook

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LifecycleHook

fn eq(&self, other: &LifecycleHook) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LifecycleHook