File Coverage

blib/lib/Paws/EMR/SimpleScalingPolicyConfiguration.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::EMR::SimpleScalingPolicyConfiguration;
2 1     1   290 use Moose;
  1         2  
  1         6  
3             has AdjustmentType => (is => 'ro', isa => 'Str');
4             has CoolDown => (is => 'ro', isa => 'Int');
5             has ScalingAdjustment => (is => 'ro', isa => 'Int', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::EMR::SimpleScalingPolicyConfiguration
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::EMR::SimpleScalingPolicyConfiguration object:
24              
25             $service_obj->Method(Att1 => { AdjustmentType => $value, ..., ScalingAdjustment => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::EMR::SimpleScalingPolicyConfiguration object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->AdjustmentType
33              
34             =head1 DESCRIPTION
35              
36             An automatic scaling configuration, which describes how the policy adds
37             or removes instances, the cooldown period, and the number of EC2
38             instances that will be added each time the CloudWatch metric alarm
39             condition is satisfied.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 AdjustmentType => Str
45              
46             The way in which EC2 instances are added (if C<ScalingAdjustment> is a
47             positive number) or terminated (if C<ScalingAdjustment> is a negative
48             number) each time the scaling activity is triggered.
49             C<CHANGE_IN_CAPACITY> is the default. C<CHANGE_IN_CAPACITY> indicates
50             that the EC2 instance count increments or decrements by
51             C<ScalingAdjustment>, which should be expressed as an integer.
52             C<PERCENT_CHANGE_IN_CAPACITY> indicates the instance count increments
53             or decrements by the percentage specified by C<ScalingAdjustment>,
54             which should be expressed as a decimal. For example, 0.20 indicates an
55             increase in 20% increments of cluster capacity. C<EXACT_CAPACITY>
56             indicates the scaling activity results in an instance group with the
57             number of EC2 instances specified by C<ScalingAdjustment>, which should
58             be expressed as a positive integer.
59              
60              
61             =head2 CoolDown => Int
62              
63             The amount of time, in seconds, after a scaling activity completes
64             before any further trigger-related scaling activities can start. The
65             default value is 0.
66              
67              
68             =head2 B<REQUIRED> ScalingAdjustment => Int
69              
70             The amount by which to scale in or scale out, based on the specified
71             C<AdjustmentType>. A positive value adds to the instance group's EC2
72             instance count while a negative number removes instances. If
73             C<AdjustmentType> is set to C<EXACT_CAPACITY>, the number should only
74             be a positive integer. If C<AdjustmentType> is set to
75             C<PERCENT_CHANGE_IN_CAPACITY>, the value should express the percentage
76             as a decimal. For example, -0.20 indicates a decrease in 20% increments
77             of cluster capacity.
78              
79              
80              
81             =head1 SEE ALSO
82              
83             This class forms part of L<Paws>, describing an object used in L<Paws::EMR>
84              
85             =head1 BUGS and CONTRIBUTIONS
86              
87             The source code is located here: https://github.com/pplu/aws-sdk-perl
88              
89             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
90              
91             =cut
92