« blib/lib/Paws/ApplicationAutoScaling/ScheduledAction.pm
↑ Summary
blib/lib/Paws/ApplicationAutoScaling/StepScalingPolicyConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApplicationAutoScaling::StepAdjustment; | ||
| 3 | use Moose; | ||
| 4 | has MetricIntervalLowerBound => (is => 'ro', isa => 'Num'); | ||
| 5 | has MetricIntervalUpperBound => (is => 'ro', isa => 'Num'); | ||
| 6 | has ScalingAdjustment => (is => 'ro', isa => 'Int', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::ApplicationAutoScaling::StepAdjustment | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::ApplicationAutoScaling::StepAdjustment object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { MetricIntervalLowerBound => $value, ..., ScalingAdjustment => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApplicationAutoScaling::StepAdjustment object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->MetricIntervalLowerBound | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Represents a step adjustment for a StepScalingPolicyConfiguration | ||
| 39 | (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html). | ||
| 40 | Describes an adjustment based on the difference between the value of | ||
| 41 | the aggregated CloudWatch metric and the breach threshold that you've | ||
| 42 | defined for the alarm. | ||
| 43 | |||
| 44 | For the following examples, suppose that you have an alarm with a | ||
| 45 | breach threshold of 50: | ||
| 46 | |||
| 47 | =over | ||
| 48 | |||
| 49 | =item * | ||
| 50 | |||
| 51 | To trigger the adjustment when the metric is greater than or equal to | ||
| 52 | 50 and less than 60, specify a lower bound of 0 and an upper bound of | ||
| 53 | 10. | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | To trigger the adjustment when the metric is greater than 40 and less | ||
| 58 | than or equal to 50, specify a lower bound of -10 and an upper bound of | ||
| 59 | 0. | ||
| 60 | |||
| 61 | =back | ||
| 62 | |||
| 63 | There are a few rules for the step adjustments for your step policy: | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | The ranges of your step adjustments can't overlap or have a gap. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | At most one step adjustment can have a null lower bound. If one step | ||
| 74 | adjustment has a negative lower bound, then there must be a step | ||
| 75 | adjustment with a null lower bound. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | At most one step adjustment can have a null upper bound. If one step | ||
| 80 | adjustment has a positive upper bound, then there must be a step | ||
| 81 | adjustment with a null upper bound. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | The upper and lower bound can't be null in the same step adjustment. | ||
| 86 | |||
| 87 | =back | ||
| 88 | |||
| 89 | |||
| 90 | =head1 ATTRIBUTES | ||
| 91 | |||
| 92 | |||
| 93 | =head2 MetricIntervalLowerBound => Num | ||
| 94 | |||
| 95 | The lower bound for the difference between the alarm threshold and the | ||
| 96 | CloudWatch metric. If the metric value is above the breach threshold, | ||
| 97 | the lower bound is inclusive (the metric must be greater than or equal | ||
| 98 | to the threshold plus the lower bound). Otherwise, it is exclusive (the | ||
| 99 | metric must be greater than the threshold plus the lower bound). A null | ||
| 100 | value indicates negative infinity. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 MetricIntervalUpperBound => Num | ||
| 104 | |||
| 105 | The upper bound for the difference between the alarm threshold and the | ||
| 106 | CloudWatch metric. If the metric value is above the breach threshold, | ||
| 107 | the upper bound is exclusive (the metric must be less than the | ||
| 108 | threshold plus the upper bound). Otherwise, it is inclusive (the metric | ||
| 109 | must be less than or equal to the threshold plus the upper bound). A | ||
| 110 | null value indicates positive infinity. | ||
| 111 | |||
| 112 | The upper bound must be greater than the lower bound. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 B<REQUIRED> ScalingAdjustment => Int | ||
| 116 | |||
| 117 | The amount by which to scale, based on the specified adjustment type. A | ||
| 118 | positive value adds to the current capacity while a negative number | ||
| 119 | removes from the current capacity. For exact capacity, you must specify | ||
| 120 | a positive value. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, describing an object used in L<Paws::ApplicationAutoScaling> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |