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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass GetContainerServiceMetricDataRequest data as a hash:

{
  service_name: "ContainerServiceName", # required
  metric_name: "CPUUtilization", # required, accepts CPUUtilization, MemoryUtilization
  start_time: Time.now, # required
  end_time: Time.now, # required
  period: 1, # required
  statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The end time of the time period.

Returns:

  • (Time)


7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7754

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

#metric_nameString

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)


7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7754

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

#periodInteger

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

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

Returns:

  • (Integer)


7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7754

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

#service_nameString

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

Returns:

  • (String)


7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7754

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

#start_timeTime

The start time of the time period.

Returns:

  • (Time)


7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7754

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

#statisticsArray<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>)


7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 7754

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