AWS SDK Version 2 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.

.NET Framework 4.5
 
Describes a lifecycle hook, which tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:

For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.AutoScaling.Model.LifecycleHook

Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class LifecycleHook : Object

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.

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

Public Property GlobalTimeout System.Int32 Gets and sets the property GlobalTimeout.

The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The default is 172800 seconds (48 hours).

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. The default is 3600 seconds (1 hour). When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

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 state of the EC2 instance to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see DescribeLifecycleHookTypes.

Public Property NotificationMetadata System.String Gets and sets the property NotificationMetadata.

Additional information that you want to include any time Auto Scaling sends a message to the notification target.

Public Property NotificationTargetARN System.String Gets and sets the property NotificationTargetARN.

The ARN of the notification target that Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. The notification message sent to the target includes the following:

  • Lifecycle action token
  • User account ID
  • Name of the Auto Scaling group
  • Lifecycle hook name
  • EC2 instance ID
  • Lifecycle transition
  • Notification metadata
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.

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8