AWSAutoScalingLifecycleHook Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSAutoScalingModel.h
AWSAutoScalingModel.m

Overview

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:

  • Pause the instance after it launches, but before it is put into service

  • Pause the instance as it terminates, but before it is fully terminated

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

  autoScalingGroupName

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

@property (nonatomic, strong) NSString *autoScalingGroupName

Declared In

AWSAutoScalingModel.h

  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.

@property (nonatomic, strong) NSString *defaultResult

Declared In

AWSAutoScalingModel.h

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

@property (nonatomic, strong) NSNumber *globalTimeout

Declared In

AWSAutoScalingModel.h

  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.

@property (nonatomic, strong) NSNumber *heartbeatTimeout

Declared In

AWSAutoScalingModel.h

  lifecycleHookName

The name of the lifecycle hook.

@property (nonatomic, strong) NSString *lifecycleHookName

Declared In

AWSAutoScalingModel.h

  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.

@property (nonatomic, strong) NSString *lifecycleTransition

Declared In

AWSAutoScalingModel.h

  notificationMetadata

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

@property (nonatomic, strong) NSString *notificationMetadata

Declared In

AWSAutoScalingModel.h

  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

@property (nonatomic, strong) NSString *notificationTargetARN

Declared In

AWSAutoScalingModel.h

  roleARN

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

@property (nonatomic, strong) NSString *roleARN

Declared In

AWSAutoScalingModel.h