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

filter: Statementstmt 0.0% 0 / 25 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 26 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::InstanceRecommendation;
3 use Moose;
4 has AccountId => (is => 'ro', isa => 'Str', request_name => 'accountId', traits => ['NameInRequest']);
5 has CurrentInstanceType => (is => 'ro', isa => 'Str', request_name => 'currentInstanceType', traits => ['NameInRequest']);
6 has Finding => (is => 'ro', isa => 'Str', request_name => 'finding', traits => ['NameInRequest']);
7 has FindingReasonCodes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'findingReasonCodes', traits => ['NameInRequest']);
8 has InstanceArn => (is => 'ro', isa => 'Str', request_name => 'instanceArn', traits => ['NameInRequest']);
9 has InstanceName => (is => 'ro', isa => 'Str', request_name => 'instanceName', traits => ['NameInRequest']);
10 has LastRefreshTimestamp => (is => 'ro', isa => 'Str', request_name => 'lastRefreshTimestamp', traits => ['NameInRequest']);
11 has LookBackPeriodInDays => (is => 'ro', isa => 'Num', request_name => 'lookBackPeriodInDays', traits => ['NameInRequest']);
12 has RecommendationOptions => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::InstanceRecommendationOption]', request_name => 'recommendationOptions', traits => ['NameInRequest']);
13 has RecommendationSources => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::RecommendationSource]', request_name => 'recommendationSources', traits => ['NameInRequest']);
14 has UtilizationMetrics => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::UtilizationMetric]', request_name => 'utilizationMetrics', traits => ['NameInRequest']);
15  
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::ComputeOptimizer::InstanceRecommendation
23  
24 =head1 USAGE
25  
26 This class represents one of two things:
27  
28 =head3 Arguments in a call to a service
29  
30 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31 Each attribute should be used as a named argument in the calls that expect this type of object.
32  
33 As an example, if Att1 is expected to be a Paws::ComputeOptimizer::InstanceRecommendation object:
34  
35 $service_obj->Method(Att1 => { AccountId => $value, ..., UtilizationMetrics => $value });
36  
37 =head3 Results returned from an API call
38  
39 Use accessors for each attribute. If Att1 is expected to be an Paws::ComputeOptimizer::InstanceRecommendation object:
40  
41 $result = $service_obj->Method(...);
42 $result->Att1->AccountId
43  
44 =head1 DESCRIPTION
45  
46 Describes an Amazon EC2 instance recommendation.
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 AccountId => Str
52  
53 The AWS account ID of the instance.
54  
55  
56 =head2 CurrentInstanceType => Str
57  
58 The instance type of the current instance.
59  
60  
61 =head2 Finding => Str
62  
63 The finding classification of the instance.
64  
65 Findings for instances include:
66  
67 =over
68  
69 =item *
70  
71 B<C<Underprovisioned> >E<mdash>An instance is considered
72 under-provisioned when at least one specification of your instance,
73 such as CPU, memory, or network, does not meet the performance
74 requirements of your workload. Under-provisioned instances may lead to
75 poor application performance.
76  
77 =item *
78  
79 B<C<Overprovisioned> >E<mdash>An instance is considered
80 over-provisioned when at least one specification of your instance, such
81 as CPU, memory, or network, can be sized down while still meeting the
82 performance requirements of your workload, and no specification is
83 under-provisioned. Over-provisioned instances may lead to unnecessary
84 infrastructure cost.
85  
86 =item *
87  
88 B<C<Optimized> >E<mdash>An instance is considered optimized when all
89 specifications of your instance, such as CPU, memory, and network, meet
90 the performance requirements of your workload and is not over
91 provisioned. For optimized resources, AWS Compute Optimizer might
92 recommend a new generation instance type.
93  
94 =back
95  
96  
97  
98 =head2 FindingReasonCodes => ArrayRef[Str|Undef]
99  
100 The reason for the finding classification of the instance.
101  
102 Finding reason codes for instances include:
103  
104 =over
105  
106 =item *
107  
108 B<C<CPUOverprovisioned> > E<mdash> The instanceE<rsquo>s CPU
109 configuration can be sized down while still meeting the performance
110 requirements of your workload. This is identified by analyzing the
111 C<CPUUtilization> metric of the current instance during the look-back
112 period.
113  
114 =item *
115  
116 B<C<CPUUnderprovisioned> > E<mdash> The instanceE<rsquo>s CPU
117 configuration doesn't meet the performance requirements of your
118 workload and there is an alternative instance type that provides better
119 CPU performance. This is identified by analyzing the C<CPUUtilization>
120 metric of the current instance during the look-back period.
121  
122 =item *
123  
124 B<C<MemoryOverprovisioned> > E<mdash> The instanceE<rsquo>s memory
125 configuration can be sized down while still meeting the performance
126 requirements of your workload. This is identified by analyzing the
127 memory utilization metric of the current instance during the look-back
128 period.
129  
130 =item *
131  
132 B<C<MemoryUnderprovisioned> > E<mdash> The instanceE<rsquo>s memory
133 configuration doesn't meet the performance requirements of your
134 workload and there is an alternative instance type that provides better
135 memory performance. This is identified by analyzing the memory
136 utilization metric of the current instance during the look-back period.
137  
138 Memory utilization is analyzed only for resources that have the unified
139 CloudWatch agent installed on them. For more information, see Enabling
140 memory utilization with the Amazon CloudWatch Agent
141 (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent)
142 in the I<AWS Compute Optimizer User Guide>. On Linux instances, Compute
143 Optimizer analyses the C<mem_used_percent> metric in the C<CWAgent>
144 namespace, or the legacy C<MemoryUtilization> metric in the
145 C<System/Linux> namespace. On Windows instances, Compute Optimizer
146 analyses the C<Memory % Committed Bytes In Use> metric in the
147 C<CWAgent> namespace.
148  
149 =item *
150  
151 B<C<EBSThroughputOverprovisioned> > E<mdash> The instanceE<rsquo>s EBS
152 throughput configuration can be sized down while still meeting the
153 performance requirements of your workload. This is identified by
154 analyzing the C<VolumeReadOps> and C<VolumeWriteOps> metrics of EBS
155 volumes attached to the current instance during the look-back period.
156  
157 =item *
158  
159 B<C<EBSThroughputUnderprovisioned> > E<mdash> The instanceE<rsquo>s EBS
160 throughput configuration doesn't meet the performance requirements of
161 your workload and there is an alternative instance type that provides
162 better EBS throughput performance. This is identified by analyzing the
163 C<VolumeReadOps> and C<VolumeWriteOps> metrics of EBS volumes attached
164 to the current instance during the look-back period.
165  
166 =item *
167  
168 B<C<EBSIOPSOverprovisioned> > E<mdash> The instanceE<rsquo>s EBS IOPS
169 configuration can be sized down while still meeting the performance
170 requirements of your workload. This is identified by analyzing the
171 C<VolumeReadBytes> and C<VolumeWriteBytes> metric of EBS volumes
172 attached to the current instance during the look-back period.
173  
174 =item *
175  
176 B<C<EBSIOPSUnderprovisioned> > E<mdash> The instanceE<rsquo>s EBS IOPS
177 configuration doesn't meet the performance requirements of your
178 workload and there is an alternative instance type that provides better
179 EBS IOPS performance. This is identified by analyzing the
180 C<VolumeReadBytes> and C<VolumeWriteBytes> metric of EBS volumes
181 attached to the current instance during the look-back period.
182  
183 =item *
184  
185 B<C<NetworkBandwidthOverprovisioned> > E<mdash> The instanceE<rsquo>s
186 network bandwidth configuration can be sized down while still meeting
187 the performance requirements of your workload. This is identified by
188 analyzing the C<NetworkIn> and C<NetworkOut> metrics of the current
189 instance during the look-back period.
190  
191 =item *
192  
193 B<C<NetworkBandwidthUnderprovisioned> > E<mdash> The instanceE<rsquo>s
194 network bandwidth configuration doesn't meet the performance
195 requirements of your workload and there is an alternative instance type
196 that provides better network bandwidth performance. This is identified
197 by analyzing the C<NetworkIn> and C<NetworkOut> metrics of the current
198 instance during the look-back period. This finding reason happens when
199 the C<NetworkIn> or C<NetworkOut> performance of an instance is
200 impacted.
201  
202 =item *
203  
204 B<C<NetworkPPSOverprovisioned> > E<mdash> The instanceE<rsquo>s network
205 PPS (packets per second) configuration can be sized down while still
206 meeting the performance requirements of your workload. This is
207 identified by analyzing the C<NetworkPacketsIn> and C<NetworkPacketsIn>
208 metrics of the current instance during the look-back period.
209  
210 =item *
211  
212 B<C<NetworkPPSUnderprovisioned> > E<mdash> The instanceE<rsquo>s
213 network PPS (packets per second) configuration doesn't meet the
214 performance requirements of your workload and there is an alternative
215 instance type that provides better network PPS performance. This is
216 identified by analyzing the C<NetworkPacketsIn> and C<NetworkPacketsIn>
217 metrics of the current instance during the look-back period.
218  
219 =item *
220  
221 B<C<DiskIOPSOverprovisioned> > E<mdash> The instanceE<rsquo>s disk IOPS
222 configuration can be sized down while still meeting the performance
223 requirements of your workload. This is identified by analyzing the
224 C<DiskReadOps> and C<DiskWriteOps> metrics of the current instance
225 during the look-back period.
226  
227 =item *
228  
229 B<C<DiskIOPSUnderprovisioned> > E<mdash> The instanceE<rsquo>s disk
230 IOPS configuration doesn't meet the performance requirements of your
231 workload and there is an alternative instance type that provides better
232 disk IOPS performance. This is identified by analyzing the
233 C<DiskReadOps> and C<DiskWriteOps> metrics of the current instance
234 during the look-back period.
235  
236 =item *
237  
238 B<C<DiskThroughputOverprovisioned> > E<mdash> The instanceE<rsquo>s
239 disk throughput configuration can be sized down while still meeting the
240 performance requirements of your workload. This is identified by
241 analyzing the C<DiskReadBytes> and C<DiskWriteBytes> metrics of the
242 current instance during the look-back period.
243  
244 =item *
245  
246 B<C<DiskThroughputUnderprovisioned> > E<mdash> The instanceE<rsquo>s
247 disk throughput configuration doesn't meet the performance requirements
248 of your workload and there is an alternative instance type that
249 provides better disk throughput performance. This is identified by
250 analyzing the C<DiskReadBytes> and C<DiskWriteBytes> metrics of the
251 current instance during the look-back period.
252  
253 =back
254  
255 For more information about instance metrics, see List the available
256 CloudWatch metrics for your instances
257 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/viewing_metrics_with_cloudwatch.html)
258 in the I<Amazon Elastic Compute Cloud User Guide>. For more information
259 about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS
260 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using_cloudwatch_ebs.html)
261 in the I<Amazon Elastic Compute Cloud User Guide>.
262  
263  
264 =head2 InstanceArn => Str
265  
266 The Amazon Resource Name (ARN) of the current instance.
267  
268  
269 =head2 InstanceName => Str
270  
271 The name of the current instance.
272  
273  
274 =head2 LastRefreshTimestamp => Str
275  
276 The time stamp of when the instance recommendation was last refreshed.
277  
278  
279 =head2 LookBackPeriodInDays => Num
280  
281 The number of days for which utilization metrics were analyzed for the
282 instance.
283  
284  
285 =head2 RecommendationOptions => ArrayRef[L<Paws::ComputeOptimizer::InstanceRecommendationOption>]
286  
287 An array of objects that describe the recommendation options for the
288 instance.
289  
290  
291 =head2 RecommendationSources => ArrayRef[L<Paws::ComputeOptimizer::RecommendationSource>]
292  
293 An array of objects that describe the source resource of the
294 recommendation.
295  
296  
297 =head2 UtilizationMetrics => ArrayRef[L<Paws::ComputeOptimizer::UtilizationMetric>]
298  
299 An array of objects that describe the utilization metrics of the
300 instance.
301  
302  
303  
304 =head1 SEE ALSO
305  
306 This class forms part of L<Paws>, describing an object used in L<Paws::ComputeOptimizer>
307  
308 =head1 BUGS and CONTRIBUTIONS
309  
310 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
311  
312 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
313  
314 =cut
315