You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Lightsail::Types::GetLoadBalancerMetricDataRequest

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 GetLoadBalancerMetricDataRequest data as a hash:

{
  load_balancer_name: "ResourceName", # required
  metric_name: "ClientTLSNegotiationErrorCount", # required, accepts ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, RequestCount
  period: 1, # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  unit: "Seconds", # required, accepts Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None
  statistics: ["Minimum"], # required, accepts Minimum, Maximum, Sum, Average, SampleCount
}

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

The end time of the period.

Returns:

  • (Time)


2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2612

class GetLoadBalancerMetricDataRequest < Struct.new(
  :load_balancer_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#load_balancer_nameString

The name of the load balancer.

Returns:

  • (String)


2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2612

class GetLoadBalancerMetricDataRequest < Struct.new(
  :load_balancer_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#metric_nameString

The metric about which you want to return information. Valid values are listed below, along with the most useful statistics to include in your request.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

  • UnhealthyHostCount - The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

Returns:

  • (String)


2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2612

class GetLoadBalancerMetricDataRequest < Struct.new(
  :load_balancer_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#periodInteger

The time period duration for your health data request.

Returns:

  • (Integer)


2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2612

class GetLoadBalancerMetricDataRequest < Struct.new(
  :load_balancer_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#start_timeTime

The start time of the period.

Returns:

  • (Time)


2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2612

class GetLoadBalancerMetricDataRequest < Struct.new(
  :load_balancer_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#statisticsArray<String>

An array of statistics that you want to request metrics for. Valid values are listed below.

  • SampleCount - The count (number) of data points used for the statistical calculation.

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

  • Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.

  • Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.

Returns:

  • (Array<String>)


2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2612

class GetLoadBalancerMetricDataRequest < Struct.new(
  :load_balancer_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end

#unitString

The unit for the time period request. Valid values are listed below.

Returns:

  • (String)


2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2612

class GetLoadBalancerMetricDataRequest < Struct.new(
  :load_balancer_name,
  :metric_name,
  :period,
  :start_time,
  :end_time,
  :unit,
  :statistics)
  include Aws::Structure
end