AWS SDK for C++  1.9.155
AWS SDK for C++
Public Member Functions | List of all members
Aws::ComputeOptimizer::Model::InstanceRecommendationOption Class Reference

#include <InstanceRecommendationOption.h>

Public Member Functions

 InstanceRecommendationOption ()
 
 InstanceRecommendationOption (Aws::Utils::Json::JsonView jsonValue)
 
InstanceRecommendationOptionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const Aws::String &value)
 
void SetInstanceType (Aws::String &&value)
 
void SetInstanceType (const char *value)
 
InstanceRecommendationOptionWithInstanceType (const Aws::String &value)
 
InstanceRecommendationOptionWithInstanceType (Aws::String &&value)
 
InstanceRecommendationOptionWithInstanceType (const char *value)
 
const Aws::Vector< UtilizationMetric > & GetProjectedUtilizationMetrics () const
 
bool ProjectedUtilizationMetricsHasBeenSet () const
 
void SetProjectedUtilizationMetrics (const Aws::Vector< UtilizationMetric > &value)
 
void SetProjectedUtilizationMetrics (Aws::Vector< UtilizationMetric > &&value)
 
InstanceRecommendationOptionWithProjectedUtilizationMetrics (const Aws::Vector< UtilizationMetric > &value)
 
InstanceRecommendationOptionWithProjectedUtilizationMetrics (Aws::Vector< UtilizationMetric > &&value)
 
InstanceRecommendationOptionAddProjectedUtilizationMetrics (const UtilizationMetric &value)
 
InstanceRecommendationOptionAddProjectedUtilizationMetrics (UtilizationMetric &&value)
 
const Aws::Vector< PlatformDifference > & GetPlatformDifferences () const
 
bool PlatformDifferencesHasBeenSet () const
 
void SetPlatformDifferences (const Aws::Vector< PlatformDifference > &value)
 
void SetPlatformDifferences (Aws::Vector< PlatformDifference > &&value)
 
InstanceRecommendationOptionWithPlatformDifferences (const Aws::Vector< PlatformDifference > &value)
 
InstanceRecommendationOptionWithPlatformDifferences (Aws::Vector< PlatformDifference > &&value)
 
InstanceRecommendationOptionAddPlatformDifferences (const PlatformDifference &value)
 
InstanceRecommendationOptionAddPlatformDifferences (PlatformDifference &&value)
 
double GetPerformanceRisk () const
 
bool PerformanceRiskHasBeenSet () const
 
void SetPerformanceRisk (double value)
 
InstanceRecommendationOptionWithPerformanceRisk (double value)
 
int GetRank () const
 
bool RankHasBeenSet () const
 
void SetRank (int value)
 
InstanceRecommendationOptionWithRank (int value)
 
const SavingsOpportunityGetSavingsOpportunity () const
 
bool SavingsOpportunityHasBeenSet () const
 
void SetSavingsOpportunity (const SavingsOpportunity &value)
 
void SetSavingsOpportunity (SavingsOpportunity &&value)
 
InstanceRecommendationOptionWithSavingsOpportunity (const SavingsOpportunity &value)
 
InstanceRecommendationOptionWithSavingsOpportunity (SavingsOpportunity &&value)
 

Detailed Description

Describes a recommendation option for an Amazon EC2 instance.

See Also:

AWS API Reference

Definition at line 36 of file InstanceRecommendationOption.h.

Constructor & Destructor Documentation

◆ InstanceRecommendationOption() [1/2]

Aws::ComputeOptimizer::Model::InstanceRecommendationOption::InstanceRecommendationOption ( )

◆ InstanceRecommendationOption() [2/2]

