AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.AutoScaling.Model.LifecycleHook

Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

C#
public class LifecycleHook

The LifecycleHook type exposes the following members

Constructors

NameDescription
Public Method LifecycleHook()

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

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

Public Property DefaultResult System.String

Gets and sets the property DefaultResult.

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

Valid values: CONTINUE | ABANDON

Public Property GlobalTimeout System.Int32

Gets and sets the property GlobalTimeout.

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.

Public Property HeartbeatTimeout System.Int32

Gets and sets the property HeartbeatTimeout.

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.

Public Property LifecycleHookName System.String

Gets and sets the property LifecycleHookName.

The name of the lifecycle hook.

Public Property LifecycleTransition System.String

Gets and sets the property LifecycleTransition.

The lifecycle transition.

Valid values: autoscaling:EC2_INSTANCE_LAUNCHING | autoscaling:EC2_INSTANCE_TERMINATING

Public Property NotificationMetadata System.String

Gets and sets the property NotificationMetadata.

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

Public Property NotificationTargetARN System.String

Gets and sets the property NotificationTargetARN.

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.

Public Property RoleARN System.String

Gets and sets the property RoleARN.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5