AWSAutoScalingLifecycleHook

Objective-C

@interface AWSAutoScalingLifecycleHook

Swift

class AWSAutoScalingLifecycleHook

Describes a lifecycle hook. A lifecycle hook lets you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

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

    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. The possible values are CONTINUE and ABANDON.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable defaultResult;

    Swift

    var defaultResult: String? { get set }

  • The maximum time, in seconds, that an instance can remain in a wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable globalTimeout;

    Swift

    var globalTimeout: NSNumber? { get set }

  • The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.

    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 state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

    • autoscaling:EC2_INSTANCE_LAUNCHING

    • autoscaling:EC2_INSTANCE_TERMINATING

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable lifecycleTransition;

    Swift

    var lifecycleTransition: String? { get set }

  • Additional information that is included 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 target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

    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 (an Amazon SNS topic or an Amazon SQS queue).

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable roleARN;

    Swift

    var roleARN: String? { get set }