AWSAutoScalingPutLifecycleHookType
Objective-C
@interface AWSAutoScalingPutLifecycleHookType
Swift
class AWSAutoScalingPutLifecycleHookType
-
The name of the Auto Scaling group.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable autoScalingGroupName;
Swift
var autoScalingGroupName: String? { get set }
-
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
orABANDON
. The default value isABANDON
.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable defaultResult;
Swift
var defaultResult: String? { get set }
-
The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30
to7200
seconds. The default value is3600
seconds (1 hour).If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the
DefaultResult
parameter. You can prevent the lifecycle hook from timing out by calling the RecordLifecycleActionHeartbeat API.Declaration
Objective-C
@property (nonatomic, strong) NSNumber *_Nullable heartbeatTimeout;
Swift
var heartbeatTimeout: NSNumber? { get set }
-
The name of the lifecycle hook.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable lifecycleHookName;
Swift
var lifecycleHookName: String? { get set }
-
The instance state to which you want to attach the lifecycle hook. The valid values are:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
Required for new lifecycle hooks, but optional when updating existing hooks.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable lifecycleTransition;
Swift
var lifecycleTransition: String? { get set }
-
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable notificationMetadata;
Swift
var notificationMetadata: String? { get set }
-
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"
.Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable notificationTargetARN;
Swift
var notificationTargetARN: String? { get set }
-
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. Required for new lifecycle hooks, but optional when updating existing hooks.
Declaration
Objective-C
@property (nonatomic, strong) NSString *_Nullable roleARN;
Swift
var roleARN: String? { get set }