« blib/lib/Paws/ApplicationAutoScaling/StepAdjustment.pm
↑ Summary
blib/lib/Paws/ApplicationAutoScaling/SuspendedState.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApplicationAutoScaling::StepScalingPolicyConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AdjustmentType => (is => 'ro', isa => 'Str'); | ||
| 5 | has Cooldown => (is => 'ro', isa => 'Int'); | ||
| 6 | has MetricAggregationType => (is => 'ro', isa => 'Str'); | ||
| 7 | has MinAdjustmentMagnitude => (is => 'ro', isa => 'Int'); | ||
| 8 | has StepAdjustments => (is => 'ro', isa => 'ArrayRef[Paws::ApplicationAutoScaling::StepAdjustment]'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::ApplicationAutoScaling::StepScalingPolicyConfiguration | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::ApplicationAutoScaling::StepScalingPolicyConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { AdjustmentType => $value, ..., StepAdjustments => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApplicationAutoScaling::StepScalingPolicyConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->AdjustmentType | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Represents a step scaling policy configuration to use with Application | ||
| 41 | Auto Scaling. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 AdjustmentType => Str | ||
| 47 | |||
| 48 | Specifies how the C<ScalingAdjustment> value in a StepAdjustment | ||
| 49 | (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepAdjustment.html) | ||
| 50 | is interpreted (for example, an absolute number or a percentage). The | ||
| 51 | valid values are C<ChangeInCapacity>, C<ExactCapacity>, and | ||
| 52 | C<PercentChangeInCapacity>. | ||
| 53 | |||
| 54 | C<AdjustmentType> is required if you are adding a new step scaling | ||
| 55 | policy configuration. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Cooldown => Int | ||
| 59 | |||
| 60 | The amount of time, in seconds, to wait for a previous scaling activity | ||
| 61 | to take effect. | ||
| 62 | |||
| 63 | With scale-out policies, the intention is to continuously (but not | ||
| 64 | excessively) scale out. After Application Auto Scaling successfully | ||
| 65 | scales out using a step scaling policy, it starts to calculate the | ||
| 66 | cooldown time. The scaling policy won't increase the desired capacity | ||
| 67 | again unless either a larger scale out is triggered or the cooldown | ||
| 68 | period ends. While the cooldown period is in effect, capacity added by | ||
| 69 | the initiating scale-out activity is calculated as part of the desired | ||
| 70 | capacity for the next scale-out activity. For example, when an alarm | ||
| 71 | triggers a step scaling policy to increase the capacity by 2, the | ||
| 72 | scaling activity completes successfully, and a cooldown period starts. | ||
| 73 | If the alarm triggers again during the cooldown period but at a more | ||
| 74 | aggressive step adjustment of 3, the previous increase of 2 is | ||
| 75 | considered part of the current capacity. Therefore, only 1 is added to | ||
| 76 | the capacity. | ||
| 77 | |||
| 78 | With scale-in policies, the intention is to scale in conservatively to | ||
| 79 | protect your applicationE<rsquo>s availability, so scale-in activities | ||
| 80 | are blocked until the cooldown period has expired. However, if another | ||
| 81 | alarm triggers a scale-out activity during the cooldown period after a | ||
| 82 | scale-in activity, Application Auto Scaling scales out the target | ||
| 83 | immediately. In this case, the cooldown period for the scale-in | ||
| 84 | activity stops and doesn't complete. | ||
| 85 | |||
| 86 | Application Auto Scaling provides a default value of 300 for the | ||
| 87 | following scalable targets: | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | ECS services | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Spot Fleet requests | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | EMR clusters | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | AppStream 2.0 fleets | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | Aurora DB clusters | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | Amazon SageMaker endpoint variants | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | Custom resources | ||
| 118 | |||
| 119 | =back | ||
| 120 | |||
| 121 | For all other scalable targets, the default value is 0: | ||
| 122 | |||
| 123 | =over | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | DynamoDB tables | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | DynamoDB global secondary indexes | ||
| 132 | |||
| 133 | =item * | ||
| 134 | |||
| 135 | Amazon Comprehend document classification and entity recognizer | ||
| 136 | endpoints | ||
| 137 | |||
| 138 | =item * | ||
| 139 | |||
| 140 | Lambda provisioned concurrency | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | Amazon Keyspaces tables | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | Amazon MSK broker storage | ||
| 149 | |||
| 150 | =back | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 MetricAggregationType => Str | ||
| 155 | |||
| 156 | The aggregation type for the CloudWatch metrics. Valid values are | ||
| 157 | C<Minimum>, C<Maximum>, and C<Average>. If the aggregation type is | ||
| 158 | null, the value is treated as C<Average>. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 MinAdjustmentMagnitude => Int | ||
| 162 | |||
| 163 | The minimum value to scale by when the adjustment type is | ||
| 164 | C<PercentChangeInCapacity>. For example, suppose that you create a step | ||
| 165 | scaling policy to scale out an Amazon ECS service by 25 percent and you | ||
| 166 | specify a C<MinAdjustmentMagnitude> of 2. If the service has 4 tasks | ||
| 167 | and the scaling policy is performed, 25 percent of 4 is 1. However, | ||
| 168 | because you specified a C<MinAdjustmentMagnitude> of 2, Application | ||
| 169 | Auto Scaling scales out the service by 2 tasks. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 StepAdjustments => ArrayRef[L<Paws::ApplicationAutoScaling::StepAdjustment>] | ||
| 173 | |||
| 174 | A set of adjustments that enable you to scale based on the size of the | ||
| 175 | alarm breach. | ||
| 176 | |||
| 177 | At least one step adjustment is required if you are adding a new step | ||
| 178 | scaling policy configuration. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head1 SEE ALSO | ||
| 183 | |||
| 184 | This class forms part of L<Paws>, describing an object used in L<Paws::ApplicationAutoScaling> | ||
| 185 | |||
| 186 | =head1 BUGS and CONTRIBUTIONS | ||
| 187 | |||
| 188 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 189 | |||
| 190 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 191 | |||
| 192 | =cut | ||
| 193 |