787 lines
40 KiB
C++
787 lines
40 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/autoscaling/AutoScaling_EXPORTS.h>
|
|
#include <aws/autoscaling/AutoScalingRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/autoscaling/model/TargetTrackingConfiguration.h>
|
|
#include <aws/autoscaling/model/StepAdjustment.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace AutoScaling
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_AUTOSCALING_API PutScalingPolicyRequest : public AutoScalingRequest
|
|
{
|
|
public:
|
|
PutScalingPolicyRequest();
|
|
|
|
// 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 "PutScalingPolicy"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
protected:
|
|
void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
|
|
|
|
public:
|
|
|
|
/**
|
|
* <p>The name of the Auto Scaling group.</p>
|
|
*/
|
|
inline const Aws::String& GetAutoScalingGroupName() const{ return m_autoScalingGroupName; }
|
|
|
|
/**
|
|
* <p>The name of the Auto Scaling group.</p>
|
|
*/
|
|
inline bool AutoScalingGroupNameHasBeenSet() const { return m_autoScalingGroupNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the Auto Scaling group.</p>
|
|
*/
|
|
inline void SetAutoScalingGroupName(const Aws::String& value) { m_autoScalingGroupNameHasBeenSet = true; m_autoScalingGroupName = value; }
|
|
|
|
/**
|
|
* <p>The name of the Auto Scaling group.</p>
|
|
*/
|
|
inline void SetAutoScalingGroupName(Aws::String&& value) { m_autoScalingGroupNameHasBeenSet = true; m_autoScalingGroupName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the Auto Scaling group.</p>
|
|
*/
|
|
inline void SetAutoScalingGroupName(const char* value) { m_autoScalingGroupNameHasBeenSet = true; m_autoScalingGroupName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the Auto Scaling group.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithAutoScalingGroupName(const Aws::String& value) { SetAutoScalingGroupName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the Auto Scaling group.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithAutoScalingGroupName(Aws::String&& value) { SetAutoScalingGroupName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the Auto Scaling group.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithAutoScalingGroupName(const char* value) { SetAutoScalingGroupName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The name of the policy.</p>
|
|
*/
|
|
inline const Aws::String& GetPolicyName() const{ return m_policyName; }
|
|
|
|
/**
|
|
* <p>The name of the policy.</p>
|
|
*/
|
|
inline bool PolicyNameHasBeenSet() const { return m_policyNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the policy.</p>
|
|
*/
|
|
inline void SetPolicyName(const Aws::String& value) { m_policyNameHasBeenSet = true; m_policyName = value; }
|
|
|
|
/**
|
|
* <p>The name of the policy.</p>
|
|
*/
|
|
inline void SetPolicyName(Aws::String&& value) { m_policyNameHasBeenSet = true; m_policyName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the policy.</p>
|
|
*/
|
|
inline void SetPolicyName(const char* value) { m_policyNameHasBeenSet = true; m_policyName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the policy.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithPolicyName(const Aws::String& value) { SetPolicyName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the policy.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithPolicyName(Aws::String&& value) { SetPolicyName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the policy.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithPolicyName(const char* value) { SetPolicyName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>One of the following policy types: </p> <ul> <li> <p>
|
|
* <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code>
|
|
* </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>
|
|
*/
|
|
inline const Aws::String& GetPolicyType() const{ return m_policyType; }
|
|
|
|
/**
|
|
* <p>One of the following policy types: </p> <ul> <li> <p>
|
|
* <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code>
|
|
* </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>
|
|
*/
|
|
inline bool PolicyTypeHasBeenSet() const { return m_policyTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>One of the following policy types: </p> <ul> <li> <p>
|
|
* <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code>
|
|
* </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>
|
|
*/
|
|
inline void SetPolicyType(const Aws::String& value) { m_policyTypeHasBeenSet = true; m_policyType = value; }
|
|
|
|
/**
|
|
* <p>One of the following policy types: </p> <ul> <li> <p>
|
|
* <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code>
|
|
* </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>
|
|
*/
|
|
inline void SetPolicyType(Aws::String&& value) { m_policyTypeHasBeenSet = true; m_policyType = std::move(value); }
|
|
|
|
/**
|
|
* <p>One of the following policy types: </p> <ul> <li> <p>
|
|
* <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code>
|
|
* </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>
|
|
*/
|
|
inline void SetPolicyType(const char* value) { m_policyTypeHasBeenSet = true; m_policyType.assign(value); }
|
|
|
|
/**
|
|
* <p>One of the following policy types: </p> <ul> <li> <p>
|
|
* <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code>
|
|
* </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithPolicyType(const Aws::String& value) { SetPolicyType(value); return *this;}
|
|
|
|
/**
|
|
* <p>One of the following policy types: </p> <ul> <li> <p>
|
|
* <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code>
|
|
* </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithPolicyType(Aws::String&& value) { SetPolicyType(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>One of the following policy types: </p> <ul> <li> <p>
|
|
* <code>TargetTrackingScaling</code> </p> </li> <li> <p> <code>StepScaling</code>
|
|
* </p> </li> <li> <p> <code>SimpleScaling</code> (default)</p> </li> </ul>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithPolicyType(const char* value) { SetPolicyType(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute
|
|
* number or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
* <p>Required if the policy type is <code>StepScaling</code> or
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
*/
|
|
inline const Aws::String& GetAdjustmentType() const{ return m_adjustmentType; }
|
|
|
|
/**
|
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute
|
|
* number or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
* <p>Required if the policy type is <code>StepScaling</code> or
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
*/
|
|
inline bool AdjustmentTypeHasBeenSet() const { return m_adjustmentTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute
|
|
* number or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
* <p>Required if the policy type is <code>StepScaling</code> or
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
*/
|
|
inline void SetAdjustmentType(const Aws::String& value) { m_adjustmentTypeHasBeenSet = true; m_adjustmentType = value; }
|
|
|
|
/**
|
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute
|
|
* number or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
* <p>Required if the policy type is <code>StepScaling</code> or
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
*/
|
|
inline void SetAdjustmentType(Aws::String&& value) { m_adjustmentTypeHasBeenSet = true; m_adjustmentType = std::move(value); }
|
|
|
|
/**
|
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute
|
|
* number or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
* <p>Required if the policy type is <code>StepScaling</code> or
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
*/
|
|
inline void SetAdjustmentType(const char* value) { m_adjustmentTypeHasBeenSet = true; m_adjustmentType.assign(value); }
|
|
|
|
/**
|
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute
|
|
* number or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
* <p>Required if the policy type is <code>StepScaling</code> or
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithAdjustmentType(const Aws::String& value) { SetAdjustmentType(value); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute
|
|
* number or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
* <p>Required if the policy type is <code>StepScaling</code> or
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithAdjustmentType(Aws::String&& value) { SetAdjustmentType(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Specifies how the scaling adjustment is interpreted (for example, an absolute
|
|
* number or a percentage). The valid values are <code>ChangeInCapacity</code>,
|
|
* <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>
|
|
* <p>Required if the policy type is <code>StepScaling</code> or
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithAdjustmentType(const char* value) { SetAdjustmentType(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code>
|
|
* instead.</p>
|
|
*/
|
|
inline int GetMinAdjustmentStep() const{ return m_minAdjustmentStep; }
|
|
|
|
/**
|
|
* <p>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code>
|
|
* instead.</p>
|
|
*/
|
|
inline bool MinAdjustmentStepHasBeenSet() const { return m_minAdjustmentStepHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code>
|
|
* instead.</p>
|
|
*/
|
|
inline void SetMinAdjustmentStep(int value) { m_minAdjustmentStepHasBeenSet = true; m_minAdjustmentStep = value; }
|
|
|
|
/**
|
|
* <p>Available for backward compatibility. Use <code>MinAdjustmentMagnitude</code>
|
|
* instead.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithMinAdjustmentStep(int value) { SetMinAdjustmentStep(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The minimum value to scale by when the adjustment type is
|
|
* <code>PercentChangeInCapacity</code>. For example, suppose that you create a
|
|
* step scaling policy to scale out an Auto Scaling group by 25 percent and you
|
|
* specify a <code>MinAdjustmentMagnitude</code> of 2. If the group has 4 instances
|
|
* and the scaling policy is performed, 25 percent of 4 is 1. However, because you
|
|
* specified a <code>MinAdjustmentMagnitude</code> of 2, Amazon EC2 Auto Scaling
|
|
* scales out the group by 2 instances.</p> <p>Valid only if the policy type is
|
|
* <code>StepScaling</code> or <code>SimpleScaling</code>. For more information,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
* <p>Some Auto Scaling groups use instance weights. In this case, set the
|
|
* <code>MinAdjustmentMagnitude</code> to a value that is at least as large as your
|
|
* largest instance weight.</p>
|
|
*/
|
|
inline int GetMinAdjustmentMagnitude() const{ return m_minAdjustmentMagnitude; }
|
|
|
|
/**
|
|
* <p>The minimum value to scale by when the adjustment type is
|
|
* <code>PercentChangeInCapacity</code>. For example, suppose that you create a
|
|
* step scaling policy to scale out an Auto Scaling group by 25 percent and you
|
|
* specify a <code>MinAdjustmentMagnitude</code> of 2. If the group has 4 instances
|
|
* and the scaling policy is performed, 25 percent of 4 is 1. However, because you
|
|
* specified a <code>MinAdjustmentMagnitude</code> of 2, Amazon EC2 Auto Scaling
|
|
* scales out the group by 2 instances.</p> <p>Valid only if the policy type is
|
|
* <code>StepScaling</code> or <code>SimpleScaling</code>. For more information,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
* <p>Some Auto Scaling groups use instance weights. In this case, set the
|
|
* <code>MinAdjustmentMagnitude</code> to a value that is at least as large as your
|
|
* largest instance weight.</p>
|
|
*/
|
|
inline bool MinAdjustmentMagnitudeHasBeenSet() const { return m_minAdjustmentMagnitudeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The minimum value to scale by when the adjustment type is
|
|
* <code>PercentChangeInCapacity</code>. For example, suppose that you create a
|
|
* step scaling policy to scale out an Auto Scaling group by 25 percent and you
|
|
* specify a <code>MinAdjustmentMagnitude</code> of 2. If the group has 4 instances
|
|
* and the scaling policy is performed, 25 percent of 4 is 1. However, because you
|
|
* specified a <code>MinAdjustmentMagnitude</code> of 2, Amazon EC2 Auto Scaling
|
|
* scales out the group by 2 instances.</p> <p>Valid only if the policy type is
|
|
* <code>StepScaling</code> or <code>SimpleScaling</code>. For more information,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
* <p>Some Auto Scaling groups use instance weights. In this case, set the
|
|
* <code>MinAdjustmentMagnitude</code> to a value that is at least as large as your
|
|
* largest instance weight.</p>
|
|
*/
|
|
inline void SetMinAdjustmentMagnitude(int value) { m_minAdjustmentMagnitudeHasBeenSet = true; m_minAdjustmentMagnitude = value; }
|
|
|
|
/**
|
|
* <p>The minimum value to scale by when the adjustment type is
|
|
* <code>PercentChangeInCapacity</code>. For example, suppose that you create a
|
|
* step scaling policy to scale out an Auto Scaling group by 25 percent and you
|
|
* specify a <code>MinAdjustmentMagnitude</code> of 2. If the group has 4 instances
|
|
* and the scaling policy is performed, 25 percent of 4 is 1. However, because you
|
|
* specified a <code>MinAdjustmentMagnitude</code> of 2, Amazon EC2 Auto Scaling
|
|
* scales out the group by 2 instances.</p> <p>Valid only if the policy type is
|
|
* <code>StepScaling</code> or <code>SimpleScaling</code>. For more information,
|
|
* see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment">Scaling
|
|
* Adjustment Types</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
|
|
* <p>Some Auto Scaling groups use instance weights. In this case, set the
|
|
* <code>MinAdjustmentMagnitude</code> to a value that is at least as large as your
|
|
* largest instance weight.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithMinAdjustmentMagnitude(int value) { SetMinAdjustmentMagnitude(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The amount by which to scale, based on the specified adjustment type. A
|
|
* positive value adds to the current capacity while a negative number removes from
|
|
* the current capacity. For exact capacity, you must specify a positive value.</p>
|
|
* <p>Required if the policy type is <code>SimpleScaling</code>. (Not used with any
|
|
* other policy type.) </p>
|
|
*/
|
|
inline int GetScalingAdjustment() const{ return m_scalingAdjustment; }
|
|
|
|
/**
|
|
* <p>The amount by which to scale, based on the specified adjustment type. A
|
|
* positive value adds to the current capacity while a negative number removes from
|
|
* the current capacity. For exact capacity, you must specify a positive value.</p>
|
|
* <p>Required if the policy type is <code>SimpleScaling</code>. (Not used with any
|
|
* other policy type.) </p>
|
|
*/
|
|
inline bool ScalingAdjustmentHasBeenSet() const { return m_scalingAdjustmentHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The amount by which to scale, based on the specified adjustment type. A
|
|
* positive value adds to the current capacity while a negative number removes from
|
|
* the current capacity. For exact capacity, you must specify a positive value.</p>
|
|
* <p>Required if the policy type is <code>SimpleScaling</code>. (Not used with any
|
|
* other policy type.) </p>
|
|
*/
|
|
inline void SetScalingAdjustment(int value) { m_scalingAdjustmentHasBeenSet = true; m_scalingAdjustment = value; }
|
|
|
|
/**
|
|
* <p>The amount by which to scale, based on the specified adjustment type. A
|
|
* positive value adds to the current capacity while a negative number removes from
|
|
* the current capacity. For exact capacity, you must specify a positive value.</p>
|
|
* <p>Required if the policy type is <code>SimpleScaling</code>. (Not used with any
|
|
* other policy type.) </p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithScalingAdjustment(int value) { SetScalingAdjustment(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The duration of the policy's cooldown period, in seconds. When a cooldown
|
|
* period is specified here, it overrides the default cooldown period defined for
|
|
* the Auto Scaling group.</p> <p>Valid only if the policy type is
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html">Scaling
|
|
* Cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User
|
|
* Guide</i>.</p>
|
|
*/
|
|
inline int GetCooldown() const{ return m_cooldown; }
|
|
|
|
/**
|
|
* <p>The duration of the policy's cooldown period, in seconds. When a cooldown
|
|
* period is specified here, it overrides the default cooldown period defined for
|
|
* the Auto Scaling group.</p> <p>Valid only if the policy type is
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html">Scaling
|
|
* Cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User
|
|
* Guide</i>.</p>
|
|
*/
|
|
inline bool CooldownHasBeenSet() const { return m_cooldownHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The duration of the policy's cooldown period, in seconds. When a cooldown
|
|
* period is specified here, it overrides the default cooldown period defined for
|
|
* the Auto Scaling group.</p> <p>Valid only if the policy type is
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html">Scaling
|
|
* Cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User
|
|
* Guide</i>.</p>
|
|
*/
|
|
inline void SetCooldown(int value) { m_cooldownHasBeenSet = true; m_cooldown = value; }
|
|
|
|
/**
|
|
* <p>The duration of the policy's cooldown period, in seconds. When a cooldown
|
|
* period is specified here, it overrides the default cooldown period defined for
|
|
* the Auto Scaling group.</p> <p>Valid only if the policy type is
|
|
* <code>SimpleScaling</code>. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html">Scaling
|
|
* Cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User
|
|
* Guide</i>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithCooldown(int value) { SetCooldown(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are
|
|
* <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the
|
|
* aggregation type is null, the value is treated as <code>Average</code>.</p>
|
|
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
*/
|
|
inline const Aws::String& GetMetricAggregationType() const{ return m_metricAggregationType; }
|
|
|
|
/**
|
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are
|
|
* <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the
|
|
* aggregation type is null, the value is treated as <code>Average</code>.</p>
|
|
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
*/
|
|
inline bool MetricAggregationTypeHasBeenSet() const { return m_metricAggregationTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are
|
|
* <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the
|
|
* aggregation type is null, the value is treated as <code>Average</code>.</p>
|
|
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
*/
|
|
inline void SetMetricAggregationType(const Aws::String& value) { m_metricAggregationTypeHasBeenSet = true; m_metricAggregationType = value; }
|
|
|
|
/**
|
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are
|
|
* <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the
|
|
* aggregation type is null, the value is treated as <code>Average</code>.</p>
|
|
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
*/
|
|
inline void SetMetricAggregationType(Aws::String&& value) { m_metricAggregationTypeHasBeenSet = true; m_metricAggregationType = std::move(value); }
|
|
|
|
/**
|
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are
|
|
* <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the
|
|
* aggregation type is null, the value is treated as <code>Average</code>.</p>
|
|
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
*/
|
|
inline void SetMetricAggregationType(const char* value) { m_metricAggregationTypeHasBeenSet = true; m_metricAggregationType.assign(value); }
|
|
|
|
/**
|
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are
|
|
* <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the
|
|
* aggregation type is null, the value is treated as <code>Average</code>.</p>
|
|
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithMetricAggregationType(const Aws::String& value) { SetMetricAggregationType(value); return *this;}
|
|
|
|
/**
|
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are
|
|
* <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the
|
|
* aggregation type is null, the value is treated as <code>Average</code>.</p>
|
|
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithMetricAggregationType(Aws::String&& value) { SetMetricAggregationType(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The aggregation type for the CloudWatch metrics. The valid values are
|
|
* <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the
|
|
* aggregation type is null, the value is treated as <code>Average</code>.</p>
|
|
* <p>Valid only if the policy type is <code>StepScaling</code>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithMetricAggregationType(const char* value) { SetMetricAggregationType(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
* breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not
|
|
* used with any other policy type.) </p>
|
|
*/
|
|
inline const Aws::Vector<StepAdjustment>& GetStepAdjustments() const{ return m_stepAdjustments; }
|
|
|
|
/**
|
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
* breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not
|
|
* used with any other policy type.) </p>
|
|
*/
|
|
inline bool StepAdjustmentsHasBeenSet() const { return m_stepAdjustmentsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
* breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not
|
|
* used with any other policy type.) </p>
|
|
*/
|
|
inline void SetStepAdjustments(const Aws::Vector<StepAdjustment>& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments = value; }
|
|
|
|
/**
|
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
* breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not
|
|
* used with any other policy type.) </p>
|
|
*/
|
|
inline void SetStepAdjustments(Aws::Vector<StepAdjustment>&& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments = std::move(value); }
|
|
|
|
/**
|
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
* breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not
|
|
* used with any other policy type.) </p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithStepAdjustments(const Aws::Vector<StepAdjustment>& value) { SetStepAdjustments(value); return *this;}
|
|
|
|
/**
|
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
* breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not
|
|
* used with any other policy type.) </p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithStepAdjustments(Aws::Vector<StepAdjustment>&& value) { SetStepAdjustments(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
* breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not
|
|
* used with any other policy type.) </p>
|
|
*/
|
|
inline PutScalingPolicyRequest& AddStepAdjustments(const StepAdjustment& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>A set of adjustments that enable you to scale based on the size of the alarm
|
|
* breach.</p> <p>Required if the policy type is <code>StepScaling</code>. (Not
|
|
* used with any other policy type.) </p>
|
|
*/
|
|
inline PutScalingPolicyRequest& AddStepAdjustments(StepAdjustment&& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The estimated time, in seconds, until a newly launched instance can
|
|
* contribute to the CloudWatch metrics. If not provided, the default is to use the
|
|
* value from the default cooldown period for the Auto Scaling group.</p> <p>Valid
|
|
* only if the policy type is <code>TargetTrackingScaling</code> or
|
|
* <code>StepScaling</code>.</p>
|
|
*/
|
|
inline int GetEstimatedInstanceWarmup() const{ return m_estimatedInstanceWarmup; }
|
|
|
|
/**
|
|
* <p>The estimated time, in seconds, until a newly launched instance can
|
|
* contribute to the CloudWatch metrics. If not provided, the default is to use the
|
|
* value from the default cooldown period for the Auto Scaling group.</p> <p>Valid
|
|
* only if the policy type is <code>TargetTrackingScaling</code> or
|
|
* <code>StepScaling</code>.</p>
|
|
*/
|
|
inline bool EstimatedInstanceWarmupHasBeenSet() const { return m_estimatedInstanceWarmupHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The estimated time, in seconds, until a newly launched instance can
|
|
* contribute to the CloudWatch metrics. If not provided, the default is to use the
|
|
* value from the default cooldown period for the Auto Scaling group.</p> <p>Valid
|
|
* only if the policy type is <code>TargetTrackingScaling</code> or
|
|
* <code>StepScaling</code>.</p>
|
|
*/
|
|
inline void SetEstimatedInstanceWarmup(int value) { m_estimatedInstanceWarmupHasBeenSet = true; m_estimatedInstanceWarmup = value; }
|
|
|
|
/**
|
|
* <p>The estimated time, in seconds, until a newly launched instance can
|
|
* contribute to the CloudWatch metrics. If not provided, the default is to use the
|
|
* value from the default cooldown period for the Auto Scaling group.</p> <p>Valid
|
|
* only if the policy type is <code>TargetTrackingScaling</code> or
|
|
* <code>StepScaling</code>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithEstimatedInstanceWarmup(int value) { SetEstimatedInstanceWarmup(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A target tracking scaling policy. Includes support for predefined or
|
|
* customized metrics.</p> <p>The following predefined metrics are available:</p>
|
|
* <ul> <li> <p> <code>ASGAverageCPUUtilization</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkIn</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkOut</code> </p> </li> <li> <p>
|
|
* <code>ALBRequestCountPerTarget</code> </p> </li> </ul> <p>If you specify
|
|
* <code>ALBRequestCountPerTarget</code> for the metric, you must specify the
|
|
* <code>ResourceLabel</code> parameter with the
|
|
* <code>PredefinedMetricSpecification</code>.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html">TargetTrackingConfiguration</a>
|
|
* in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Required if the
|
|
* policy type is <code>TargetTrackingScaling</code>.</p>
|
|
*/
|
|
inline const TargetTrackingConfiguration& GetTargetTrackingConfiguration() const{ return m_targetTrackingConfiguration; }
|
|
|
|
/**
|
|
* <p>A target tracking scaling policy. Includes support for predefined or
|
|
* customized metrics.</p> <p>The following predefined metrics are available:</p>
|
|
* <ul> <li> <p> <code>ASGAverageCPUUtilization</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkIn</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkOut</code> </p> </li> <li> <p>
|
|
* <code>ALBRequestCountPerTarget</code> </p> </li> </ul> <p>If you specify
|
|
* <code>ALBRequestCountPerTarget</code> for the metric, you must specify the
|
|
* <code>ResourceLabel</code> parameter with the
|
|
* <code>PredefinedMetricSpecification</code>.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html">TargetTrackingConfiguration</a>
|
|
* in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Required if the
|
|
* policy type is <code>TargetTrackingScaling</code>.</p>
|
|
*/
|
|
inline bool TargetTrackingConfigurationHasBeenSet() const { return m_targetTrackingConfigurationHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A target tracking scaling policy. Includes support for predefined or
|
|
* customized metrics.</p> <p>The following predefined metrics are available:</p>
|
|
* <ul> <li> <p> <code>ASGAverageCPUUtilization</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkIn</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkOut</code> </p> </li> <li> <p>
|
|
* <code>ALBRequestCountPerTarget</code> </p> </li> </ul> <p>If you specify
|
|
* <code>ALBRequestCountPerTarget</code> for the metric, you must specify the
|
|
* <code>ResourceLabel</code> parameter with the
|
|
* <code>PredefinedMetricSpecification</code>.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html">TargetTrackingConfiguration</a>
|
|
* in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Required if the
|
|
* policy type is <code>TargetTrackingScaling</code>.</p>
|
|
*/
|
|
inline void SetTargetTrackingConfiguration(const TargetTrackingConfiguration& value) { m_targetTrackingConfigurationHasBeenSet = true; m_targetTrackingConfiguration = value; }
|
|
|
|
/**
|
|
* <p>A target tracking scaling policy. Includes support for predefined or
|
|
* customized metrics.</p> <p>The following predefined metrics are available:</p>
|
|
* <ul> <li> <p> <code>ASGAverageCPUUtilization</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkIn</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkOut</code> </p> </li> <li> <p>
|
|
* <code>ALBRequestCountPerTarget</code> </p> </li> </ul> <p>If you specify
|
|
* <code>ALBRequestCountPerTarget</code> for the metric, you must specify the
|
|
* <code>ResourceLabel</code> parameter with the
|
|
* <code>PredefinedMetricSpecification</code>.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html">TargetTrackingConfiguration</a>
|
|
* in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Required if the
|
|
* policy type is <code>TargetTrackingScaling</code>.</p>
|
|
*/
|
|
inline void SetTargetTrackingConfiguration(TargetTrackingConfiguration&& value) { m_targetTrackingConfigurationHasBeenSet = true; m_targetTrackingConfiguration = std::move(value); }
|
|
|
|
/**
|
|
* <p>A target tracking scaling policy. Includes support for predefined or
|
|
* customized metrics.</p> <p>The following predefined metrics are available:</p>
|
|
* <ul> <li> <p> <code>ASGAverageCPUUtilization</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkIn</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkOut</code> </p> </li> <li> <p>
|
|
* <code>ALBRequestCountPerTarget</code> </p> </li> </ul> <p>If you specify
|
|
* <code>ALBRequestCountPerTarget</code> for the metric, you must specify the
|
|
* <code>ResourceLabel</code> parameter with the
|
|
* <code>PredefinedMetricSpecification</code>.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html">TargetTrackingConfiguration</a>
|
|
* in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Required if the
|
|
* policy type is <code>TargetTrackingScaling</code>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithTargetTrackingConfiguration(const TargetTrackingConfiguration& value) { SetTargetTrackingConfiguration(value); return *this;}
|
|
|
|
/**
|
|
* <p>A target tracking scaling policy. Includes support for predefined or
|
|
* customized metrics.</p> <p>The following predefined metrics are available:</p>
|
|
* <ul> <li> <p> <code>ASGAverageCPUUtilization</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkIn</code> </p> </li> <li> <p>
|
|
* <code>ASGAverageNetworkOut</code> </p> </li> <li> <p>
|
|
* <code>ALBRequestCountPerTarget</code> </p> </li> </ul> <p>If you specify
|
|
* <code>ALBRequestCountPerTarget</code> for the metric, you must specify the
|
|
* <code>ResourceLabel</code> parameter with the
|
|
* <code>PredefinedMetricSpecification</code>.</p> <p>For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html">TargetTrackingConfiguration</a>
|
|
* in the <i>Amazon EC2 Auto Scaling API Reference</i>.</p> <p>Required if the
|
|
* policy type is <code>TargetTrackingScaling</code>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithTargetTrackingConfiguration(TargetTrackingConfiguration&& value) { SetTargetTrackingConfiguration(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Indicates whether the scaling policy is enabled or disabled. The default is
|
|
* enabled. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html">Disabling
|
|
* a Scaling Policy for an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling
|
|
* User Guide</i>.</p>
|
|
*/
|
|
inline bool GetEnabled() const{ return m_enabled; }
|
|
|
|
/**
|
|
* <p>Indicates whether the scaling policy is enabled or disabled. The default is
|
|
* enabled. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html">Disabling
|
|
* a Scaling Policy for an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling
|
|
* User Guide</i>.</p>
|
|
*/
|
|
inline bool EnabledHasBeenSet() const { return m_enabledHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Indicates whether the scaling policy is enabled or disabled. The default is
|
|
* enabled. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html">Disabling
|
|
* a Scaling Policy for an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling
|
|
* User Guide</i>.</p>
|
|
*/
|
|
inline void SetEnabled(bool value) { m_enabledHasBeenSet = true; m_enabled = value; }
|
|
|
|
/**
|
|
* <p>Indicates whether the scaling policy is enabled or disabled. The default is
|
|
* enabled. For more information, see <a
|
|
* href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enable-disable-scaling-policy.html">Disabling
|
|
* a Scaling Policy for an Auto Scaling Group</a> in the <i>Amazon EC2 Auto Scaling
|
|
* User Guide</i>.</p>
|
|
*/
|
|
inline PutScalingPolicyRequest& WithEnabled(bool value) { SetEnabled(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_autoScalingGroupName;
|
|
bool m_autoScalingGroupNameHasBeenSet;
|
|
|
|
Aws::String m_policyName;
|
|
bool m_policyNameHasBeenSet;
|
|
|
|
Aws::String m_policyType;
|
|
bool m_policyTypeHasBeenSet;
|
|
|
|
Aws::String m_adjustmentType;
|
|
bool m_adjustmentTypeHasBeenSet;
|
|
|
|
int m_minAdjustmentStep;
|
|
bool m_minAdjustmentStepHasBeenSet;
|
|
|
|
int m_minAdjustmentMagnitude;
|
|
bool m_minAdjustmentMagnitudeHasBeenSet;
|
|
|
|
int m_scalingAdjustment;
|
|
bool m_scalingAdjustmentHasBeenSet;
|
|
|
|
int m_cooldown;
|
|
bool m_cooldownHasBeenSet;
|
|
|
|
Aws::String m_metricAggregationType;
|
|
bool m_metricAggregationTypeHasBeenSet;
|
|
|
|
Aws::Vector<StepAdjustment> m_stepAdjustments;
|
|
bool m_stepAdjustmentsHasBeenSet;
|
|
|
|
int m_estimatedInstanceWarmup;
|
|
bool m_estimatedInstanceWarmupHasBeenSet;
|
|
|
|
TargetTrackingConfiguration m_targetTrackingConfiguration;
|
|
bool m_targetTrackingConfigurationHasBeenSet;
|
|
|
|
bool m_enabled;
|
|
bool m_enabledHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace AutoScaling
|
|
} // namespace Aws
|