#[non_exhaustive]pub struct UtilizationMetricBuilder { /* private fields */ }
Expand description
A builder for UtilizationMetric
.
Implementations§
source§impl UtilizationMetricBuilder
impl UtilizationMetricBuilder
sourcepub fn name(self, input: MetricName) -> Self
pub fn name(self, input: MetricName) -> Self
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. -
GPU
- The percentage of allocated GPUs that currently run on the instance. -
GPU_MEMORY
- The percentage of total GPU memory that currently runs on the instance.The
GPU
andGPU_MEMORY
metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU 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.
sourcepub fn set_name(self, input: Option<MetricName>) -> Self
pub fn set_name(self, input: Option<MetricName>) -> Self
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. -
GPU
- The percentage of allocated GPUs that currently run on the instance. -
GPU_MEMORY
- The percentage of total GPU memory that currently runs on the instance.The
GPU
andGPU_MEMORY
metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU 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.
sourcepub fn get_name(&self) -> &Option<MetricName>
pub fn get_name(&self) -> &Option<MetricName>
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. -
GPU
- The percentage of allocated GPUs that currently run on the instance. -
GPU_MEMORY
- The percentage of total GPU memory that currently runs on the instance.The
GPU
andGPU_MEMORY
metrics are only returned for resources with the unified CloudWatch Agent installed on them. For more information, see Enabling NVIDIA GPU 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.
sourcepub fn statistic(self, input: MetricStatistic) -> Self
pub fn statistic(self, input: MetricStatistic) -> Self
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.
sourcepub fn set_statistic(self, input: Option<MetricStatistic>) -> Self
pub fn set_statistic(self, input: Option<MetricStatistic>) -> Self
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.
sourcepub fn get_statistic(&self) -> &Option<MetricStatistic>
pub fn get_statistic(&self) -> &Option<MetricStatistic>
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.
sourcepub fn build(self) -> UtilizationMetric
pub fn build(self) -> UtilizationMetric
Consumes the builder and constructs a UtilizationMetric
.
Trait Implementations§
source§impl Clone for UtilizationMetricBuilder
impl Clone for UtilizationMetricBuilder
source§fn clone(&self) -> UtilizationMetricBuilder
fn clone(&self) -> UtilizationMetricBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UtilizationMetricBuilder
impl Debug for UtilizationMetricBuilder
source§impl Default for UtilizationMetricBuilder
impl Default for UtilizationMetricBuilder
source§fn default() -> UtilizationMetricBuilder
fn default() -> UtilizationMetricBuilder
source§impl PartialEq for UtilizationMetricBuilder
impl PartialEq for UtilizationMetricBuilder
source§fn eq(&self, other: &UtilizationMetricBuilder) -> bool
fn eq(&self, other: &UtilizationMetricBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for UtilizationMetricBuilder
Auto Trait Implementations§
impl Freeze for UtilizationMetricBuilder
impl RefUnwindSafe for UtilizationMetricBuilder
impl Send for UtilizationMetricBuilder
impl Sync for UtilizationMetricBuilder
impl Unpin for UtilizationMetricBuilder
impl UnwindSafe for UtilizationMetricBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more