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

Inheritance Hierarchy

System.Object
  Amazon.AutoScaling.Model.LifecycleHookSpecification

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

Syntax

C#
public class LifecycleHookSpecification

The LifecycleHookSpecification type exposes the following members

Constructors

Properties

NameTypeDescription
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. The default value is ABANDON.

Valid values: CONTINUE | ABANDON

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 range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

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

Public Property NotificationMetadata System.String

Gets and sets the property NotificationMetadata.

Additional information that you want to include 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 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.

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

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