File Coverage

blib/lib/Paws/ApplicationAutoScaling/TargetTrackingScalingPolicyConfiguration.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration;
2 1     1   418 use Moose;
  1         3  
  1         8  
3             has CustomizedMetricSpecification => (is => 'ro', isa => 'Paws::ApplicationAutoScaling::CustomizedMetricSpecification');
4             has DisableScaleIn => (is => 'ro', isa => 'Bool');
5             has PredefinedMetricSpecification => (is => 'ro', isa => 'Paws::ApplicationAutoScaling::PredefinedMetricSpecification');
6             has ScaleInCooldown => (is => 'ro', isa => 'Int');
7             has ScaleOutCooldown => (is => 'ro', isa => 'Int');
8             has TargetValue => (is => 'ro', isa => 'Num', required => 1);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration object:
27              
28             $service_obj->Method(Att1 => { CustomizedMetricSpecification => $value, ..., TargetValue => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->CustomizedMetricSpecification
36              
37             =head1 DESCRIPTION
38              
39             Represents a target tracking scaling policy configuration.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 CustomizedMetricSpecification => L<Paws::ApplicationAutoScaling::CustomizedMetricSpecification>
45              
46             Reserved for future use.
47              
48              
49             =head2 DisableScaleIn => Bool
50              
51             Indicates whether scale in by the target tracking policy is disabled.
52             If the value is C<true>, scale in is disabled and the target tracking
53             policy won't remove capacity from the scalable resource. Otherwise,
54             scale in is enabled and the target tracking policy can remove capacity
55             from the scalable resource. The default value is C<false>.
56              
57              
58             =head2 PredefinedMetricSpecification => L<Paws::ApplicationAutoScaling::PredefinedMetricSpecification>
59              
60             A predefined metric.
61              
62              
63             =head2 ScaleInCooldown => Int
64              
65             The amount of time, in seconds, after a scale in activity completes
66             before another scale in activity can start.
67              
68             The cooldown period is used to block subsequent scale in requests until
69             it has expired. The intention is to scale in conservatively to protect
70             your application's availability. However, if another alarm triggers a
71             scale out policy during the cooldown period after a scale-in,
72             Application Auto Scaling scales out your scalable target immediately.
73              
74              
75             =head2 ScaleOutCooldown => Int
76              
77             The amount of time, in seconds, after a scale out activity completes
78             before another scale out activity can start.
79              
80             While the cooldown period is in effect, the capacity that has been
81             added by the previous scale out event that initiated the cooldown is
82             calculated as part of the desired capacity for the next scale out. The
83             intention is to continuously (but not excessively) scale out.
84              
85              
86             =head2 B<REQUIRED> TargetValue => Num
87              
88             The target value for the metric. The range is 8.515920e-109 to
89             1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
90              
91              
92              
93             =head1 SEE ALSO
94              
95             This class forms part of L<Paws>, describing an object used in L<Paws::ApplicationAutoScaling>
96              
97             =head1 BUGS and CONTRIBUTIONS
98              
99             The source code is located here: https://github.com/pplu/aws-sdk-perl
100              
101             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
102              
103             =cut
104