File Coverage

blib/lib/Paws/OpsWorks/AutoScalingThresholds.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::OpsWorks::AutoScalingThresholds;
2 1     1   411 use Moose;
  1         7  
  1         11  
3             has Alarms => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
4             has CpuThreshold => (is => 'ro', isa => 'Num');
5             has IgnoreMetricsTime => (is => 'ro', isa => 'Int');
6             has InstanceCount => (is => 'ro', isa => 'Int');
7             has LoadThreshold => (is => 'ro', isa => 'Num');
8             has MemoryThreshold => (is => 'ro', isa => 'Num');
9             has ThresholdsWaitTime => (is => 'ro', isa => 'Int');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::OpsWorks::AutoScalingThresholds
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::OpsWorks::AutoScalingThresholds object:
28              
29             $service_obj->Method(Att1 => { Alarms => $value, ..., ThresholdsWaitTime => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::OpsWorks::AutoScalingThresholds object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->Alarms
37              
38             =head1 DESCRIPTION
39              
40             Describes a load-based auto scaling upscaling or downscaling threshold
41             configuration, which specifies when AWS OpsWorks Stacks starts or stops
42             load-based instances.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 Alarms => ArrayRef[Str|Undef]
48              
49             Custom Cloudwatch auto scaling alarms, to be used as thresholds. This
50             parameter takes a list of up to five alarm names, which are case
51             sensitive and must be in the same region as the stack.
52              
53             To use custom alarms, you must update your service role to allow
54             C<cloudwatch:DescribeAlarms>. You can either have AWS OpsWorks Stacks
55             update the role for you when you first use this feature or you can edit
56             the role manually. For more information, see Allowing AWS OpsWorks
57             Stacks to Act on Your Behalf.
58              
59              
60             =head2 CpuThreshold => Num
61              
62             The CPU utilization threshold, as a percent of the available CPU. A
63             value of -1 disables the threshold.
64              
65              
66             =head2 IgnoreMetricsTime => Int
67              
68             The amount of time (in minutes) after a scaling event occurs that AWS
69             OpsWorks Stacks should ignore metrics and suppress additional scaling
70             events. For example, AWS OpsWorks Stacks adds new instances following
71             an upscaling event but the instances won't start reducing the load
72             until they have been booted and configured. There is no point in
73             raising additional scaling events during that operation, which
74             typically takes several minutes. C<IgnoreMetricsTime> allows you to
75             direct AWS OpsWorks Stacks to suppress scaling events long enough to
76             get the new instances online.
77              
78              
79             =head2 InstanceCount => Int
80              
81             The number of instances to add or remove when the load exceeds a
82             threshold.
83              
84              
85             =head2 LoadThreshold => Num
86              
87             The load threshold. A value of -1 disables the threshold. For more
88             information about how load is computed, see Load (computing).
89              
90              
91             =head2 MemoryThreshold => Num
92              
93             The memory utilization threshold, as a percent of the available memory.
94             A value of -1 disables the threshold.
95              
96              
97             =head2 ThresholdsWaitTime => Int
98              
99             The amount of time, in minutes, that the load must exceed a threshold
100             before more instances are added or removed.
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, describing an object used in L<Paws::OpsWorks>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115