« blib/lib/Paws/ComputeOptimizer/InstanceRecommendation.pm
↑ Summary
blib/lib/Paws/ComputeOptimizer/JobFilter.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ComputeOptimizer::InstanceRecommendationOption; | ||
| 3 | use Moose; | ||
| 4 | has InstanceType => (is => 'ro', isa => 'Str', request_name => 'instanceType', traits => ['NameInRequest']); | ||
| 5 | has PerformanceRisk => (is => 'ro', isa => 'Num', request_name => 'performanceRisk', traits => ['NameInRequest']); | ||
| 6 | has PlatformDifferences => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'platformDifferences', traits => ['NameInRequest']); | ||
| 7 | has ProjectedUtilizationMetrics => (is => 'ro', isa => 'ArrayRef[Paws::ComputeOptimizer::UtilizationMetric]', request_name => 'projectedUtilizationMetrics', traits => ['NameInRequest']); | ||
| 8 | has Rank => (is => 'ro', isa => 'Int', request_name => 'rank', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::ComputeOptimizer::InstanceRecommendationOption | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::ComputeOptimizer::InstanceRecommendationOption object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { InstanceType => $value, ..., Rank => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::ComputeOptimizer::InstanceRecommendationOption object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->InstanceType | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Describes a recommendation option for an Amazon EC2 instance. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 InstanceType => Str | ||
| 46 | |||
| 47 | The instance type of the instance recommendation. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 PerformanceRisk => Num | ||
| 51 | |||
| 52 | The performance risk of the instance recommendation option. | ||
| 53 | |||
| 54 | Performance risk indicates the likelihood of the recommended instance | ||
| 55 | type not meeting the resource needs of your workload. Compute Optimizer | ||
| 56 | calculates an individual performance risk score for each specification | ||
| 57 | of the recommended instance, including CPU, memory, EBS throughput, EBS | ||
| 58 | IOPS, disk throughput, disk IOPS, network throughput, and network PPS. | ||
| 59 | The performance risk of the recommended instance is calculated as the | ||
| 60 | maximum performance risk score across the analyzed resource | ||
| 61 | specifications. | ||
| 62 | |||
| 63 | The value ranges from C<0> to C<5>, with C<0> meaning that the | ||
| 64 | recommended resource is predicted to always provide enough hardware | ||
| 65 | capability. The higher the performance risk is, the more likely you | ||
| 66 | should validate whether the recommendation will meet the performance | ||
| 67 | requirements of your workload before migrating your resource. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 PlatformDifferences => ArrayRef[Str|Undef] | ||
| 71 | |||
| 72 | Describes the configuration differences between the current instance | ||
| 73 | and the recommended instance type. You should consider the | ||
| 74 | configuration differences before migrating your workloads from the | ||
| 75 | current instance to the recommended instance type. The Change the | ||
| 76 | instance type guide for Linux | ||
| 77 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html) | ||
| 78 | and Change the instance type guide for Windows | ||
| 79 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-resize.html) | ||
| 80 | provide general guidance for getting started with an instance | ||
| 81 | migration. | ||
| 82 | |||
| 83 | Platform differences include: | ||
| 84 | |||
| 85 | =over | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | B<C<Hypervisor> > E<mdash> The hypervisor of the recommended instance | ||
| 90 | type is different than that of the current instance. For example, the | ||
| 91 | recommended instance type uses a Nitro hypervisor and the current | ||
| 92 | instance uses a Xen hypervisor. The differences that you should | ||
| 93 | consider between these hypervisors are covered in the Nitro Hypervisor | ||
| 94 | (http://aws.amazon.com/ec2/faqs/#Nitro_Hypervisor) section of the | ||
| 95 | Amazon EC2 frequently asked questions. For more information, see | ||
| 96 | Instances built on the Nitro System | ||
| 97 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances) | ||
| 98 | in the I<Amazon EC2 User Guide for Linux>, or Instances built on the | ||
| 99 | Nitro System | ||
| 100 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#ec2-nitro-instances) | ||
| 101 | in the I<Amazon EC2 User Guide for Windows>. | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | B<C<NetworkInterface> > E<mdash> The network interface of the | ||
| 106 | recommended instance type is different than that of the current | ||
| 107 | instance. For example, the recommended instance type supports enhanced | ||
| 108 | networking and the current instance might not. To enable enhanced | ||
| 109 | networking for the recommended instance type, you will need to install | ||
| 110 | the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual | ||
| 111 | Function driver. For more information, see Networking and storage | ||
| 112 | features | ||
| 113 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) | ||
| 114 | and Enhanced networking on Linux | ||
| 115 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enhanced-networking.html) | ||
| 116 | in the I<Amazon EC2 User Guide for Linux>, or Networking and storage | ||
| 117 | features | ||
| 118 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) | ||
| 119 | and Enhanced networking on Windows | ||
| 120 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/enhanced-networking.html) | ||
| 121 | in the I<Amazon EC2 User Guide for Windows>. | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | B<C<StorageInterface> > E<mdash> The storage interface of the | ||
| 126 | recommended instance type is different than that of the current | ||
| 127 | instance. For example, the recommended instance type uses an NVMe | ||
| 128 | storage interface and the current instance does not. To access NVMe | ||
| 129 | volumes for the recommended instance type, you will need to install or | ||
| 130 | upgrade the NVMe driver. For more information, see Networking and | ||
| 131 | storage features | ||
| 132 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) | ||
| 133 | and Amazon EBS and NVMe on Linux instances | ||
| 134 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nvme-ebs-volumes.html) | ||
| 135 | in the I<Amazon EC2 User Guide for Linux>, or Networking and storage | ||
| 136 | features | ||
| 137 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) | ||
| 138 | and Amazon EBS and NVMe on Windows instances | ||
| 139 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/nvme-ebs-volumes.html) | ||
| 140 | in the I<Amazon EC2 User Guide for Windows>. | ||
| 141 | |||
| 142 | =item * | ||
| 143 | |||
| 144 | B<C<InstanceStoreAvailability> > E<mdash> The recommended instance type | ||
| 145 | does not support instance store volumes and the current instance does. | ||
| 146 | Before migrating, you might need to back up the data on your instance | ||
| 147 | store volumes if you want to preserve them. For more information, see | ||
| 148 | How do I back up an instance store volume on my Amazon EC2 instance to | ||
| 149 | Amazon EBS? | ||
| 150 | (https://aws.amazon.com/premiumsupport/knowledge-center/back-up-instance-store-ebs/) | ||
| 151 | in the I<AWS Premium Support Knowledge Base>. For more information, see | ||
| 152 | Networking and storage features | ||
| 153 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#instance-networking-storage) | ||
| 154 | and Amazon EC2 instance store | ||
| 155 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) | ||
| 156 | in the I<Amazon EC2 User Guide for Linux>, or see Networking and | ||
| 157 | storage features | ||
| 158 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/instance-types.html#instance-networking-storage) | ||
| 159 | and Amazon EC2 instance store | ||
| 160 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/InstanceStorage.html) | ||
| 161 | in the I<Amazon EC2 User Guide for Windows>. | ||
| 162 | |||
| 163 | =item * | ||
| 164 | |||
| 165 | B<C<VirtualizationType> > E<mdash> The recommended instance type uses | ||
| 166 | the hardware virtual machine (HVM) virtualization type and the current | ||
| 167 | instance uses the paravirtual (PV) virtualization type. For more | ||
| 168 | information about the differences between these virtualization types, | ||
| 169 | see Linux AMI virtualization types | ||
| 170 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/virtualization_types.html) | ||
| 171 | in the I<Amazon EC2 User Guide for Linux>, or Windows AMI | ||
| 172 | virtualization types | ||
| 173 | (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/windows-ami-version-history.html#virtualization-types) | ||
| 174 | in the I<Amazon EC2 User Guide for Windows>. | ||
| 175 | |||
| 176 | =back | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head2 ProjectedUtilizationMetrics => ArrayRef[L<Paws::ComputeOptimizer::UtilizationMetric>] | ||
| 181 | |||
| 182 | An array of objects that describe the projected utilization metrics of | ||
| 183 | the instance recommendation option. | ||
| 184 | |||
| 185 | The C<Cpu> and C<Memory> metrics are the only projected utilization | ||
| 186 | metrics returned. Additionally, the C<Memory> metric is returned only | ||
| 187 | for resources that have the unified CloudWatch agent installed on them. | ||
| 188 | For more information, see Enabling Memory Utilization with the | ||
| 189 | CloudWatch Agent | ||
| 190 | (https://docs.aws.amazon.com/compute-optimizer/latest/ug/metrics.html#cw-agent). | ||
| 191 | |||
| 192 | |||
| 193 | =head2 Rank => Int | ||
| 194 | |||
| 195 | The rank of the instance recommendation option. | ||
| 196 | |||
| 197 | The top recommendation option is ranked as C<1>. | ||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | =head1 SEE ALSO | ||
| 202 | |||
| 203 | This class forms part of L<Paws>, describing an object used in L<Paws::ComputeOptimizer> | ||
| 204 | |||
| 205 | =head1 BUGS and CONTRIBUTIONS | ||
| 206 | |||
| 207 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 208 | |||
| 209 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 210 | |||
| 211 | =cut | ||
| 212 |