File Coverage

blib/lib/Paws/AutoScaling/ScalingPolicy.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1				package Paws::AutoScaling::ScalingPolicy;
2	1	1	512	use Moose;
	1	1	3
	1		11
	1		493
	1		2
	1		7
3				has AdjustmentType => (is => 'ro', isa => 'Str');
4				has Alarms => (is => 'ro', isa => 'ArrayRef[Paws::AutoScaling::Alarm]');
5				has AutoScalingGroupName => (is => 'ro', isa => 'Str');
6				has Cooldown => (is => 'ro', isa => 'Int');
7				has EstimatedInstanceWarmup => (is => 'ro', isa => 'Int');
8				has MetricAggregationType => (is => 'ro', isa => 'Str');
9				has MinAdjustmentMagnitude => (is => 'ro', isa => 'Int');
10				has MinAdjustmentStep => (is => 'ro', isa => 'Int');
11				has PolicyARN => (is => 'ro', isa => 'Str');
12				has PolicyName => (is => 'ro', isa => 'Str');
13				has PolicyType => (is => 'ro', isa => 'Str');
14				has ScalingAdjustment => (is => 'ro', isa => 'Int');
15				has StepAdjustments => (is => 'ro', isa => 'ArrayRef[Paws::AutoScaling::StepAdjustment]');
16				has TargetTrackingConfiguration => (is => 'ro', isa => 'Paws::AutoScaling::TargetTrackingConfiguration');
17				1;
18
19				### main pod documentation begin ###
20
21				=head1 NAME
22
23				Paws::AutoScaling::ScalingPolicy
24
25				=head1 USAGE
26
27				This class represents one of two things:
28
29				=head3 Arguments in a call to a service
30
31				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
32				Each attribute should be used as a named argument in the calls that expect this type of object.
33
34				As an example, if Att1 is expected to be a Paws::AutoScaling::ScalingPolicy object:
35
36				$service_obj->Method(Att1 => { AdjustmentType => $value, ..., TargetTrackingConfiguration => $value });
37
38				=head3 Results returned from an API call
39
40				Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::ScalingPolicy object:
41
42				$result = $service_obj->Method(...);
43				$result->Att1->AdjustmentType
44
45				=head1 DESCRIPTION
46
47				Describes a scaling policy.
48
49				=head1 ATTRIBUTES
50
51
52				=head2 AdjustmentType => Str
53
54				The adjustment type, which specifies how C<ScalingAdjustment> is
55				interpreted. Valid values are C<ChangeInCapacity>, C<ExactCapacity>,
56				and C<PercentChangeInCapacity>.
57
58
59				=head2 Alarms => ArrayRef[L<Paws::AutoScaling::Alarm>]
60
61				The CloudWatch alarms related to the policy.
62
63
64				=head2 AutoScalingGroupName => Str
65
66				The name of the Auto Scaling group associated with this scaling policy.
67
68
69				=head2 Cooldown => Int
70
71				The amount of time, in seconds, after a scaling activity completes
72				before any further dynamic scaling activities can start.
73
74
75				=head2 EstimatedInstanceWarmup => Int
76
77				The estimated time, in seconds, until a newly launched instance can
78				contribute to the CloudWatch metrics.
79
80
81				=head2 MetricAggregationType => Str
82
83				The aggregation type for the CloudWatch metrics. Valid values are
84				C<Minimum>, C<Maximum>, and C<Average>.
85
86
87				=head2 MinAdjustmentMagnitude => Int
88
89				The minimum number of instances to scale. If the value of
90				C<AdjustmentType> is C<PercentChangeInCapacity>, the scaling policy
91				changes the C<DesiredCapacity> of the Auto Scaling group by at least
92				this many instances. Otherwise, the error is C<ValidationError>.
93
94
95				=head2 MinAdjustmentStep => Int
96
97				Available for backward compatibility. Use C<MinAdjustmentMagnitude>
98				instead.
99
100
101				=head2 PolicyARN => Str
102
103				The Amazon Resource Name (ARN) of the policy.
104
105
106				=head2 PolicyName => Str
107
108				The name of the scaling policy.
109
110
111				=head2 PolicyType => Str
112
113				The policy type. Valid values are C<SimpleScaling> and C<StepScaling>.
114
115
116				=head2 ScalingAdjustment => Int
117
118				The amount by which to scale, based on the specified adjustment type. A
119				positive value adds to the current capacity while a negative number
120				removes from the current capacity.
121
122
123				=head2 StepAdjustments => ArrayRef[L<Paws::AutoScaling::StepAdjustment>]
124
125				A set of adjustments that enable you to scale based on the size of the
126				alarm breach.
127
128
129				=head2 TargetTrackingConfiguration => L<Paws::AutoScaling::TargetTrackingConfiguration>
130
131				A target tracking policy.
132
133
134
135				=head1 SEE ALSO
136
137				This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling>
138
139				=head1 BUGS and CONTRIBUTIONS
140
141				The source code is located here: https://github.com/pplu/aws-sdk-perl
142
143				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
144
145				=cut
146