Class: Aws::ApplicationSignals::Types::MetricStat

Inherits:

Struct

• Object
• Struct
• Aws::ApplicationSignals::Types::MetricStat

Includes:

Structure

Defined in:

lib/aws-sdk-applicationsignals/types.rb

Overview

This structure defines the metric to be used as the service level indicator, along with the statistics, period, and unit.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #metric ⇒ Types::Metric

  The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

• #period ⇒ Integer

  The granularity, in seconds, to be used for the metric.

• #stat ⇒ String

  The statistic to use for comparison to the threshold.

• #unit ⇒ String

  If you omit ‘Unit` then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch.

Instance Attribute Details

#metric ⇒ Types::Metric

The metric to use as the service level indicator, including the metric name, namespace, and dimensions.

Returns:

• (Types::Metric)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 1218

class MetricStat < Struct.new(
  :metric,
  :period,
  :stat,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

The granularity, in seconds, to be used for the metric. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ‘PutMetricData` call that includes a `StorageResolution` of 1 second.

Returns:

• (Integer)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 1218

class MetricStat < Struct.new(
  :metric,
  :period,
  :stat,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#stat ⇒ String

The statistic to use for comparison to the threshold. It can be any CloudWatch statistic or extended statistic. For more information about statistics, see [CloudWatch statistics definitions].

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html

Returns:

• (String)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 1218

class MetricStat < Struct.new(
  :metric,
  :period,
  :stat,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

If you omit ‘Unit` then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

Returns:

• (String)

# File 'lib/aws-sdk-applicationsignals/types.rb', line 1218

class MetricStat < Struct.new(
  :metric,
  :period,
  :stat,
  :unit)
  SENSITIVE = []
  include Aws::Structure
end