/** * 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 AutoScaling { namespace Model { /** */ class AWS_AUTOSCALING_API PutLifecycleHookRequest : public AutoScalingRequest { public: PutLifecycleHookRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "PutLifecycleHook"; } Aws::String SerializePayload() const override; protected: void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

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 PutLifecycleHookRequest& WithLifecycleHookName(const Aws::String& value) { SetLifecycleHookName(value); return *this;} /** *

The name of the lifecycle hook.

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

The name of the lifecycle hook.

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

The name of the Auto Scaling group.

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

The name of the Auto Scaling group.

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

The name of the Auto Scaling group.

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

The name of the Auto Scaling group.

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

The name of the Auto Scaling group.

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

The name of the Auto Scaling group.

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

The name of the Auto Scaling group.

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

The name of the Auto Scaling group.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

The ARN of the IAM role that allows the Auto Scaling group to publish to the * specified notification target, for example, an Amazon SNS topic or an Amazon SQS * queue.

Required for new lifecycle hooks, but optional when updating * existing hooks.

*/ 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, for example, an Amazon SNS topic or an Amazon SQS * queue.

Required for new lifecycle hooks, but optional when updating * existing hooks.

*/ 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, for example, an Amazon SNS topic or an Amazon SQS * queue.

Required for new lifecycle hooks, but optional when updating * existing hooks.

*/ 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, for example, an Amazon SNS topic or an Amazon SQS * queue.

Required for new lifecycle hooks, but optional when updating * existing hooks.

*/ 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, for example, an Amazon SNS topic or an Amazon SQS * queue.

Required for new lifecycle hooks, but optional when updating * existing hooks.

*/ 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, for example, an Amazon SNS topic or an Amazon SQS * queue.

Required for new lifecycle hooks, but optional when updating * existing hooks.

*/ inline PutLifecycleHookRequest& 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, for example, an Amazon SNS topic or an Amazon SQS * queue.

Required for new lifecycle hooks, but optional when updating * existing hooks.

*/ inline PutLifecycleHookRequest& 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, for example, an Amazon SNS topic or an Amazon SQS * queue.

Required for new lifecycle hooks, but optional when updating * existing hooks.

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

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

*/ inline const Aws::String& GetNotificationTargetARN() const{ return m_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".

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

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

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

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

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

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

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

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

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

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

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

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

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

Additional information that you want to include 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 you want to include any time Amazon EC2 Auto * Scaling sends a message to the notification target.

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

Additional information that you want to include 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 you want to include 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 you want to include 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 you want to include any time Amazon EC2 Auto * Scaling sends a message to the notification target.

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

Additional information that you want to include any time Amazon EC2 Auto * Scaling sends a message to the notification target.

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

Additional information that you want to include any time Amazon EC2 Auto * Scaling sends a message to the notification target.

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

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

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.

*/ inline int GetHeartbeatTimeout() const{ return m_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 * value is 3600 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.

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

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

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.

*/ 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. The range is from 30 to 7200 seconds. The default * value is 3600 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.

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

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.

*/ inline const Aws::String& GetDefaultResult() const{ return m_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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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