/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace ComputeOptimizer { namespace Model { /** *

Describes a utilization metric of a resource, such as an Amazon EC2 * instance.

Compare the utilization metric data of your resource against * its projected utilization metric data to determine the performance difference * between your current resource and the recommended option.

See * Also:

AWS * API Reference

*/ class UtilizationMetric { public: AWS_COMPUTEOPTIMIZER_API UtilizationMetric(); AWS_COMPUTEOPTIMIZER_API UtilizationMetric(Aws::Utils::Json::JsonView jsonValue); AWS_COMPUTEOPTIMIZER_API UtilizationMetric& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_COMPUTEOPTIMIZER_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the utilization metric.

The following utilization metrics * are available:

  • Cpu - The percentage of allocated * EC2 compute units that are currently in use on the instance. This metric * identifies the processing power required to run an application on the * instance.

    Depending on the instance type, tools in your operating system * can show a lower percentage than CloudWatch when the instance is not allocated a * full processor core.

    Units: Percent

  • * Memory - The percentage of memory that is currently in use on the * instance. This metric identifies the amount of memory required to run an * application on the instance.

    Units: Percent

    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.

  • * EBS_READ_OPS_PER_SECOND - The completed read operations from all * EBS volumes attached to the instance in a specified period of time.

    Unit: * Count

  • EBS_WRITE_OPS_PER_SECOND - The completed * write operations to all EBS volumes attached to the instance in a specified * period of time.

    Unit: Count

  • * EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes * attached to the instance in a specified period of time.

    Unit: Bytes

    *
  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to * all EBS volumes attached to the instance in a specified period of time.

    *

    Unit: Bytes

  • DISK_READ_OPS_PER_SECOND - The * completed read operations from all instance store volumes available to the * instance in a specified period of time.

    If there are no instance store * volumes, either the value is 0 or the metric is not reported.

    *
  • DISK_WRITE_OPS_PER_SECOND - The completed write * operations from all instance store volumes available to the instance in a * specified period of time.

    If there are no instance store volumes, either * the value is 0 or the metric is not reported.

  • * DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store * volumes available to the instance. This metric is used to determine the volume * of the data the application reads from the disk of the instance. This can be * used to determine the speed of the application.

    If there are no instance * store volumes, either the value is 0 or the metric is not * reported.

  • DISK_WRITE_BYTES_PER_SECOND - The * bytes written to all instance store volumes available to the instance. This * metric is used to determine the volume of the data the application writes onto * the disk of the instance. This can be used to determine the speed of the * application.

    If there are no instance store volumes, either the value is * 0 or the metric is not reported.

  • * NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the * instance on all network interfaces. This metric identifies the volume of * incoming network traffic to a single instance.

  • * NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the * instance on all network interfaces. This metric identifies the volume of * outgoing network traffic from a single instance.

  • * NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by * the instance on all network interfaces. This metric identifies the volume of * incoming traffic in terms of the number of packets on a single instance.

    *
  • NETWORK_PACKETS_OUT_PER_SECOND - The number of * packets sent out by the instance on all network interfaces. This metric * identifies the volume of outgoing traffic in terms of the number of packets on a * single instance.

*/ inline const MetricName& GetName() const{ return m_name; } /** *

The name of the utilization metric.

The following utilization metrics * are available:

  • Cpu - The percentage of allocated * EC2 compute units that are currently in use on the instance. This metric * identifies the processing power required to run an application on the * instance.

    Depending on the instance type, tools in your operating system * can show a lower percentage than CloudWatch when the instance is not allocated a * full processor core.

    Units: Percent

  • * Memory - The percentage of memory that is currently in use on the * instance. This metric identifies the amount of memory required to run an * application on the instance.

    Units: Percent

    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.

  • * EBS_READ_OPS_PER_SECOND - The completed read operations from all * EBS volumes attached to the instance in a specified period of time.

    Unit: * Count

  • EBS_WRITE_OPS_PER_SECOND - The completed * write operations to all EBS volumes attached to the instance in a specified * period of time.

    Unit: Count

  • * EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes * attached to the instance in a specified period of time.

    Unit: Bytes

    *
  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to * all EBS volumes attached to the instance in a specified period of time.

    *

    Unit: Bytes

  • DISK_READ_OPS_PER_SECOND - The * completed read operations from all instance store volumes available to the * instance in a specified period of time.

    If there are no instance store * volumes, either the value is 0 or the metric is not reported.

    *
  • DISK_WRITE_OPS_PER_SECOND - The completed write * operations from all instance store volumes available to the instance in a * specified period of time.

    If there are no instance store volumes, either * the value is 0 or the metric is not reported.

  • * DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store * volumes available to the instance. This metric is used to determine the volume * of the data the application reads from the disk of the instance. This can be * used to determine the speed of the application.

    If there are no instance * store volumes, either the value is 0 or the metric is not * reported.

  • DISK_WRITE_BYTES_PER_SECOND - The * bytes written to all instance store volumes available to the instance. This * metric is used to determine the volume of the data the application writes onto * the disk of the instance. This can be used to determine the speed of the * application.

    If there are no instance store volumes, either the value is * 0 or the metric is not reported.

  • * NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the * instance on all network interfaces. This metric identifies the volume of * incoming network traffic to a single instance.

  • * NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the * instance on all network interfaces. This metric identifies the volume of * outgoing network traffic from a single instance.

  • * NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by * the instance on all network interfaces. This metric identifies the volume of * incoming traffic in terms of the number of packets on a single instance.

    *
  • NETWORK_PACKETS_OUT_PER_SECOND - The number of * packets sent out by the instance on all network interfaces. This metric * identifies the volume of outgoing traffic in terms of the number of packets on a * single instance.

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

The name of the utilization metric.

The following utilization metrics * are available:

  • Cpu - The percentage of allocated * EC2 compute units that are currently in use on the instance. This metric * identifies the processing power required to run an application on the * instance.

    Depending on the instance type, tools in your operating system * can show a lower percentage than CloudWatch when the instance is not allocated a * full processor core.

    Units: Percent

  • * Memory - The percentage of memory that is currently in use on the * instance. This metric identifies the amount of memory required to run an * application on the instance.

    Units: Percent

    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.

  • * EBS_READ_OPS_PER_SECOND - The completed read operations from all * EBS volumes attached to the instance in a specified period of time.

    Unit: * Count

  • EBS_WRITE_OPS_PER_SECOND - The completed * write operations to all EBS volumes attached to the instance in a specified * period of time.

    Unit: Count

  • * EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes * attached to the instance in a specified period of time.

    Unit: Bytes

    *
  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to * all EBS volumes attached to the instance in a specified period of time.

    *

    Unit: Bytes

  • DISK_READ_OPS_PER_SECOND - The * completed read operations from all instance store volumes available to the * instance in a specified period of time.

    If there are no instance store * volumes, either the value is 0 or the metric is not reported.

    *
  • DISK_WRITE_OPS_PER_SECOND - The completed write * operations from all instance store volumes available to the instance in a * specified period of time.

    If there are no instance store volumes, either * the value is 0 or the metric is not reported.

  • * DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store * volumes available to the instance. This metric is used to determine the volume * of the data the application reads from the disk of the instance. This can be * used to determine the speed of the application.

    If there are no instance * store volumes, either the value is 0 or the metric is not * reported.

  • DISK_WRITE_BYTES_PER_SECOND - The * bytes written to all instance store volumes available to the instance. This * metric is used to determine the volume of the data the application writes onto * the disk of the instance. This can be used to determine the speed of the * application.

    If there are no instance store volumes, either the value is * 0 or the metric is not reported.

  • * NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the * instance on all network interfaces. This metric identifies the volume of * incoming network traffic to a single instance.

  • * NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the * instance on all network interfaces. This metric identifies the volume of * outgoing network traffic from a single instance.

  • * NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by * the instance on all network interfaces. This metric identifies the volume of * incoming traffic in terms of the number of packets on a single instance.

    *
  • NETWORK_PACKETS_OUT_PER_SECOND - The number of * packets sent out by the instance on all network interfaces. This metric * identifies the volume of outgoing traffic in terms of the number of packets on a * single instance.

*/ inline void SetName(const MetricName& value) { m_nameHasBeenSet = true; m_name = value; } /** *

The name of the utilization metric.

The following utilization metrics * are available:

  • Cpu - The percentage of allocated * EC2 compute units that are currently in use on the instance. This metric * identifies the processing power required to run an application on the * instance.

    Depending on the instance type, tools in your operating system * can show a lower percentage than CloudWatch when the instance is not allocated a * full processor core.

    Units: Percent

  • * Memory - The percentage of memory that is currently in use on the * instance. This metric identifies the amount of memory required to run an * application on the instance.

    Units: Percent

    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.

  • * EBS_READ_OPS_PER_SECOND - The completed read operations from all * EBS volumes attached to the instance in a specified period of time.

    Unit: * Count

  • EBS_WRITE_OPS_PER_SECOND - The completed * write operations to all EBS volumes attached to the instance in a specified * period of time.

    Unit: Count

  • * EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes * attached to the instance in a specified period of time.

    Unit: Bytes

    *
  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to * all EBS volumes attached to the instance in a specified period of time.

    *

    Unit: Bytes

  • DISK_READ_OPS_PER_SECOND - The * completed read operations from all instance store volumes available to the * instance in a specified period of time.

    If there are no instance store * volumes, either the value is 0 or the metric is not reported.

    *
  • DISK_WRITE_OPS_PER_SECOND - The completed write * operations from all instance store volumes available to the instance in a * specified period of time.

    If there are no instance store volumes, either * the value is 0 or the metric is not reported.

  • * DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store * volumes available to the instance. This metric is used to determine the volume * of the data the application reads from the disk of the instance. This can be * used to determine the speed of the application.

    If there are no instance * store volumes, either the value is 0 or the metric is not * reported.

  • DISK_WRITE_BYTES_PER_SECOND - The * bytes written to all instance store volumes available to the instance. This * metric is used to determine the volume of the data the application writes onto * the disk of the instance. This can be used to determine the speed of the * application.

    If there are no instance store volumes, either the value is * 0 or the metric is not reported.

  • * NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the * instance on all network interfaces. This metric identifies the volume of * incoming network traffic to a single instance.

  • * NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the * instance on all network interfaces. This metric identifies the volume of * outgoing network traffic from a single instance.

  • * NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by * the instance on all network interfaces. This metric identifies the volume of * incoming traffic in terms of the number of packets on a single instance.

    *
  • NETWORK_PACKETS_OUT_PER_SECOND - The number of * packets sent out by the instance on all network interfaces. This metric * identifies the volume of outgoing traffic in terms of the number of packets on a * single instance.

*/ inline void SetName(MetricName&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

The name of the utilization metric.

The following utilization metrics * are available:

  • Cpu - The percentage of allocated * EC2 compute units that are currently in use on the instance. This metric * identifies the processing power required to run an application on the * instance.

    Depending on the instance type, tools in your operating system * can show a lower percentage than CloudWatch when the instance is not allocated a * full processor core.

    Units: Percent

  • * Memory - The percentage of memory that is currently in use on the * instance. This metric identifies the amount of memory required to run an * application on the instance.

    Units: Percent

    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.

  • * EBS_READ_OPS_PER_SECOND - The completed read operations from all * EBS volumes attached to the instance in a specified period of time.

    Unit: * Count

  • EBS_WRITE_OPS_PER_SECOND - The completed * write operations to all EBS volumes attached to the instance in a specified * period of time.

    Unit: Count

  • * EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes * attached to the instance in a specified period of time.

    Unit: Bytes

    *
  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to * all EBS volumes attached to the instance in a specified period of time.

    *

    Unit: Bytes

  • DISK_READ_OPS_PER_SECOND - The * completed read operations from all instance store volumes available to the * instance in a specified period of time.

    If there are no instance store * volumes, either the value is 0 or the metric is not reported.

    *
  • DISK_WRITE_OPS_PER_SECOND - The completed write * operations from all instance store volumes available to the instance in a * specified period of time.

    If there are no instance store volumes, either * the value is 0 or the metric is not reported.

  • * DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store * volumes available to the instance. This metric is used to determine the volume * of the data the application reads from the disk of the instance. This can be * used to determine the speed of the application.

    If there are no instance * store volumes, either the value is 0 or the metric is not * reported.

  • DISK_WRITE_BYTES_PER_SECOND - The * bytes written to all instance store volumes available to the instance. This * metric is used to determine the volume of the data the application writes onto * the disk of the instance. This can be used to determine the speed of the * application.

    If there are no instance store volumes, either the value is * 0 or the metric is not reported.

  • * NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the * instance on all network interfaces. This metric identifies the volume of * incoming network traffic to a single instance.

  • * NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the * instance on all network interfaces. This metric identifies the volume of * outgoing network traffic from a single instance.

  • * NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by * the instance on all network interfaces. This metric identifies the volume of * incoming traffic in terms of the number of packets on a single instance.

    *
  • NETWORK_PACKETS_OUT_PER_SECOND - The number of * packets sent out by the instance on all network interfaces. This metric * identifies the volume of outgoing traffic in terms of the number of packets on a * single instance.

*/ inline UtilizationMetric& WithName(const MetricName& value) { SetName(value); return *this;} /** *

The name of the utilization metric.

The following utilization metrics * are available:

  • Cpu - The percentage of allocated * EC2 compute units that are currently in use on the instance. This metric * identifies the processing power required to run an application on the * instance.

    Depending on the instance type, tools in your operating system * can show a lower percentage than CloudWatch when the instance is not allocated a * full processor core.

    Units: Percent

  • * Memory - The percentage of memory that is currently in use on the * instance. This metric identifies the amount of memory required to run an * application on the instance.

    Units: Percent

    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.

  • * EBS_READ_OPS_PER_SECOND - The completed read operations from all * EBS volumes attached to the instance in a specified period of time.

    Unit: * Count

  • EBS_WRITE_OPS_PER_SECOND - The completed * write operations to all EBS volumes attached to the instance in a specified * period of time.

    Unit: Count

  • * EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes * attached to the instance in a specified period of time.

    Unit: Bytes

    *
  • EBS_WRITE_BYTES_PER_SECOND - The bytes written to * all EBS volumes attached to the instance in a specified period of time.

    *

    Unit: Bytes

  • DISK_READ_OPS_PER_SECOND - The * completed read operations from all instance store volumes available to the * instance in a specified period of time.

    If there are no instance store * volumes, either the value is 0 or the metric is not reported.

    *
  • DISK_WRITE_OPS_PER_SECOND - The completed write * operations from all instance store volumes available to the instance in a * specified period of time.

    If there are no instance store volumes, either * the value is 0 or the metric is not reported.

  • * DISK_READ_BYTES_PER_SECOND - The bytes read from all instance store * volumes available to the instance. This metric is used to determine the volume * of the data the application reads from the disk of the instance. This can be * used to determine the speed of the application.

    If there are no instance * store volumes, either the value is 0 or the metric is not * reported.

  • DISK_WRITE_BYTES_PER_SECOND - The * bytes written to all instance store volumes available to the instance. This * metric is used to determine the volume of the data the application writes onto * the disk of the instance. This can be used to determine the speed of the * application.

    If there are no instance store volumes, either the value is * 0 or the metric is not reported.

  • * NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the * instance on all network interfaces. This metric identifies the volume of * incoming network traffic to a single instance.

  • * NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by the * instance on all network interfaces. This metric identifies the volume of * outgoing network traffic from a single instance.

  • * NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by * the instance on all network interfaces. This metric identifies the volume of * incoming traffic in terms of the number of packets on a single instance.

    *
  • NETWORK_PACKETS_OUT_PER_SECOND - The number of * packets sent out by the instance on all network interfaces. This metric * identifies the volume of outgoing traffic in terms of the number of packets on a * single instance.

*/ inline UtilizationMetric& WithName(MetricName&& value) { SetName(std::move(value)); return *this;} /** *

The statistic of the utilization metric.

The Compute Optimizer API, * Command Line Interface (CLI), and SDKs return utilization metrics using only the * Maximum statistic, which is the highest value observed during the * specified period.

The Compute Optimizer console displays graphs for some * utilization metrics using the Average statistic, which is the value * of Sum / SampleCount during the specified period. For * more information, see Viewing * resource recommendations in the Compute Optimizer User Guide. You can * also get averaged utilization metric data for your resources using Amazon * CloudWatch. For more information, see the Amazon * CloudWatch User Guide.

*/ inline const MetricStatistic& GetStatistic() const{ return m_statistic; } /** *

The statistic of the utilization metric.

The Compute Optimizer API, * Command Line Interface (CLI), and SDKs return utilization metrics using only the * Maximum statistic, which is the highest value observed during the * specified period.

The Compute Optimizer console displays graphs for some * utilization metrics using the Average statistic, which is the value * of Sum / SampleCount during the specified period. For * more information, see Viewing * resource recommendations in the Compute Optimizer User Guide. You can * also get averaged utilization metric data for your resources using Amazon * CloudWatch. For more information, see the Amazon * CloudWatch User Guide.

*/ inline bool StatisticHasBeenSet() const { return m_statisticHasBeenSet; } /** *

The statistic of the utilization metric.

The Compute Optimizer API, * Command Line Interface (CLI), and SDKs return utilization metrics using only the * Maximum statistic, which is the highest value observed during the * specified period.

The Compute Optimizer console displays graphs for some * utilization metrics using the Average statistic, which is the value * of Sum / SampleCount during the specified period. For * more information, see Viewing * resource recommendations in the Compute Optimizer User Guide. You can * also get averaged utilization metric data for your resources using Amazon * CloudWatch. For more information, see the Amazon * CloudWatch User Guide.

*/ inline void SetStatistic(const MetricStatistic& value) { m_statisticHasBeenSet = true; m_statistic = value; } /** *

The statistic of the utilization metric.

The Compute Optimizer API, * Command Line Interface (CLI), and SDKs return utilization metrics using only the * Maximum statistic, which is the highest value observed during the * specified period.

The Compute Optimizer console displays graphs for some * utilization metrics using the Average statistic, which is the value * of Sum / SampleCount during the specified period. For * more information, see Viewing * resource recommendations in the Compute Optimizer User Guide. You can * also get averaged utilization metric data for your resources using Amazon * CloudWatch. For more information, see the Amazon * CloudWatch User Guide.

*/ inline void SetStatistic(MetricStatistic&& value) { m_statisticHasBeenSet = true; m_statistic = std::move(value); } /** *

The statistic of the utilization metric.

The Compute Optimizer API, * Command Line Interface (CLI), and SDKs return utilization metrics using only the * Maximum statistic, which is the highest value observed during the * specified period.

The Compute Optimizer console displays graphs for some * utilization metrics using the Average statistic, which is the value * of Sum / SampleCount during the specified period. For * more information, see Viewing * resource recommendations in the Compute Optimizer User Guide. You can * also get averaged utilization metric data for your resources using Amazon * CloudWatch. For more information, see the Amazon * CloudWatch User Guide.

*/ inline UtilizationMetric& WithStatistic(const MetricStatistic& value) { SetStatistic(value); return *this;} /** *

The statistic of the utilization metric.

The Compute Optimizer API, * Command Line Interface (CLI), and SDKs return utilization metrics using only the * Maximum statistic, which is the highest value observed during the * specified period.

The Compute Optimizer console displays graphs for some * utilization metrics using the Average statistic, which is the value * of Sum / SampleCount during the specified period. For * more information, see Viewing * resource recommendations in the Compute Optimizer User Guide. You can * also get averaged utilization metric data for your resources using Amazon * CloudWatch. For more information, see the Amazon * CloudWatch User Guide.

*/ inline UtilizationMetric& WithStatistic(MetricStatistic&& value) { SetStatistic(std::move(value)); return *this;} /** *

The value of the utilization metric.

*/ inline double GetValue() const{ return m_value; } /** *

The value of the utilization metric.

*/ inline bool ValueHasBeenSet() const { return m_valueHasBeenSet; } /** *

The value of the utilization metric.

*/ inline void SetValue(double value) { m_valueHasBeenSet = true; m_value = value; } /** *

The value of the utilization metric.

*/ inline UtilizationMetric& WithValue(double value) { SetValue(value); return *this;} private: MetricName m_name; bool m_nameHasBeenSet = false; MetricStatistic m_statistic; bool m_statisticHasBeenSet = false; double m_value; bool m_valueHasBeenSet = false; }; } // namespace Model } // namespace ComputeOptimizer } // namespace Aws