File Coverage

blib/lib/Paws/AutoScaling/ExecutePolicy.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 bran cond sub pod time code
1              
2             package Paws::AutoScaling::ExecutePolicy;
3 1     1   572 use Moose;
  1         2  
  1         9  
4             has AutoScalingGroupName => (is => 'ro', isa => 'Str');
5             has BreachThreshold => (is => 'ro', isa => 'Num');
6             has HonorCooldown => (is => 'ro', isa => 'Bool');
7             has MetricValue => (is => 'ro', isa => 'Num');
8             has PolicyName => (is => 'ro', isa => 'Str', required => 1);
9              
10 1     1   8871 use MooseX::ClassAttribute;
  1         4  
  1         12  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExecutePolicy');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::AutoScaling::ExecutePolicy - Arguments for method ExecutePolicy on Paws::AutoScaling
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method ExecutePolicy on the
26             Auto Scaling service. Use the attributes of this class
27             as arguments to method ExecutePolicy.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExecutePolicy.
30              
31             As an example:
32              
33             $service_obj->ExecutePolicy(Att1 => $value1, Att2 => $value2, ...);
34              
35             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 AutoScalingGroupName => Str
41              
42             The name or Amazon Resource Name (ARN) of the Auto Scaling group.
43              
44              
45              
46             =head2 BreachThreshold => Num
47              
48             The breach threshold for the alarm.
49              
50             This parameter is required if the policy type is C<StepScaling> and not
51             supported otherwise.
52              
53              
54              
55             =head2 HonorCooldown => Bool
56              
57             If this parameter is true, Auto Scaling waits for the cooldown period
58             to complete before executing the policy. Otherwise, Auto Scaling
59             executes the policy without waiting for the cooldown period to
60             complete.
61              
62             This parameter is not supported if the policy type is C<StepScaling>.
63              
64             For more information, see Auto Scaling Cooldowns in the I<Auto Scaling
65             User Guide>.
66              
67              
68              
69             =head2 MetricValue => Num
70              
71             The metric value to compare to C<BreachThreshold>. This enables you to
72             execute a policy of type C<StepScaling> and determine which step
73             adjustment to use. For example, if the breach threshold is 50 and you
74             want to use a step adjustment with a lower bound of 0 and an upper
75             bound of 10, you can set the metric value to 59.
76              
77             If you specify a metric value that doesn't correspond to a step
78             adjustment for the policy, the call returns an error.
79              
80             This parameter is required if the policy type is C<StepScaling> and not
81             supported otherwise.
82              
83              
84              
85             =head2 B<REQUIRED> PolicyName => Str
86              
87             The name or ARN of the policy.
88              
89              
90              
91              
92             =head1 SEE ALSO
93              
94             This class forms part of L<Paws>, documenting arguments for method ExecutePolicy in L<Paws::AutoScaling>
95              
96             =head1 BUGS and CONTRIBUTIONS
97              
98             The source code is located here: https://github.com/pplu/aws-sdk-perl
99              
100             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
101              
102             =cut
103