Aws::ComputeOptimizer::Model::InstanceRecommendationOption::InstanceRecommendationOption ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddPlatformDifferences() [1/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::AddPlatformDifferences ( const PlatformDifference value)
inline

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.

  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.

  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.

  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.

  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.

  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

Definition at line 825 of file InstanceRecommendationOption.h.

◆ AddPlatformDifferences() [2/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::AddPlatformDifferences ( PlatformDifference &&  value)
inline

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.

  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.

  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.

  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.

  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.

  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

Definition at line 917 of file InstanceRecommendationOption.h.

◆ AddProjectedUtilizationMetrics() [1/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::AddProjectedUtilizationMetrics ( const UtilizationMetric value)
inline

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Definition at line 168 of file InstanceRecommendationOption.h.

◆ AddProjectedUtilizationMetrics() [2/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::AddProjectedUtilizationMetrics ( UtilizationMetric &&  value)
inline

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Definition at line 180 of file InstanceRecommendationOption.h.

◆ GetInstanceType()

const Aws::String& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::GetInstanceType ( ) const
inline

The instance type of the instance recommendation.

Definition at line 48 of file InstanceRecommendationOption.h.

◆ GetPerformanceRisk()

double Aws::ComputeOptimizer::Model::InstanceRecommendationOption::GetPerformanceRisk ( ) const
inline

The performance risk of the instance recommendation option.

Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

Definition at line 935 of file InstanceRecommendationOption.h.

◆ GetPlatformDifferences()

const Aws::Vector<PlatformDifference>& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::GetPlatformDifferences ( ) const
inline

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.

  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.

  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.

  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.

  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.

  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

Definition at line 273 of file InstanceRecommendationOption.h.

◆ GetProjectedUtilizationMetrics()

const Aws::Vector<UtilizationMetric>& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::GetProjectedUtilizationMetrics ( ) const
inline

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Definition at line 96 of file InstanceRecommendationOption.h.

◆ GetRank()

int Aws::ComputeOptimizer::Model::InstanceRecommendationOption::GetRank ( ) const
inline

The rank of the instance recommendation option.

The top recommendation option is ranked as 1.

Definition at line 993 of file InstanceRecommendationOption.h.

◆ GetSavingsOpportunity()

const SavingsOpportunity& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::GetSavingsOpportunity ( ) const
inline

An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

Definition at line 1019 of file InstanceRecommendationOption.h.

◆ InstanceTypeHasBeenSet()

bool Aws::ComputeOptimizer::Model::InstanceRecommendationOption::InstanceTypeHasBeenSet ( ) const
inline

The instance type of the instance recommendation.

Definition at line 53 of file InstanceRecommendationOption.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ComputeOptimizer::Model::InstanceRecommendationOption::Jsonize ( ) const

◆ operator=()

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PerformanceRiskHasBeenSet()

bool Aws::ComputeOptimizer::Model::InstanceRecommendationOption::PerformanceRiskHasBeenSet ( ) const
inline

The performance risk of the instance recommendation option.

Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

Definition at line 952 of file InstanceRecommendationOption.h.

◆ PlatformDifferencesHasBeenSet()

bool Aws::ComputeOptimizer::Model::InstanceRecommendationOption::PlatformDifferencesHasBeenSet ( ) const
inline

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.

  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.

  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.

  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.

  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.

  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

Definition at line 365 of file InstanceRecommendationOption.h.

◆ ProjectedUtilizationMetricsHasBeenSet()

bool Aws::ComputeOptimizer::Model::InstanceRecommendationOption::ProjectedUtilizationMetricsHasBeenSet ( ) const
inline

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Definition at line 108 of file InstanceRecommendationOption.h.

◆ RankHasBeenSet()

bool Aws::ComputeOptimizer::Model::InstanceRecommendationOption::RankHasBeenSet ( ) const
inline

The rank of the instance recommendation option.

The top recommendation option is ranked as 1.

Definition at line 999 of file InstanceRecommendationOption.h.

◆ SavingsOpportunityHasBeenSet()

bool Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SavingsOpportunityHasBeenSet ( ) const
inline

An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

Definition at line 1026 of file InstanceRecommendationOption.h.

◆ SetInstanceType() [1/3]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetInstanceType ( Aws::String &&  value)
inline

The instance type of the instance recommendation.

Definition at line 63 of file InstanceRecommendationOption.h.

◆ SetInstanceType() [2/3]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetInstanceType ( const Aws::String value)
inline

The instance type of the instance recommendation.

Definition at line 58 of file InstanceRecommendationOption.h.

◆ SetInstanceType() [3/3]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetInstanceType ( const char *  value)
inline

The instance type of the instance recommendation.

Definition at line 68 of file InstanceRecommendationOption.h.

◆ SetPerformanceRisk()

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetPerformanceRisk ( double  value)
inline

The performance risk of the instance recommendation option.

Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

Definition at line 969 of file InstanceRecommendationOption.h.

◆ SetPlatformDifferences() [1/2]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetPlatformDifferences ( Aws::Vector< PlatformDifference > &&  value)
inline

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.

  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.

  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.

  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.

  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.

  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

Definition at line 549 of file InstanceRecommendationOption.h.

◆ SetPlatformDifferences() [2/2]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetPlatformDifferences ( const Aws::Vector< PlatformDifference > &  value)
inline

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.

  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.

  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.

  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.

  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.

  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

Definition at line 457 of file InstanceRecommendationOption.h.

◆ SetProjectedUtilizationMetrics() [1/2]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetProjectedUtilizationMetrics ( Aws::Vector< UtilizationMetric > &&  value)
inline

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Definition at line 132 of file InstanceRecommendationOption.h.

◆ SetProjectedUtilizationMetrics() [2/2]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetProjectedUtilizationMetrics ( const Aws::Vector< UtilizationMetric > &  value)
inline

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Definition at line 120 of file InstanceRecommendationOption.h.

◆ SetRank()

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetRank ( int  value)
inline

The rank of the instance recommendation option.

The top recommendation option is ranked as 1.

Definition at line 1005 of file InstanceRecommendationOption.h.

◆ SetSavingsOpportunity() [1/2]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetSavingsOpportunity ( const SavingsOpportunity value)
inline

An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

Definition at line 1033 of file InstanceRecommendationOption.h.

◆ SetSavingsOpportunity() [2/2]

void Aws::ComputeOptimizer::Model::InstanceRecommendationOption::SetSavingsOpportunity ( SavingsOpportunity &&  value)
inline

An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

Definition at line 1040 of file InstanceRecommendationOption.h.

◆ WithInstanceType() [1/3]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithInstanceType ( Aws::String &&  value)
inline

The instance type of the instance recommendation.

Definition at line 78 of file InstanceRecommendationOption.h.

◆ WithInstanceType() [2/3]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithInstanceType ( const Aws::String value)
inline

The instance type of the instance recommendation.

Definition at line 73 of file InstanceRecommendationOption.h.

◆ WithInstanceType() [3/3]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithInstanceType ( const char *  value)
inline

The instance type of the instance recommendation.

Definition at line 83 of file InstanceRecommendationOption.h.

◆ WithPerformanceRisk()

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithPerformanceRisk ( double  value)
inline

The performance risk of the instance recommendation option.

Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

Definition at line 986 of file InstanceRecommendationOption.h.

◆ WithPlatformDifferences() [1/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithPlatformDifferences ( Aws::Vector< PlatformDifference > &&  value)
inline

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.

  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.

  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.

  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.

  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.

  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

Definition at line 733 of file InstanceRecommendationOption.h.

◆ WithPlatformDifferences() [2/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithPlatformDifferences ( const Aws::Vector< PlatformDifference > &  value)
inline

Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.

Platform differences include:

  • Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.

  • NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.

  • StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.

  • InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.

  • VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.

  • Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an Arm CPU architecture and the current instance type might use a different one, such as x86. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.

Definition at line 641 of file InstanceRecommendationOption.h.

◆ WithProjectedUtilizationMetrics() [1/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithProjectedUtilizationMetrics ( Aws::Vector< UtilizationMetric > &&  value)
inline

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Definition at line 156 of file InstanceRecommendationOption.h.

◆ WithProjectedUtilizationMetrics() [2/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithProjectedUtilizationMetrics ( const Aws::Vector< UtilizationMetric > &  value)
inline

An array of objects that describe the projected utilization metrics of the instance recommendation option.

The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Definition at line 144 of file InstanceRecommendationOption.h.

◆ WithRank()

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithRank ( int  value)
inline

The rank of the instance recommendation option.

The top recommendation option is ranked as 1.

Definition at line 1011 of file InstanceRecommendationOption.h.

◆ WithSavingsOpportunity() [1/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithSavingsOpportunity ( const SavingsOpportunity value)
inline

An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

Definition at line 1047 of file InstanceRecommendationOption.h.

◆ WithSavingsOpportunity() [2/2]

InstanceRecommendationOption& Aws::ComputeOptimizer::Model::InstanceRecommendationOption::WithSavingsOpportunity ( SavingsOpportunity &&  value)
inline

An object that describes the savings opportunity for the instance recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

Definition at line 1054 of file InstanceRecommendationOption.h.


The documentation for this class was generated from the following file: