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