Class: Aws::Lightsail::Types::GetContainerServiceMetricDataRequest

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::GetContainerServiceMetricDataRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lightsail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ Time

  The end time of the time period.

• #metric_name ⇒ String

  The metric for which you want to return information.

• #period ⇒ Integer

  The granularity, in seconds, of the returned data points.

• #service_name ⇒ String

  The name of the container service for which to get metric data.

• #start_time ⇒ Time

  The start time of the time period.

• #statistics ⇒ Array<String>

  The statistic for the metric.

Instance Attribute Details

#end_time ⇒ Time

The end time of the time period.

Returns:

• (Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 7258

class GetContainerServiceMetricDataRequest < Struct.new(
  :service_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The metric for which you want to return information.

Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.

• ‘CPUUtilization` - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identifies the processing power required to run containers on each node of the container service.

  Statistics: The most useful statistics are ‘Maximum` and `Average`.

  Unit: The published unit is ‘Percent`.

• ‘MemoryUtilization` - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies the memory required to run containers on each node of the container service.

  Statistics: The most useful statistics are ‘Maximum` and `Average`.

  Unit: The published unit is ‘Percent`.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 7258

class GetContainerServiceMetricDataRequest < Struct.new(
  :service_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

The granularity, in seconds, of the returned data points.

All container service metric data is available in 5-minute (300 seconds) granularity.

Returns:

• (Integer)

# File 'lib/aws-sdk-lightsail/types.rb', line 7258

class GetContainerServiceMetricDataRequest < Struct.new(
  :service_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ String

The name of the container service for which to get metric data.

Returns:

• (String)

# File 'lib/aws-sdk-lightsail/types.rb', line 7258

class GetContainerServiceMetricDataRequest < Struct.new(
  :service_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time of the time period.

Returns:

• (Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 7258

class GetContainerServiceMetricDataRequest < Struct.new(
  :service_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end

#statistics ⇒ Array<String>

The statistic for the metric.

The following statistics are available:

• ‘Minimum` - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

• ‘Maximum` - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

• ‘Sum` - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

• ‘Average` - The value of `Sum` / `SampleCount` during the specified period. By comparing this statistic with the `Minimum` and `Maximum` values, you can determine the full scope of a metric and how close the average use is to the `Minimum` and `Maximum` values. This comparison helps you to know when to increase or decrease your resources.

• ‘SampleCount` - The count, or number, of data points used for the statistical calculation.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-lightsail/types.rb', line 7258

class GetContainerServiceMetricDataRequest < Struct.new(
  :service_name,
  :metric_name,
  :start_time,
  :end_time,
  :period,
  :statistics)
  SENSITIVE = []
  include Aws::Structure
end