Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric

Description

Documentation

data EBSUtilizationMetric Source #

Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume.

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: newEBSUtilizationMetric smart constructor.

Constructors

EBSUtilizationMetric'

Fields

name :: Maybe EBSMetricName
The name of the utilization metric.
The following utilization metrics are available:
- VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
  Unit: Count
- VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
  Unit: Count
- VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
  Unit: Bytes
- VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
  Unit: Bytes
statistic :: Maybe 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.
value :: Maybe Double
The value of the utilization metric.

Instances

Instances details

FromJSON EBSUtilizationMetric Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric Methods parseJSON :: Value -> Parser EBSUtilizationMetric # parseJSONList :: Value -> Parser [EBSUtilizationMetric] #
Generic EBSUtilizationMetric Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric Associated Types type Rep EBSUtilizationMetric :: Type -> Type # Methods from :: EBSUtilizationMetric -> Rep EBSUtilizationMetric x # to :: Rep EBSUtilizationMetric x -> EBSUtilizationMetric #
Read EBSUtilizationMetric Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric Methods readsPrec :: Int -> ReadS EBSUtilizationMetric # readList :: ReadS [EBSUtilizationMetric] # readPrec :: ReadPrec EBSUtilizationMetric # readListPrec :: ReadPrec [EBSUtilizationMetric] #
Show EBSUtilizationMetric Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric Methods showsPrec :: Int -> EBSUtilizationMetric -> ShowS # show :: EBSUtilizationMetric -> String # showList :: [EBSUtilizationMetric] -> ShowS #
NFData EBSUtilizationMetric Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric Methods rnf :: EBSUtilizationMetric -> () #
Eq EBSUtilizationMetric Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric Methods (==) :: EBSUtilizationMetric -> EBSUtilizationMetric -> Bool # (/=) :: EBSUtilizationMetric -> EBSUtilizationMetric -> Bool #
Hashable EBSUtilizationMetric Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric Methods hashWithSalt :: Int -> EBSUtilizationMetric -> Int # hash :: EBSUtilizationMetric -> Int #
type Rep EBSUtilizationMetric Source #
Instance details Defined in Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric type Rep EBSUtilizationMetric = D1 ('MetaData "EBSUtilizationMetric" "Amazonka.ComputeOptimizer.Types.EBSUtilizationMetric" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "EBSUtilizationMetric'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EBSMetricName)) :: (S1 ('MetaSel ('Just "statistic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricStatistic)) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))))

newEBSUtilizationMetric :: EBSUtilizationMetric Source #

Create a value of EBSUtilizationMetric with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:EBSUtilizationMetric', eBSUtilizationMetric_name - The name of the utilization metric.

The following utilization metrics are available:

VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
Unit: Count
VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
Unit: Count
VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
Unit: Bytes
VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
Unit: Bytes

$sel:statistic:EBSUtilizationMetric', eBSUtilizationMetric_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.

$sel:value:EBSUtilizationMetric', eBSUtilizationMetric_value - The value of the utilization metric.

eBSUtilizationMetric_name :: Lens' EBSUtilizationMetric (Maybe EBSMetricName) Source #

The name of the utilization metric.

The following utilization metrics are available:

VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
Unit: Count
VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
Unit: Count
VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
Unit: Bytes
VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
Unit: Bytes

eBSUtilizationMetric_statistic :: Lens' EBSUtilizationMetric (Maybe MetricStatistic) Source #

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.

eBSUtilizationMetric_value :: Lens' EBSUtilizationMetric (Maybe Double) Source #

The value of the utilization metric.