blib/lib/Paws/AutoScaling/ScalingPolicy.pm

filter: Statementstmt 100% 20 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 1 / 1 Podpod n/a totaltotal 100% 21 / 21 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/AutoScaling/ProcessesType.pm ↑ Summary blib/lib/Paws/AutoScaling/ScheduledActionsType.pm »
1 # Generated by default/object.tt
2 package Paws::AutoScaling::ScalingPolicy;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has AdjustmentType => (is => 'ro', isa => 'Str');
5 1 has Alarms => (is => 'ro', isa => 'ArrayRef[Paws::AutoScaling::Alarm]');
6 1 has AutoScalingGroupName => (is => 'ro', isa => 'Str');
7 1 has Cooldown => (is => 'ro', isa => 'Int');
8 1 has Enabled => (is => 'ro', isa => 'Bool');
9 1 has EstimatedInstanceWarmup => (is => 'ro', isa => 'Int');
10 1 has MetricAggregationType => (is => 'ro', isa => 'Str');
11 1 has MinAdjustmentMagnitude => (is => 'ro', isa => 'Int');
12 1 has MinAdjustmentStep => (is => 'ro', isa => 'Int');
13 1 has PolicyARN => (is => 'ro', isa => 'Str');
14 1 has PolicyName => (is => 'ro', isa => 'Str');
15 1 has PolicyType => (is => 'ro', isa => 'Str');
16 1 has PredictiveScalingConfiguration => (is => 'ro', isa => 'Paws::AutoScaling::PredictiveScalingConfiguration');
17 1 has ScalingAdjustment => (is => 'ro', isa => 'Int');
18 1 has StepAdjustments => (is => 'ro', isa => 'ArrayRef[Paws::AutoScaling::StepAdjustment]');
19 1 has TargetTrackingConfiguration => (is => 'ro', isa => 'Paws::AutoScaling::TargetTrackingConfiguration');
20  
21 1 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::AutoScaling::ScalingPolicy
28  
29 =head1 USAGE
30  
31 This class represents one of two things:
32  
33 =head3 Arguments in a call to a service
34  
35 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
36 Each attribute should be used as a named argument in the calls that expect this type of object.
37  
38 As an example, if Att1 is expected to be a Paws::AutoScaling::ScalingPolicy object:
39  
40 $service_obj->Method(Att1 => { AdjustmentType => $value, ..., TargetTrackingConfiguration => $value });
41  
42 =head3 Results returned from an API call
43  
44 Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::ScalingPolicy object:
45  
46 $result = $service_obj->Method(...);
47 $result->Att1->AdjustmentType
48  
49 =head1 DESCRIPTION
50  
51 Describes a scaling policy.
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 AdjustmentType => Str
57  
58 Specifies how the scaling adjustment is interpreted (for example, an
59 absolute number or a percentage). The valid values are
60 C<ChangeInCapacity>, C<ExactCapacity>, and C<PercentChangeInCapacity>.
61  
62  
63 =head2 Alarms => ArrayRef[L<Paws::AutoScaling::Alarm>]
64  
65 The CloudWatch alarms related to the policy.
66  
67  
68 =head2 AutoScalingGroupName => Str
69  
70 The name of the Auto Scaling group.
71  
72  
73 =head2 Cooldown => Int
74  
75 The duration of the policy's cooldown period, in seconds.
76  
77  
78 =head2 Enabled => Bool
79  
80 Indicates whether the policy is enabled (C<true>) or disabled
81 (C<false>).
82  
83  
84 =head2 EstimatedInstanceWarmup => Int
85  
86 The estimated time, in seconds, until a newly launched instance can
87 contribute to the CloudWatch metrics.
88  
89  
90 =head2 MetricAggregationType => Str
91  
92 The aggregation type for the CloudWatch metrics. The valid values are
93 C<Minimum>, C<Maximum>, and C<Average>.
94  
95  
96 =head2 MinAdjustmentMagnitude => Int
97  
98 The minimum value to scale by when the adjustment type is
99 C<PercentChangeInCapacity>.
100  
101  
102 =head2 MinAdjustmentStep => Int
103  
104 Available for backward compatibility. Use C<MinAdjustmentMagnitude>
105 instead.
106  
107  
108 =head2 PolicyARN => Str
109  
110 The Amazon Resource Name (ARN) of the policy.
111  
112  
113 =head2 PolicyName => Str
114  
115 The name of the scaling policy.
116  
117  
118 =head2 PolicyType => Str
119  
120 One of the following policy types:
121  
122 =over
123  
124 =item *
125  
126 C<TargetTrackingScaling>
127  
128 =item *
129  
130 C<StepScaling>
131  
132 =item *
133  
134 C<SimpleScaling> (default)
135  
136 =item *
137  
138 C<PredictiveScaling>
139  
140 =back
141  
142 For more information, see Target tracking scaling policies
143 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html)
144 and Step and simple scaling policies
145 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html)
146 in the I<Amazon EC2 Auto Scaling User Guide>.
147  
148  
149 =head2 PredictiveScalingConfiguration => L<Paws::AutoScaling::PredictiveScalingConfiguration>
150  
151 A predictive scaling policy.
152  
153  
154 =head2 ScalingAdjustment => Int
155  
156 The amount by which to scale, based on the specified adjustment type. A
157 positive value adds to the current capacity while a negative number
158 removes from the current capacity.
159  
160  
161 =head2 StepAdjustments => ArrayRef[L<Paws::AutoScaling::StepAdjustment>]
162  
163 A set of adjustments that enable you to scale based on the size of the
164 alarm breach.
165  
166  
167 =head2 TargetTrackingConfiguration => L<Paws::AutoScaling::TargetTrackingConfiguration>
168  
169 A target tracking scaling policy.
170  
171  
172  
173 =head1 SEE ALSO
174  
175 This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling>
176  
177 =head1 BUGS and CONTRIBUTIONS
178  
179 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
180  
181 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
182  
183 =cut
184  
« blib/lib/Paws/AutoScaling/ProcessesType.pm ↑ Summary blib/lib/Paws/AutoScaling/ScheduledActionsType.pm »