« blib/lib/Paws/AutoScalingPlans/TagFilter.pm
↑ Summary
blib/lib/Paws/AutoScalingPlans/UpdateScalingPlan.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AutoScalingPlans::TargetTrackingConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has CustomizedScalingMetricSpecification => (is => 'ro', isa => 'Paws::AutoScalingPlans::CustomizedScalingMetricSpecification'); | ||
| 5 | has DisableScaleIn => (is => 'ro', isa => 'Bool'); | ||
| 6 | has EstimatedInstanceWarmup => (is => 'ro', isa => 'Int'); | ||
| 7 | has PredefinedScalingMetricSpecification => (is => 'ro', isa => 'Paws::AutoScalingPlans::PredefinedScalingMetricSpecification'); | ||
| 8 | has ScaleInCooldown => (is => 'ro', isa => 'Int'); | ||
| 9 | has ScaleOutCooldown => (is => 'ro', isa => 'Int'); | ||
| 10 | has TargetValue => (is => 'ro', isa => 'Num', required => 1); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::AutoScalingPlans::TargetTrackingConfiguration | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::AutoScalingPlans::TargetTrackingConfiguration object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { CustomizedScalingMetricSpecification => $value, ..., TargetValue => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScalingPlans::TargetTrackingConfiguration object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->CustomizedScalingMetricSpecification | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Describes a target tracking configuration to use with AWS Auto Scaling. | ||
| 43 | Used with ScalingInstruction and ScalingPolicy. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 CustomizedScalingMetricSpecification => L<Paws::AutoScalingPlans::CustomizedScalingMetricSpecification> | ||
| 49 | |||
| 50 | A customized metric. You can specify either a predefined metric or a | ||
| 51 | customized metric. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 DisableScaleIn => Bool | ||
| 55 | |||
| 56 | Indicates whether scale in by the target tracking scaling policy is | ||
| 57 | disabled. If the value is C<true>, scale in is disabled and the target | ||
| 58 | tracking scaling policy doesn't remove capacity from the scalable | ||
| 59 | resource. Otherwise, scale in is enabled and the target tracking | ||
| 60 | scaling policy can remove capacity from the scalable resource. | ||
| 61 | |||
| 62 | The default value is C<false>. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 EstimatedInstanceWarmup => Int | ||
| 66 | |||
| 67 | The estimated time, in seconds, until a newly launched instance can | ||
| 68 | contribute to the CloudWatch metrics. This value is used only if the | ||
| 69 | resource is an Auto Scaling group. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 PredefinedScalingMetricSpecification => L<Paws::AutoScalingPlans::PredefinedScalingMetricSpecification> | ||
| 73 | |||
| 74 | A predefined metric. You can specify either a predefined metric or a | ||
| 75 | customized metric. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ScaleInCooldown => Int | ||
| 79 | |||
| 80 | The amount of time, in seconds, after a scale-in activity completes | ||
| 81 | before another scale-in activity can start. This property is not used | ||
| 82 | if the scalable resource is an Auto Scaling group. | ||
| 83 | |||
| 84 | With the I<scale-in cooldown period>, the intention is to scale in | ||
| 85 | conservatively to protect your applicationE<rsquo>s availability, so | ||
| 86 | scale-in activities are blocked until the cooldown period has expired. | ||
| 87 | However, if another alarm triggers a scale-out activity during the | ||
| 88 | scale-in cooldown period, Auto Scaling scales out the target | ||
| 89 | immediately. In this case, the scale-in cooldown period stops and | ||
| 90 | doesn't complete. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 ScaleOutCooldown => Int | ||
| 94 | |||
| 95 | The amount of time, in seconds, to wait for a previous scale-out | ||
| 96 | activity to take effect. This property is not used if the scalable | ||
| 97 | resource is an Auto Scaling group. | ||
| 98 | |||
| 99 | With the I<scale-out cooldown period>, the intention is to continuously | ||
| 100 | (but not excessively) scale out. After Auto Scaling successfully scales | ||
| 101 | out using a target tracking scaling policy, it starts to calculate the | ||
| 102 | cooldown time. The scaling policy won't increase the desired capacity | ||
| 103 | again unless either a larger scale out is triggered or the cooldown | ||
| 104 | period ends. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> TargetValue => Num | ||
| 108 | |||
| 109 | The target value for the metric. Although this property accepts numbers | ||
| 110 | of type Double, it won't accept values that are either too small or too | ||
| 111 | large. Values must be in the range of -2^360 to 2^360. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head1 SEE ALSO | ||
| 116 | |||
| 117 | This class forms part of L<Paws>, describing an object used in L<Paws::AutoScalingPlans> | ||
| 118 | |||
| 119 | =head1 BUGS and CONTRIBUTIONS | ||
| 120 | |||
| 121 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 122 | |||
| 123 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 124 | |||
| 125 | =cut | ||
| 126 |