Class: MintPress::Aws::Lightsail::LoadBalancerMetricDatum

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb

Properties (Read/Write)

  • #load_balancer_name ⇒ [String]
    'The name of the load balancer.'
    Property Attributes
    • get_load_balancer_metric_data_prop ⇒ 'load_balancer_name'
    • read_only ⇒ false
    • source ⇒ "get_load_balancer_metric_data"
    

17
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 17

property :load_balancer_name, get_load_balancer_metric_data_prop: 'load_balancer_name', type: [String], read_only: false, source: "get_load_balancer_metric_data", description: 'The name of the load balancer.'
  • #metric_name ⇒ [String]
    'The metric for which you want to return information. Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. HealthyHostCount - The number of target instances that are considered healthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count. HTTPCode_Instance_2XX_Count - The number of HTTP 2XX 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. Unit: The published unit is Count. HTTPCode_Instance_3XX_Count - The number of HTTP 3XX 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. Unit: The published unit is Count. HTTPCode_Instance_4XX_Count - The number of HTTP 4XX 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. Unit: The published unit is Count. HTTPCode_Instance_5XX_Count - The number of HTTP 5XX 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. Unit: The published unit is Count. HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. 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. Unit: The published unit is Seconds. 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. Unit: The published unit is Count. 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. Unit: The published unit is Count. UnhealthyHostCount - The number of target instances that are considered unhealthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count.'
    Property Attributes
    • get_load_balancer_metric_data_prop ⇒ 'metric_name'
    • read_only ⇒ false
    • source ⇒ "get_load_balancer_metric_data"
    

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 18

property :metric_name, get_load_balancer_metric_data_prop: 'metric_name', type: [String], read_only: false, source: "get_load_balancer_metric_data", description: 'The metric for which you want to return information.

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


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

Statistics: The most useful statistic is Sum.

Unit: The published unit is Count.
 HealthyHostCount  - The number of target
instances that are considered healthy.

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

Unit: The published unit is Count.
 HTTPCode_Instance_2XX_Count  - The number of
HTTP 2XX 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.

Unit: The published unit is Count.
 HTTPCode_Instance_3XX_Count  - The number of
HTTP 3XX 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.

Unit: The published unit is Count.
 HTTPCode_Instance_4XX_Count  - The number of
HTTP 4XX 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.

Unit: The published unit is Count.
 HTTPCode_Instance_5XX_Count  - The number of
HTTP 5XX 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.

Unit: The published unit is Count.
 HTTPCode_LB_4XX_Count  - The number of HTTP 4XX
client error codes that originated from the load balancer. Client
errors are generated when requests are malformed or incomplete.
These requests were not received by the target instance. This count
does not include response codes generated by the target instances.

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

Unit: The published unit is Count.
 HTTPCode_LB_5XX_Count  - The number of HTTP 5XX
server error codes that originated from the load balancer. This does
not include any response codes generated by the target instance.
This metric is reported if there are no healthy instances attached
to the load balancer, or if the request rate exceeds the capacity of
the instances (spillover) or the load balancer.

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

Unit: The published unit is Count.
 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.

Unit: The published unit is Seconds.
 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.

Unit: The published unit is Count.
 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.

Unit: The published unit is Count.
 UnhealthyHostCount  - The number of target
instances that are considered unhealthy.

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

Unit: The published unit is Count.'
  • #period ⇒ [Integer]
    'The granularity, in seconds, of the returned data points.'
    Property Attributes
    • get_load_balancer_metric_data_prop ⇒ 'period'
    • read_only ⇒ false
    • source ⇒ "get_load_balancer_metric_data"
    

123
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 123

property :period, get_load_balancer_metric_data_prop: 'period', type: [Integer], read_only: false, source: "get_load_balancer_metric_data", description: 'The granularity, in seconds, of the returned data points.'
  • #start_time ⇒ [Time,DateTime,Integer]
    'The start time of the period.'
    Property Attributes
    • get_load_balancer_metric_data_prop ⇒ 'start_time'
    • read_only ⇒ false
    • source ⇒ "get_load_balancer_metric_data"
    

124
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 124

property :start_time, get_load_balancer_metric_data_prop: 'start_time', type: [Time,DateTime,Integer], read_only: false, source: "get_load_balancer_metric_data", description: 'The start time of the period.'
  • #end_time ⇒ [Time,DateTime,Integer]
    'The end time of the period.'
    Property Attributes
    • get_load_balancer_metric_data_prop ⇒ 'end_time'
    • read_only ⇒ false
    • source ⇒ "get_load_balancer_metric_data"
    

125
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 125

property :end_time, get_load_balancer_metric_data_prop: 'end_time', type: [Time,DateTime,Integer], read_only: false, source: "get_load_balancer_metric_data", description: 'The end time of the period.'
  • #unit ⇒ [String]
    'The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.'
    Property Attributes
    • get_load_balancer_metric_data_prop ⇒ 'unit'
    • read_only ⇒ false
    • source ⇒ "get_load_balancer_metric_data"
    

126
127
128
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 126

property :unit, get_load_balancer_metric_data_prop: 'unit', type: [String], read_only: false, source: "get_load_balancer_metric_data", description: 'The unit for the metric data request. Valid units depend on the metric
data being requested. For the valid units with each available metric,
see the metricName parameter.'
  • #statistics ⇒ Array of ⇒ [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.'
    Property Attributes
    • get_load_balancer_metric_data_prop ⇒ 'statistics'
    • read_only ⇒ false
    • source ⇒ "get_load_balancer_metric_data"
    

129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 129

property :statistics, get_load_balancer_metric_data_prop: 'statistics', type: [String], array: true, read_only: false, source: "get_load_balancer_metric_data", description: '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.'
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

154
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 154

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

157
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/load_balancer_metric_datum.rb', line 157

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ LoadBalancerMetricDatum

Returns a new instance of LoadBalancerMetricDatum.

Instance Method Details

#get ⇒ Object