« blib/lib/Paws/AutoScaling/StartInstanceRefreshAnswer.pm
↑ Summary
blib/lib/Paws/AutoScaling/SuspendProcesses.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScaling::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::AutoScaling::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::AutoScaling::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::AutoScaling::StepAdjustment object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->MetricIntervalLowerBound | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Describes information used to create a step adjustment for a step | ||
| 39 | scaling policy. | ||
| 40 | |||
| 41 | For the following examples, suppose that you have an alarm with a | ||
| 42 | breach threshold of 50: | ||
| 43 | |||
| 44 | =over | ||
| 45 | |||
| 46 | =item * | ||
| 47 | |||
| 48 | To trigger the adjustment when the metric is greater than or equal to | ||
| 49 | 50 and less than 60, specify a lower bound of 0 and an upper bound of | ||
| 50 | 10. | ||
| 51 | |||
| 52 | =item * | ||
| 53 | |||
| 54 | To trigger the adjustment when the metric is greater than 40 and less | ||
| 55 | than or equal to 50, specify a lower bound of -10 and an upper bound of | ||
| 56 | 0. | ||
| 57 | |||
| 58 | =back | ||
| 59 | |||
| 60 | There are a few rules for the step adjustments for your step policy: | ||
| 61 | |||
| 62 | =over | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | The ranges of your step adjustments can't overlap or have a gap. | ||
| 67 | |||
| 68 | =item * | ||
| 69 | |||
| 70 | At most, one step adjustment can have a null lower bound. If one step | ||
| 71 | adjustment has a negative lower bound, then there must be a step | ||
| 72 | adjustment with a null lower bound. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | At most, one step adjustment can have a null upper bound. If one step | ||
| 77 | adjustment has a positive upper bound, then there must be a step | ||
| 78 | adjustment with a null upper bound. | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | The upper and lower bound can't be null in the same step adjustment. | ||
| 83 | |||
| 84 | =back | ||
| 85 | |||
| 86 | For more information, see Step adjustments | ||
| 87 | (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-steps) | ||
| 88 | in the I<Amazon EC2 Auto Scaling User Guide>. | ||
| 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. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |