AWSAutoScalingPutLifecycleHookType Class Reference

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

  autoScalingGroupName

The name of the Auto Scaling group.

@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 maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 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 instance state to which you want to attach the lifecycle hook. The possible values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

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 Amazon EC2 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 Amazon EC2 Auto Scaling uses 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.

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, Amazon EC2 Auto Scaling sends it a test message. Test messages contain 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