File Coverage

blib/lib/Paws/EMR/CloudWatchAlarmDefinition.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::CloudWatchAlarmDefinition;
2 1     1   281 use Moose;
  1         3  
  1         6  
3             has ComparisonOperator => (is => 'ro', isa => 'Str', required => 1);
4             has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::EMR::MetricDimension]');
5             has EvaluationPeriods => (is => 'ro', isa => 'Int');
6             has MetricName => (is => 'ro', isa => 'Str', required => 1);
7             has Namespace => (is => 'ro', isa => 'Str');
8             has Period => (is => 'ro', isa => 'Int', required => 1);
9             has Statistic => (is => 'ro', isa => 'Str');
10             has Threshold => (is => 'ro', isa => 'Num', required => 1);
11             has Unit => (is => 'ro', isa => 'Str');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::EMR::CloudWatchAlarmDefinition
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::EMR::CloudWatchAlarmDefinition object:
30              
31             $service_obj->Method(Att1 => { ComparisonOperator => $value, ..., Unit => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::EMR::CloudWatchAlarmDefinition object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->ComparisonOperator
39              
40             =head1 DESCRIPTION
41              
42             The definition of a CloudWatch metric alarm, which determines when an
43             automatic scaling activity is triggered. When the defined alarm
44             conditions are satisfied, scaling activity begins.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 B<REQUIRED> ComparisonOperator => Str
50              
51             Determines how the metric specified by C<MetricName> is compared to the
52             value specified by C<Threshold>.
53              
54              
55             =head2 Dimensions => ArrayRef[L<Paws::EMR::MetricDimension>]
56              
57             A CloudWatch metric dimension.
58              
59              
60             =head2 EvaluationPeriods => Int
61              
62             The number of periods, expressed in seconds using C<Period>, during
63             which the alarm condition must exist before the alarm triggers
64             automatic scaling activity. The default value is C<1>.
65              
66              
67             =head2 B<REQUIRED> MetricName => Str
68              
69             The name of the CloudWatch metric that is watched to determine an alarm
70             condition.
71              
72              
73             =head2 Namespace => Str
74              
75             The namespace for the CloudWatch metric. The default is
76             C<AWS/ElasticMapReduce>.
77              
78              
79             =head2 B<REQUIRED> Period => Int
80              
81             The period, in seconds, over which the statistic is applied. EMR
82             CloudWatch metrics are emitted every five minutes (300 seconds), so if
83             an EMR CloudWatch metric is specified, specify C<300>.
84              
85              
86             =head2 Statistic => Str
87              
88             The statistic to apply to the metric associated with the alarm. The
89             default is C<AVERAGE>.
90              
91              
92             =head2 B<REQUIRED> Threshold => Num
93              
94             The value against which the specified statistic is compared.
95              
96              
97             =head2 Unit => Str
98              
99             The unit of measure associated with the CloudWatch metric being
100             watched. The value specified for C<Unit> must correspond to the units
101             specified in the CloudWatch metric.
102              
103              
104              
105             =head1 SEE ALSO
106              
107             This class forms part of L<Paws>, describing an object used in L<Paws::EMR>
108              
109             =head1 BUGS and CONTRIBUTIONS
110              
111             The source code is located here: https://github.com/pplu/aws-sdk-perl
112              
113             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
114              
115             =cut
116