File Coverage

blib/lib/Paws/AutoScaling/PredefinedMetricSpecification.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::AutoScaling::PredefinedMetricSpecification;
2 1     1   489 use Moose;
  1         3  
  1         8  
3             has PredefinedMetricType => (is => 'ro', isa => 'Str', required => 1);
4             has ResourceLabel => (is => 'ro', isa => 'Str');
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::AutoScaling::PredefinedMetricSpecification
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::AutoScaling::PredefinedMetricSpecification object:
23              
24             $service_obj->Method(Att1 => { PredefinedMetricType => $value, ..., ResourceLabel => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::AutoScaling::PredefinedMetricSpecification object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->PredefinedMetricType
32              
33             =head1 DESCRIPTION
34              
35             Configures a predefined metric for a target tracking policy.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> PredefinedMetricType => Str
41              
42             The metric type.
43              
44              
45             =head2 ResourceLabel => Str
46              
47             Identifies the resource associated with the metric type. The following
48             predefined metrics are available:
49              
50             =over
51              
52             =item *
53              
54             C<ASGAverageCPUUtilization> - average CPU utilization of the Auto
55             Scaling group
56              
57             =item *
58              
59             C<ASGAverageNetworkIn> - average number of bytes received on all
60             network interfaces by the Auto Scaling group
61              
62             =item *
63              
64             C<ASGAverageNetworkOut> - average number of bytes sent out on all
65             network interfaces by the Auto Scaling group
66              
67             =item *
68              
69             C<ALBRequestCountPerTarget> - number of requests completed per target
70             in an Application Load Balancer target group
71              
72             =back
73              
74             For predefined metric types C<ASGAverageCPUUtilization>,
75             C<ASGAverageNetworkIn> and C<ASGAverageNetworkOut>, the parameter must
76             not be specified as the resource associated with the metric type is the
77             Auto Scaling group. For predefined metric type
78             C<ALBRequestCountPerTarget>, the parameter must be specified in the
79             format:
80             C<app/I<load-balancer-name>/I<load-balancer-id>/targetgroup/I<target-group-name>/I<target-group-id>
81             >, where C<app/I<load-balancer-name>/I<load-balancer-id> > is the final
82             portion of the load balancer ARN, and
83             C<targetgroup/I<target-group-name>/I<target-group-id> > is the final
84             portion of the target group ARN. The target group must be attached to
85             the Auto Scaling group.
86              
87              
88              
89             =head1 SEE ALSO
90              
91             This class forms part of L<Paws>, describing an object used in L<Paws::AutoScaling>
92              
93             =head1 BUGS and CONTRIBUTIONS
94              
95             The source code is located here: https://github.com/pplu/aws-sdk-perl
96              
97             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
98              
99             =cut
100