Class: MintPress::Aws::Lightsail::RelationalDatabaseMetricDatum

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

Properties (Read/Write)

  • #relational_database_name ⇒ [String]
    'The name of your database from which to get metric data.'
    Property Attributes
    • get_relational_database_metric_data_prop ⇒ 'relational_database_name'
    • read_only ⇒ false
    • source ⇒ "get_relational_database_metric_data"
    

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

property :relational_database_name, get_relational_database_metric_data_prop: 'relational_database_name', type: [String], read_only: false, source: "get_relational_database_metric_data", description: 'The name of your database from which to get metric data.'
  • #metric_name ⇒ [String]
    'The metric for which you want to return information. Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity. CPUUtilization - The percentage of CPU utilization currently in use on the database. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. DatabaseConnections - The number of database connections in use. Statistics: The most useful statistics are Maximum and Sum. Unit: The published unit is Count. DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. FreeStorageSpace - The amount of available storage space. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication. Statistics: The most useful statistic is Average. Unit: The published unit is Bytes/Second. NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication. Statistics: The most useful statistic is Average. Unit: The published unit is Bytes/Second.'
    Property Attributes
    • get_relational_database_metric_data_prop ⇒ 'metric_name'
    • read_only ⇒ false
    • source ⇒ "get_relational_database_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
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database_metric_datum.rb', line 18

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

Valid relational database metric names are listed below, along with
the most useful statistics to include in your request, and the
published unit value. All relational database metric data is
available in 1-minute (60 seconds) granularity.


 CPUUtilization  - The percentage of CPU
utilization currently in use on the database.

Statistics: The most useful statistics are Maximum and
Average.

Unit: The published unit is Percent.
 DatabaseConnections  - The number of database
connections in use.

Statistics: The most useful statistics are Maximum and Sum.

Unit: The published unit is Count.
 DiskQueueDepth  - The number of outstanding IOs
(read/write requests) that are waiting to access the disk.

Statistics: The most useful statistic is Sum.

Unit: The published unit is Count.
 FreeStorageSpace  - The amount of available
storage space.

Statistics: The most useful statistic is Sum.

Unit: The published unit is Bytes.
 NetworkReceiveThroughput  - The incoming
(Receive) network traffic on the database, including both customer
database traffic and AWS traffic used for monitoring and
replication.

Statistics: The most useful statistic is Average.

Unit: The published unit is Bytes/Second.
 NetworkTransmitThroughput  - The outgoing
(Transmit) network traffic on the database, including both customer
database traffic and AWS traffic used for monitoring and
replication.

Statistics: The most useful statistic is Average.

Unit: The published unit is Bytes/Second.'
  • #period ⇒ [Integer]
    'The granularity, in seconds, of the returned data points. All relational database metric data is available in 1-minute (60 seconds) granularity.'
    Property Attributes
    • get_relational_database_metric_data_prop ⇒ 'period'
    • read_only ⇒ false
    • source ⇒ "get_relational_database_metric_data"
    

67
68
69
70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database_metric_datum.rb', line 67

property :period, get_relational_database_metric_data_prop: 'period', type: [Integer], read_only: false, source: "get_relational_database_metric_data", description: 'The granularity, in seconds, of the returned data points.

All relational database metric data is available in 1-minute (60
seconds) granularity.'
  • #start_time ⇒ [Time,DateTime,Integer]
    'The start of the time interval from which to get metric data. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.'
    Property Attributes
    • get_relational_database_metric_data_prop ⇒ 'start_time'
    • read_only ⇒ false
    • source ⇒ "get_relational_database_metric_data"
    

71
72
73
74
75
76
77
78
79
80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database_metric_datum.rb', line 71

property :start_time, get_relational_database_metric_data_prop: 'start_time', type: [Time,DateTime,Integer], read_only: false, source: "get_relational_database_metric_data", description: 'The start of the time interval from which to get metric data.

Constraints:


Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.

For example, if you wish to use a start time of October 1, 2018, at
8 PM UTC, then you input 1538424000 as the start time.'
  • #end_time ⇒ [Time,DateTime,Integer]
    'The end of the time interval from which to get metric data. Constraints: Specified in Coordinated Universal Time (UTC). Specified in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.'
    Property Attributes
    • get_relational_database_metric_data_prop ⇒ 'end_time'
    • read_only ⇒ false
    • source ⇒ "get_relational_database_metric_data"
    

81
82
83
84
85
86
87
88
89
90
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database_metric_datum.rb', line 81

property :end_time, get_relational_database_metric_data_prop: 'end_time', type: [Time,DateTime,Integer], read_only: false, source: "get_relational_database_metric_data", description: 'The end of the time interval from which to get metric data.

Constraints:


Specified in Coordinated Universal Time (UTC).
Specified in the Unix time format.

For example, if you wish to use an end time of October 1, 2018, at 8
PM UTC, then you input 1538424000 as the end time.'
  • #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_relational_database_metric_data_prop ⇒ 'unit'
    • read_only ⇒ false
    • source ⇒ "get_relational_database_metric_data"
    

91
92
93
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database_metric_datum.rb', line 91

property :unit, get_relational_database_metric_data_prop: 'unit', type: [String], read_only: false, source: "get_relational_database_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_relational_database_metric_data_prop ⇒ 'statistics'
    • read_only ⇒ false
    • source ⇒ "get_relational_database_metric_data"
    

94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/relational_database_metric_datum.rb', line 94

property :statistics, get_relational_database_metric_data_prop: 'statistics', type: [String], array: true, read_only: false, source: "get_relational_database_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 
    

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

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
    

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

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 = {}) ⇒ RelationalDatabaseMetricDatum

Returns a new instance of RelationalDatabaseMetricDatum.

Instance Method Details

#get ⇒ Object