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

Represents a step scaling policy configuration to use with Application Auto * Scaling.

See Also:

AWS * API Reference

*/ class AWS_APPLICATIONAUTOSCALING_API StepScalingPolicyConfiguration { public: StepScalingPolicyConfiguration(); StepScalingPolicyConfiguration(Aws::Utils::Json::JsonView jsonValue); StepScalingPolicyConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

Specifies whether the ScalingAdjustment value in a StepAdjustment * is an absolute number or a percentage of the current capacity.

* AdjustmentType is required if you are adding a new step scaling * policy configuration.

*/ inline const AdjustmentType& GetAdjustmentType() const{ return m_adjustmentType; } /** *

Specifies whether the ScalingAdjustment value in a StepAdjustment * is an absolute number or a percentage of the current capacity.

* AdjustmentType is required if you are adding a new step scaling * policy configuration.

*/ inline bool AdjustmentTypeHasBeenSet() const { return m_adjustmentTypeHasBeenSet; } /** *

Specifies whether the ScalingAdjustment value in a StepAdjustment * is an absolute number or a percentage of the current capacity.

* AdjustmentType is required if you are adding a new step scaling * policy configuration.

*/ inline void SetAdjustmentType(const AdjustmentType& value) { m_adjustmentTypeHasBeenSet = true; m_adjustmentType = value; } /** *

Specifies whether the ScalingAdjustment value in a StepAdjustment * is an absolute number or a percentage of the current capacity.

* AdjustmentType is required if you are adding a new step scaling * policy configuration.

*/ inline void SetAdjustmentType(AdjustmentType&& value) { m_adjustmentTypeHasBeenSet = true; m_adjustmentType = std::move(value); } /** *

Specifies whether the ScalingAdjustment value in a StepAdjustment * is an absolute number or a percentage of the current capacity.

* AdjustmentType is required if you are adding a new step scaling * policy configuration.

*/ inline StepScalingPolicyConfiguration& WithAdjustmentType(const AdjustmentType& value) { SetAdjustmentType(value); return *this;} /** *

Specifies whether the ScalingAdjustment value in a StepAdjustment * is an absolute number or a percentage of the current capacity.

* AdjustmentType is required if you are adding a new step scaling * policy configuration.

*/ inline StepScalingPolicyConfiguration& WithAdjustmentType(AdjustmentType&& value) { SetAdjustmentType(std::move(value)); return *this;} /** *

A set of adjustments that enable you to scale based on the size of the alarm * breach.

At least one step adjustment is required if you are adding a new * step scaling policy configuration.

*/ inline const Aws::Vector& GetStepAdjustments() const{ return m_stepAdjustments; } /** *

A set of adjustments that enable you to scale based on the size of the alarm * breach.

At least one step adjustment is required if you are adding a new * step scaling policy configuration.

*/ inline bool StepAdjustmentsHasBeenSet() const { return m_stepAdjustmentsHasBeenSet; } /** *

A set of adjustments that enable you to scale based on the size of the alarm * breach.

At least one step adjustment is required if you are adding a new * step scaling policy configuration.

*/ inline void SetStepAdjustments(const Aws::Vector& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments = value; } /** *

A set of adjustments that enable you to scale based on the size of the alarm * breach.

At least one step adjustment is required if you are adding a new * step scaling policy configuration.

*/ inline void SetStepAdjustments(Aws::Vector&& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments = std::move(value); } /** *

A set of adjustments that enable you to scale based on the size of the alarm * breach.

At least one step adjustment is required if you are adding a new * step scaling policy configuration.

*/ inline StepScalingPolicyConfiguration& WithStepAdjustments(const Aws::Vector& value) { SetStepAdjustments(value); return *this;} /** *

A set of adjustments that enable you to scale based on the size of the alarm * breach.

At least one step adjustment is required if you are adding a new * step scaling policy configuration.

*/ inline StepScalingPolicyConfiguration& WithStepAdjustments(Aws::Vector&& value) { SetStepAdjustments(std::move(value)); return *this;} /** *

A set of adjustments that enable you to scale based on the size of the alarm * breach.

At least one step adjustment is required if you are adding a new * step scaling policy configuration.

*/ inline StepScalingPolicyConfiguration& AddStepAdjustments(const StepAdjustment& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments.push_back(value); return *this; } /** *

A set of adjustments that enable you to scale based on the size of the alarm * breach.

At least one step adjustment is required if you are adding a new * step scaling policy configuration.

*/ inline StepScalingPolicyConfiguration& AddStepAdjustments(StepAdjustment&& value) { m_stepAdjustmentsHasBeenSet = true; m_stepAdjustments.push_back(std::move(value)); return *this; } /** *

The minimum value to scale by when scaling by percentages. For example, * suppose that you create a step scaling policy to scale out an Amazon ECS service * by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the * service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. * However, because you specified a MinAdjustmentMagnitude of 2, * Application Auto Scaling scales out the service by 2 tasks.

Valid only if * the adjustment type is PercentChangeInCapacity.

*/ inline int GetMinAdjustmentMagnitude() const{ return m_minAdjustmentMagnitude; } /** *

The minimum value to scale by when scaling by percentages. For example, * suppose that you create a step scaling policy to scale out an Amazon ECS service * by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the * service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. * However, because you specified a MinAdjustmentMagnitude of 2, * Application Auto Scaling scales out the service by 2 tasks.

Valid only if * the adjustment type is PercentChangeInCapacity.

*/ inline bool MinAdjustmentMagnitudeHasBeenSet() const { return m_minAdjustmentMagnitudeHasBeenSet; } /** *

The minimum value to scale by when scaling by percentages. For example, * suppose that you create a step scaling policy to scale out an Amazon ECS service * by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the * service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. * However, because you specified a MinAdjustmentMagnitude of 2, * Application Auto Scaling scales out the service by 2 tasks.

Valid only if * the adjustment type is PercentChangeInCapacity.

*/ inline void SetMinAdjustmentMagnitude(int value) { m_minAdjustmentMagnitudeHasBeenSet = true; m_minAdjustmentMagnitude = value; } /** *

The minimum value to scale by when scaling by percentages. For example, * suppose that you create a step scaling policy to scale out an Amazon ECS service * by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the * service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. * However, because you specified a MinAdjustmentMagnitude of 2, * Application Auto Scaling scales out the service by 2 tasks.

Valid only if * the adjustment type is PercentChangeInCapacity.

*/ inline StepScalingPolicyConfiguration& WithMinAdjustmentMagnitude(int value) { SetMinAdjustmentMagnitude(value); return *this;} /** *

The amount of time, in seconds, to wait for a previous scaling activity to * take effect.

With scale-out policies, the intention is to continuously * (but not excessively) scale out. After Application Auto Scaling successfully * scales out using a step scaling policy, it starts to calculate the cooldown * time. While the cooldown period is in effect, capacity added by the initiating * scale-out activity is calculated as part of the desired capacity for the next * scale-out activity. For example, when an alarm triggers a step scaling policy to * increase the capacity by 2, the scaling activity completes successfully, and a * cooldown period starts. If the alarm triggers again during the cooldown period * but at a more aggressive step adjustment of 3, the previous increase of 2 is * considered part of the current capacity. Therefore, only 1 is added to the * capacity.

With scale-in policies, the intention is to scale in * conservatively to protect your application’s availability, so scale-in * activities are blocked until the cooldown period has expired. However, if * another alarm triggers a scale-out activity during the cooldown period after a * scale-in activity, Application Auto Scaling scales out the target immediately. * In this case, the cooldown period for the scale-in activity stops and doesn't * complete.

Application Auto Scaling provides a default value of 300 for * the following scalable targets:

  • ECS services

  • *

    Spot Fleet requests

  • EMR clusters

  • *

    AppStream 2.0 fleets

  • Aurora DB clusters

  • *

    Amazon SageMaker endpoint variants

  • Custom resources

    *

For all other scalable targets, the default value is 0:

    *
  • DynamoDB tables

  • DynamoDB global secondary indexes

    *
  • Amazon Comprehend document classification endpoints

  • *

    Lambda provisioned concurrency

  • Amazon Keyspaces tables

    *
*/ inline int GetCooldown() const{ return m_cooldown; } /** *

The amount of time, in seconds, to wait for a previous scaling activity to * take effect.

With scale-out policies, the intention is to continuously * (but not excessively) scale out. After Application Auto Scaling successfully * scales out using a step scaling policy, it starts to calculate the cooldown * time. While the cooldown period is in effect, capacity added by the initiating * scale-out activity is calculated as part of the desired capacity for the next * scale-out activity. For example, when an alarm triggers a step scaling policy to * increase the capacity by 2, the scaling activity completes successfully, and a * cooldown period starts. If the alarm triggers again during the cooldown period * but at a more aggressive step adjustment of 3, the previous increase of 2 is * considered part of the current capacity. Therefore, only 1 is added to the * capacity.

With scale-in policies, the intention is to scale in * conservatively to protect your application’s availability, so scale-in * activities are blocked until the cooldown period has expired. However, if * another alarm triggers a scale-out activity during the cooldown period after a * scale-in activity, Application Auto Scaling scales out the target immediately. * In this case, the cooldown period for the scale-in activity stops and doesn't * complete.

Application Auto Scaling provides a default value of 300 for * the following scalable targets:

  • ECS services

  • *

    Spot Fleet requests

  • EMR clusters

  • *

    AppStream 2.0 fleets

  • Aurora DB clusters

  • *

    Amazon SageMaker endpoint variants

  • Custom resources

    *

For all other scalable targets, the default value is 0:

    *
  • DynamoDB tables

  • DynamoDB global secondary indexes

    *
  • Amazon Comprehend document classification endpoints

  • *

    Lambda provisioned concurrency

  • Amazon Keyspaces tables

    *
*/ inline bool CooldownHasBeenSet() const { return m_cooldownHasBeenSet; } /** *

The amount of time, in seconds, to wait for a previous scaling activity to * take effect.

With scale-out policies, the intention is to continuously * (but not excessively) scale out. After Application Auto Scaling successfully * scales out using a step scaling policy, it starts to calculate the cooldown * time. While the cooldown period is in effect, capacity added by the initiating * scale-out activity is calculated as part of the desired capacity for the next * scale-out activity. For example, when an alarm triggers a step scaling policy to * increase the capacity by 2, the scaling activity completes successfully, and a * cooldown period starts. If the alarm triggers again during the cooldown period * but at a more aggressive step adjustment of 3, the previous increase of 2 is * considered part of the current capacity. Therefore, only 1 is added to the * capacity.

With scale-in policies, the intention is to scale in * conservatively to protect your application’s availability, so scale-in * activities are blocked until the cooldown period has expired. However, if * another alarm triggers a scale-out activity during the cooldown period after a * scale-in activity, Application Auto Scaling scales out the target immediately. * In this case, the cooldown period for the scale-in activity stops and doesn't * complete.

Application Auto Scaling provides a default value of 300 for * the following scalable targets:

  • ECS services

  • *

    Spot Fleet requests

  • EMR clusters

  • *

    AppStream 2.0 fleets

  • Aurora DB clusters

  • *

    Amazon SageMaker endpoint variants

  • Custom resources

    *

For all other scalable targets, the default value is 0:

    *
  • DynamoDB tables

  • DynamoDB global secondary indexes

    *
  • Amazon Comprehend document classification endpoints

  • *

    Lambda provisioned concurrency

  • Amazon Keyspaces tables

    *
*/ inline void SetCooldown(int value) { m_cooldownHasBeenSet = true; m_cooldown = value; } /** *

The amount of time, in seconds, to wait for a previous scaling activity to * take effect.

With scale-out policies, the intention is to continuously * (but not excessively) scale out. After Application Auto Scaling successfully * scales out using a step scaling policy, it starts to calculate the cooldown * time. While the cooldown period is in effect, capacity added by the initiating * scale-out activity is calculated as part of the desired capacity for the next * scale-out activity. For example, when an alarm triggers a step scaling policy to * increase the capacity by 2, the scaling activity completes successfully, and a * cooldown period starts. If the alarm triggers again during the cooldown period * but at a more aggressive step adjustment of 3, the previous increase of 2 is * considered part of the current capacity. Therefore, only 1 is added to the * capacity.

With scale-in policies, the intention is to scale in * conservatively to protect your application’s availability, so scale-in * activities are blocked until the cooldown period has expired. However, if * another alarm triggers a scale-out activity during the cooldown period after a * scale-in activity, Application Auto Scaling scales out the target immediately. * In this case, the cooldown period for the scale-in activity stops and doesn't * complete.

Application Auto Scaling provides a default value of 300 for * the following scalable targets:

  • ECS services

  • *

    Spot Fleet requests

  • EMR clusters

  • *

    AppStream 2.0 fleets

  • Aurora DB clusters

  • *

    Amazon SageMaker endpoint variants

  • Custom resources

    *

For all other scalable targets, the default value is 0:

    *
  • DynamoDB tables

  • DynamoDB global secondary indexes

    *
  • Amazon Comprehend document classification endpoints

  • *

    Lambda provisioned concurrency

  • Amazon Keyspaces tables

    *
*/ inline StepScalingPolicyConfiguration& WithCooldown(int value) { SetCooldown(value); return *this;} /** *

The aggregation type for the CloudWatch metrics. Valid values are * Minimum, Maximum, and Average. If the * aggregation type is null, the value is treated as Average.

*/ inline const MetricAggregationType& GetMetricAggregationType() const{ return m_metricAggregationType; } /** *

The aggregation type for the CloudWatch metrics. Valid values are * Minimum, Maximum, and Average. If the * aggregation type is null, the value is treated as Average.

*/ inline bool MetricAggregationTypeHasBeenSet() const { return m_metricAggregationTypeHasBeenSet; } /** *

The aggregation type for the CloudWatch metrics. Valid values are * Minimum, Maximum, and Average. If the * aggregation type is null, the value is treated as Average.

*/ inline void SetMetricAggregationType(const MetricAggregationType& value) { m_metricAggregationTypeHasBeenSet = true; m_metricAggregationType = value; } /** *

The aggregation type for the CloudWatch metrics. Valid values are * Minimum, Maximum, and Average. If the * aggregation type is null, the value is treated as Average.

*/ inline void SetMetricAggregationType(MetricAggregationType&& value) { m_metricAggregationTypeHasBeenSet = true; m_metricAggregationType = std::move(value); } /** *

The aggregation type for the CloudWatch metrics. Valid values are * Minimum, Maximum, and Average. If the * aggregation type is null, the value is treated as Average.

*/ inline StepScalingPolicyConfiguration& WithMetricAggregationType(const MetricAggregationType& value) { SetMetricAggregationType(value); return *this;} /** *

The aggregation type for the CloudWatch metrics. Valid values are * Minimum, Maximum, and Average. If the * aggregation type is null, the value is treated as Average.

*/ inline StepScalingPolicyConfiguration& WithMetricAggregationType(MetricAggregationType&& value) { SetMetricAggregationType(std::move(value)); return *this;} private: AdjustmentType m_adjustmentType; bool m_adjustmentTypeHasBeenSet; Aws::Vector m_stepAdjustments; bool m_stepAdjustmentsHasBeenSet; int m_minAdjustmentMagnitude; bool m_minAdjustmentMagnitudeHasBeenSet; int m_cooldown; bool m_cooldownHasBeenSet; MetricAggregationType m_metricAggregationType; bool m_metricAggregationTypeHasBeenSet; }; } // namespace Model } // namespace ApplicationAutoScaling } // namespace Aws