AWSAutoScalingPutLifecycleHookType Class Reference

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

Overview

Contains the parameters for PutLifecycleHook.

Required parameters: [LifecycleHookName, AutoScalingGroupName]

  autoScalingGroupName

The name of the Auto Scaling group to which you want to assign 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. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

@property (nonatomic, strong) NSString *defaultResult

Declared In

AWSAutoScalingModel.h

  heartbeatTimeout

The amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).

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

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

@property (nonatomic, strong) NSString *lifecycleTransition

Declared In

AWSAutoScalingModel.h

  notificationMetadata

Contains 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 will use to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.

The notification messages sent to the target include the following information:

  • AutoScalingGroupName. The name of the Auto Scaling group.

  • AccountId. The AWS account ID.

  • LifecycleTransition. The lifecycle hook type.

  • LifecycleActionToken. The lifecycle action token.

  • EC2InstanceId. The EC2 instance ID.

  • LifecycleHookName. The name of the lifecycle hook.

  • NotificationMetadata. User-defined information.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: "Event": "autoscaling:TEST_NOTIFICATION".

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

This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

@property (nonatomic, strong) NSString *roleARN

Declared In

AWSAutoScalingModel.h