/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace AutoScaling { namespace Model { /** *

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.

See Also:

AWS * API Reference

*/ class LifecycleHook { public: AWS_AUTOSCALING_API LifecycleHook(); AWS_AUTOSCALING_API LifecycleHook(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_AUTOSCALING_API LifecycleHook& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_AUTOSCALING_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_AUTOSCALING_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

The name of the lifecycle hook.

*/ inline const Aws::String& GetLifecycleHookName() const{ return m_lifecycleHookName; } /** *

The name of the lifecycle hook.

*/ inline bool LifecycleHookNameHasBeenSet() const { return m_lifecycleHookNameHasBeenSet; } /** *

The name of the lifecycle hook.

*/ inline void SetLifecycleHookName(const Aws::String& value) { m_lifecycleHookNameHasBeenSet = true; m_lifecycleHookName = value; } /** *

The name of the lifecycle hook.

*/ inline void SetLifecycleHookName(Aws::String&& value) { m_lifecycleHookNameHasBeenSet = true; m_lifecycleHookName = std::move(value); } /** *

The name of the lifecycle hook.

*/ inline void SetLifecycleHookName(const char* value) { m_lifecycleHookNameHasBeenSet = true; m_lifecycleHookName.assign(value); } /** *

The name of the lifecycle hook.

*/ inline LifecycleHook& WithLifecycleHookName(const Aws::String& value) { SetLifecycleHookName(value); return *this;} /** *

The name of the lifecycle hook.

*/ inline LifecycleHook& WithLifecycleHookName(Aws::String&& value) { SetLifecycleHookName(std::move(value)); return *this;} /** *

The name of the lifecycle hook.

*/ inline LifecycleHook& WithLifecycleHookName(const char* value) { SetLifecycleHookName(value); return *this;} /** *

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

*/ inline const Aws::String& GetAutoScalingGroupName() const{ return m_autoScalingGroupName; } /** *

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

*/ inline bool AutoScalingGroupNameHasBeenSet() const { return m_autoScalingGroupNameHasBeenSet; } /** *

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

*/ inline void SetAutoScalingGroupName(const Aws::String& value) { m_autoScalingGroupNameHasBeenSet = true; m_autoScalingGroupName = value; } /** *

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

*/ inline void SetAutoScalingGroupName(Aws::String&& value) { m_autoScalingGroupNameHasBeenSet = true; m_autoScalingGroupName = std::move(value); } /** *

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

*/ inline void SetAutoScalingGroupName(const char* value) { m_autoScalingGroupNameHasBeenSet = true; m_autoScalingGroupName.assign(value); } /** *

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

*/ inline LifecycleHook& WithAutoScalingGroupName(const Aws::String& value) { SetAutoScalingGroupName(value); return *this;} /** *

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

*/ inline LifecycleHook& WithAutoScalingGroupName(Aws::String&& value) { SetAutoScalingGroupName(std::move(value)); return *this;} /** *

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

*/ inline LifecycleHook& WithAutoScalingGroupName(const char* value) { SetAutoScalingGroupName(value); return *this;} /** *

The lifecycle transition.

Valid values: * autoscaling:EC2_INSTANCE_LAUNCHING | * autoscaling:EC2_INSTANCE_TERMINATING

*/ inline const Aws::String& GetLifecycleTransition() const{ return m_lifecycleTransition; } /** *

The lifecycle transition.

Valid values: * autoscaling:EC2_INSTANCE_LAUNCHING | * autoscaling:EC2_INSTANCE_TERMINATING

*/ inline bool LifecycleTransitionHasBeenSet() const { return m_lifecycleTransitionHasBeenSet; } /** *

The lifecycle transition.

Valid values: * autoscaling:EC2_INSTANCE_LAUNCHING | * autoscaling:EC2_INSTANCE_TERMINATING

*/ inline void SetLifecycleTransition(const Aws::String& value) { m_lifecycleTransitionHasBeenSet = true; m_lifecycleTransition = value; } /** *

The lifecycle transition.

Valid values: * autoscaling:EC2_INSTANCE_LAUNCHING | * autoscaling:EC2_INSTANCE_TERMINATING

*/ inline void SetLifecycleTransition(Aws::String&& value) { m_lifecycleTransitionHasBeenSet = true; m_lifecycleTransition = std::move(value); } /** *

The lifecycle transition.

Valid values: * autoscaling:EC2_INSTANCE_LAUNCHING | * autoscaling:EC2_INSTANCE_TERMINATING

*/ inline void SetLifecycleTransition(const char* value) { m_lifecycleTransitionHasBeenSet = true; m_lifecycleTransition.assign(value); } /** *

The lifecycle transition.

Valid values: * autoscaling:EC2_INSTANCE_LAUNCHING | * autoscaling:EC2_INSTANCE_TERMINATING

*/ inline LifecycleHook& WithLifecycleTransition(const Aws::String& value) { SetLifecycleTransition(value); return *this;} /** *

The lifecycle transition.

Valid values: * autoscaling:EC2_INSTANCE_LAUNCHING | * autoscaling:EC2_INSTANCE_TERMINATING

*/ inline LifecycleHook& WithLifecycleTransition(Aws::String&& value) { SetLifecycleTransition(std::move(value)); return *this;} /** *

The lifecycle transition.

Valid values: * autoscaling:EC2_INSTANCE_LAUNCHING | * autoscaling:EC2_INSTANCE_TERMINATING

*/ inline LifecycleHook& WithLifecycleTransition(const char* value) { SetLifecycleTransition(value); return *this;} /** *

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to * when an instance is in a wait state for the lifecycle hook.

*/ inline const Aws::String& GetNotificationTargetARN() const{ return m_notificationTargetARN; } /** *

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to * when an instance is in a wait state for the lifecycle hook.

*/ inline bool NotificationTargetARNHasBeenSet() const { return m_notificationTargetARNHasBeenSet; } /** *

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to * when an instance is in a wait state for the lifecycle hook.

*/ inline void SetNotificationTargetARN(const Aws::String& value) { m_notificationTargetARNHasBeenSet = true; m_notificationTargetARN = value; } /** *

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to * when an instance is in a wait state for the lifecycle hook.

*/ inline void SetNotificationTargetARN(Aws::String&& value) { m_notificationTargetARNHasBeenSet = true; m_notificationTargetARN = std::move(value); } /** *

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to * when an instance is in a wait state for the lifecycle hook.

*/ inline void SetNotificationTargetARN(const char* value) { m_notificationTargetARNHasBeenSet = true; m_notificationTargetARN.assign(value); } /** *

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to * when an instance is in a wait state for the lifecycle hook.

*/ inline LifecycleHook& WithNotificationTargetARN(const Aws::String& value) { SetNotificationTargetARN(value); return *this;} /** *

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to * when an instance is in a wait state for the lifecycle hook.

*/ inline LifecycleHook& WithNotificationTargetARN(Aws::String&& value) { SetNotificationTargetARN(std::move(value)); return *this;} /** *

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to * when an instance is in a wait state for the lifecycle hook.

*/ inline LifecycleHook& WithNotificationTargetARN(const char* value) { SetNotificationTargetARN(value); return *this;} /** *

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

*/ inline const Aws::String& GetRoleARN() const{ return m_roleARN; } /** *

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

*/ inline bool RoleARNHasBeenSet() const { return m_roleARNHasBeenSet; } /** *

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

*/ inline void SetRoleARN(const Aws::String& value) { m_roleARNHasBeenSet = true; m_roleARN = value; } /** *

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

*/ inline void SetRoleARN(Aws::String&& value) { m_roleARNHasBeenSet = true; m_roleARN = std::move(value); } /** *

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

*/ inline void SetRoleARN(const char* value) { m_roleARNHasBeenSet = true; m_roleARN.assign(value); } /** *

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

*/ inline LifecycleHook& WithRoleARN(const Aws::String& value) { SetRoleARN(value); return *this;} /** *

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

*/ inline LifecycleHook& WithRoleARN(Aws::String&& value) { SetRoleARN(std::move(value)); return *this;} /** *

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

*/ inline LifecycleHook& WithRoleARN(const char* value) { SetRoleARN(value); return *this;} /** *

Additional information that is included any time Amazon EC2 Auto Scaling * sends a message to the notification target.

*/ inline const Aws::String& GetNotificationMetadata() const{ return m_notificationMetadata; } /** *

Additional information that is included any time Amazon EC2 Auto Scaling * sends a message to the notification target.

*/ inline bool NotificationMetadataHasBeenSet() const { return m_notificationMetadataHasBeenSet; } /** *

Additional information that is included any time Amazon EC2 Auto Scaling * sends a message to the notification target.

*/ inline void SetNotificationMetadata(const Aws::String& value) { m_notificationMetadataHasBeenSet = true; m_notificationMetadata = value; } /** *

Additional information that is included any time Amazon EC2 Auto Scaling * sends a message to the notification target.

*/ inline void SetNotificationMetadata(Aws::String&& value) { m_notificationMetadataHasBeenSet = true; m_notificationMetadata = std::move(value); } /** *

Additional information that is included any time Amazon EC2 Auto Scaling * sends a message to the notification target.

*/ inline void SetNotificationMetadata(const char* value) { m_notificationMetadataHasBeenSet = true; m_notificationMetadata.assign(value); } /** *

Additional information that is included any time Amazon EC2 Auto Scaling * sends a message to the notification target.

*/ inline LifecycleHook& WithNotificationMetadata(const Aws::String& value) { SetNotificationMetadata(value); return *this;} /** *

Additional information that is included any time Amazon EC2 Auto Scaling * sends a message to the notification target.

*/ inline LifecycleHook& WithNotificationMetadata(Aws::String&& value) { SetNotificationMetadata(std::move(value)); return *this;} /** *

Additional information that is included any time Amazon EC2 Auto Scaling * sends a message to the notification target.

*/ inline LifecycleHook& WithNotificationMetadata(const char* value) { SetNotificationMetadata(value); return *this;} /** *

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

*/ inline int GetHeartbeatTimeout() const{ return m_heartbeatTimeout; } /** *

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

*/ inline bool HeartbeatTimeoutHasBeenSet() const { return m_heartbeatTimeoutHasBeenSet; } /** *

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

*/ inline void SetHeartbeatTimeout(int value) { m_heartbeatTimeoutHasBeenSet = true; m_heartbeatTimeout = value; } /** *

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

*/ inline LifecycleHook& WithHeartbeatTimeout(int value) { SetHeartbeatTimeout(value); return *this;} /** *

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.

*/ inline int GetGlobalTimeout() const{ return m_globalTimeout; } /** *

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.

*/ inline bool GlobalTimeoutHasBeenSet() const { return m_globalTimeoutHasBeenSet; } /** *

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.

*/ inline void SetGlobalTimeout(int value) { m_globalTimeoutHasBeenSet = true; m_globalTimeout = value; } /** *

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.

*/ inline LifecycleHook& WithGlobalTimeout(int value) { SetGlobalTimeout(value); return *this;} /** *

The action the Auto Scaling group takes when the lifecycle hook timeout * elapses or if an unexpected failure occurs.

Valid values: * CONTINUE | ABANDON

*/ inline const Aws::String& GetDefaultResult() const{ return m_defaultResult; } /** *

The action the Auto Scaling group takes when the lifecycle hook timeout * elapses or if an unexpected failure occurs.

Valid values: * CONTINUE | ABANDON

*/ inline bool DefaultResultHasBeenSet() const { return m_defaultResultHasBeenSet; } /** *

The action the Auto Scaling group takes when the lifecycle hook timeout * elapses or if an unexpected failure occurs.

Valid values: * CONTINUE | ABANDON

*/ inline void SetDefaultResult(const Aws::String& value) { m_defaultResultHasBeenSet = true; m_defaultResult = value; } /** *

The action the Auto Scaling group takes when the lifecycle hook timeout * elapses or if an unexpected failure occurs.

Valid values: * CONTINUE | ABANDON

*/ inline void SetDefaultResult(Aws::String&& value) { m_defaultResultHasBeenSet = true; m_defaultResult = std::move(value); } /** *

The action the Auto Scaling group takes when the lifecycle hook timeout * elapses or if an unexpected failure occurs.

Valid values: * CONTINUE | ABANDON

*/ inline void SetDefaultResult(const char* value) { m_defaultResultHasBeenSet = true; m_defaultResult.assign(value); } /** *

The action the Auto Scaling group takes when the lifecycle hook timeout * elapses or if an unexpected failure occurs.

Valid values: * CONTINUE | ABANDON

*/ inline LifecycleHook& WithDefaultResult(const Aws::String& value) { SetDefaultResult(value); return *this;} /** *

The action the Auto Scaling group takes when the lifecycle hook timeout * elapses or if an unexpected failure occurs.

Valid values: * CONTINUE | ABANDON

*/ inline LifecycleHook& WithDefaultResult(Aws::String&& value) { SetDefaultResult(std::move(value)); return *this;} /** *

The action the Auto Scaling group takes when the lifecycle hook timeout * elapses or if an unexpected failure occurs.

Valid values: * CONTINUE | ABANDON

*/ inline LifecycleHook& WithDefaultResult(const char* value) { SetDefaultResult(value); return *this;} private: Aws::String m_lifecycleHookName; bool m_lifecycleHookNameHasBeenSet = false; Aws::String m_autoScalingGroupName; bool m_autoScalingGroupNameHasBeenSet = false; Aws::String m_lifecycleTransition; bool m_lifecycleTransitionHasBeenSet = false; Aws::String m_notificationTargetARN; bool m_notificationTargetARNHasBeenSet = false; Aws::String m_roleARN; bool m_roleARNHasBeenSet = false; Aws::String m_notificationMetadata; bool m_notificationMetadataHasBeenSet = false; int m_heartbeatTimeout; bool m_heartbeatTimeoutHasBeenSet = false; int m_globalTimeout; bool m_globalTimeoutHasBeenSet = false; Aws::String m_defaultResult; bool m_defaultResultHasBeenSet = false; }; } // namespace Model } // namespace AutoScaling } // namespace Aws