blib/lib/Paws/ComputeOptimizer/UtilizationMetric.pm untested

filter: Statementstmt 0.0% 0 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 10 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ComputeOptimizer::UtilizationMetric;
3 use Moose;
4 has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']);
5 has Statistic => (is => 'ro', isa => 'Str', request_name => 'statistic', traits => ['NameInRequest']);
6 has Value => (is => 'ro', isa => 'Num', request_name => 'value', traits => ['NameInRequest']);
7  
8 1;
9  
10 ### main pod documentation begin ###
11  
12 =head1 NAME
13  
14 Paws::ComputeOptimizer::UtilizationMetric
15  
16 =head1 USAGE
17  
18 This class represents one of two things:
19  
20 =head3 Arguments in a call to a service
21  
22 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23 Each attribute should be used as a named argument in the calls that expect this type of object.
24  
25 As an example, if Att1 is expected to be a Paws::ComputeOptimizer::UtilizationMetric object:
26  
27 $service_obj->Method(Att1 => { Name => $value, ..., Value => $value });
28  
29 =head3 Results returned from an API call
30  
31 Use accessors for each attribute. If Att1 is expected to be an Paws::ComputeOptimizer::UtilizationMetric object:
32  
33 $result = $service_obj->Method(...);
34 $result->Att1->Name
35  
36 =head1 DESCRIPTION
37  
38 Describes a utilization metric of a resource, such as an Amazon EC2
39 instance.
40  
41 Compare the utilization metric data of your resource against its
42 projected utilization metric data to determine the performance
43 difference between your current resource and the recommended option.
44  
45 =head1 ATTRIBUTES
46  
47  
48 =head2 Name => Str
49  
50 The name of the utilization metric.
51  
52 The following utilization metrics are available:
53  
54 =over
55  
56 =item *
57  
58 C<Cpu> - The percentage of allocated EC2 compute units that are
59 currently in use on the instance. This metric identifies the processing
60 power required to run an application on the instance.
61  
62 Depending on the instance type, tools in your operating system can show
63 a lower percentage than CloudWatch when the instance is not allocated a
64 full processor core.
65  
66 Units: Percent
67  
68 =item *
69  
70 C<Memory> - The percentage of memory that is currently in use on the
71 instance. This metric identifies the amount of memory required to run
72 an application on the instance.
73  
74 Units: Percent
75  
76 The C<Memory> metric is returned only for resources that have the
77 unified CloudWatch agent installed on them. For more information, see
78 Enabling Memory Utilization with the CloudWatch Agent
79 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent).
80  
81 =item *
82  
83 C<EBS_READ_OPS_PER_SECOND> - The completed read operations from all EBS
84 volumes attached to the instance in a specified period of time.
85  
86 Unit: Count
87  
88 =item *
89  
90 C<EBS_WRITE_OPS_PER_SECOND> - The completed write operations to all EBS
91 volumes attached to the instance in a specified period of time.
92  
93 Unit: Count
94  
95 =item *
96  
97 C<EBS_READ_BYTES_PER_SECOND> - The bytes read from all EBS volumes
98 attached to the instance in a specified period of time.
99  
100 Unit: Bytes
101  
102 =item *
103  
104 C<EBS_WRITE_BYTES_PER_SECOND> - The bytes written to all EBS volumes
105 attached to the instance in a specified period of time.
106  
107 Unit: Bytes
108  
109 =item *
110  
111 C<DISK_READ_OPS_PER_SECOND> - The completed read operations from all
112 instance store volumes available to the instance in a specified period
113 of time.
114  
115 If there are no instance store volumes, either the value is C<0> or the
116 metric is not reported.
117  
118 =item *
119  
120 C<DISK_WRITE_OPS_PER_SECOND> - The completed write operations from all
121 instance store volumes available to the instance in a specified period
122 of time.
123  
124 If there are no instance store volumes, either the value is C<0> or the
125 metric is not reported.
126  
127 =item *
128  
129 C<DISK_READ_BYTES_PER_SECOND> - The bytes read from all instance store
130 volumes available to the instance. This metric is used to determine the
131 volume of the data the application reads from the disk of the instance.
132 This can be used to determine the speed of the application.
133  
134 If there are no instance store volumes, either the value is C<0> or the
135 metric is not reported.
136  
137 =item *
138  
139 C<DISK_WRITE_BYTES_PER_SECOND> - The bytes written to all instance
140 store volumes available to the instance. This metric is used to
141 determine the volume of the data the application writes onto the disk
142 of the instance. This can be used to determine the speed of the
143 application.
144  
145 If there are no instance store volumes, either the value is C<0> or the
146 metric is not reported.
147  
148 =item *
149  
150 C<NETWORK_IN_BYTES_PER_SECOND> - The number of bytes received by the
151 instance on all network interfaces. This metric identifies the volume
152 of incoming network traffic to a single instance.
153  
154 =item *
155  
156 C<NETWORK_OUT_BYTES_PER_SECOND> - The number of bytes sent out by the
157 instance on all network interfaces. This metric identifies the volume
158 of outgoing network traffic from a single instance.
159  
160 =item *
161  
162 C<NETWORK_PACKETS_IN_PER_SECOND> - The number of packets received by
163 the instance on all network interfaces. This metric identifies the
164 volume of incoming traffic in terms of the number of packets on a
165 single instance.
166  
167 =item *
168  
169 C<NETWORK_PACKETS_OUT_PER_SECOND> - The number of packets sent out by
170 the instance on all network interfaces. This metric identifies the
171 volume of outgoing traffic in terms of the number of packets on a
172 single instance.
173  
174 =back
175  
176  
177  
178 =head2 Statistic => Str
179  
180 The statistic of the utilization metric.
181  
182 The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and
183 SDKs return utilization metrics using only the C<Maximum> statistic,
184 which is the highest value observed during the specified period.
185  
186 The Compute Optimizer console displays graphs for some utilization
187 metrics using the C<Average> statistic, which is the value of C<Sum> /
188 C<SampleCount> during the specified period. For more information, see
189 Viewing resource recommendations
190 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html)
191 in the I<AWS Compute Optimizer User Guide>. You can also get averaged
192 utilization metric data for your resources using Amazon CloudWatch. For
193 more information, see the Amazon CloudWatch User Guide
194 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).
195  
196  
197 =head2 Value => Num
198  
199 The value of the utilization metric.
200  
201  
202  
203 =head1 SEE ALSO
204  
205 This class forms part of L<Paws>, describing an object used in L<Paws::ComputeOptimizer>
206  
207 =head1 BUGS and CONTRIBUTIONS
208  
209 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
210  
211 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
212  
213 =cut
214