AWSAutoScalingLifecycleHookSpecification

Objective-C

@interface AWSAutoScalingLifecycleHookSpecification

Swift

class AWSAutoScalingLifecycleHookSpecification

Describes information used to specify a lifecycle hook for an Auto Scaling group.

For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.

Required parameters: [LifecycleHookName, LifecycleTransition]

  • The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ABANDON.

    Valid values: CONTINUE | ABANDON

    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 to 7200 seconds. The default value is 3600 seconds (1 hour).

    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 lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.

    • To create a lifecycle hook for scale-out events, specify autoscaling:EC2_INSTANCE_LAUNCHING.

    • To create a lifecycle hook for scale-in events, specify autoscaling:EC2_INSTANCE_TERMINATING.

    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 Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.

    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. For information about creating this role, see Prepare to add a lifecycle hook to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

    Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.

    Declaration

    Objective-C

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

    Swift

    var roleARN: String? { get set }