Class: MintPress::Aws::CloudWatch::MetricStatistic

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

Properties (Read/Write)

  • #namespace ⇒ [String]
    'The namespace of the metric, with or without spaces.'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'namespace'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    

18
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 18

property :namespace, get_metric_statistics_prop: 'namespace', type: [String], read_only: false, source: "get_metric_statistics", description: 'The namespace of the metric, with or without spaces.'
  • #metric_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the metric, with or without spaces.'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'metric_name'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    • default ⇒ Proc.new { self.name }
    

19
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 19

property :metric_name, get_metric_statistics_prop: 'metric_name', type: [String], read_only: false, source: "get_metric_statistics", description: 'The name of the metric, with or without spaces.', default: Proc.new { self.name }
  • #dimensions ⇒ Hash of ⇒ [MintPress::Aws::CloudWatch::Dimension]
    'The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can"t retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'dimensions'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    

20
21
22
23
24
25
26
27
28
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 20

property :dimensions, get_metric_statistics_prop: 'dimensions', type: [MintPress::Aws::CloudWatch::Dimension], array: false, read_only: false, source: "get_metric_statistics", description: 'The dimensions. If the metric contains multiple dimensions, you must
include a value for each dimension. CloudWatch treats each unique
combination of dimensions as a separate metric. If a specific
combination of dimensions was not published, you can"t retrieve
statistics for it. You must specify the same dimensions that were used
when the metrics were created. For an example, see Dimension
Combinations in the Amazon CloudWatch User Guide. For more
information about specifying dimensions, see Publishing Metrics
in the Amazon CloudWatch User Guide.', hash: true
  • #start_time ⇒ [Time,DateTime,Integer]
    'The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request. The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z). CloudWatch rounds the specified time stamp as follows: Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00. Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00. Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00. If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'start_time'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    

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
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 29

property :start_time, get_metric_statistics_prop: 'start_time', type: [Time,DateTime,Integer], read_only: false, source: "get_metric_statistics", description: 'The time stamp that determines the first data point to return. Start
times are evaluated relative to the time that CloudWatch receives the
request.

The value specified is inclusive; results include data points with the
specified time stamp. In a raw HTTP query, the time stamp must be in
ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:


Start time less than 15 days ago - Round down to the nearest whole
minute. For example, 12:32:34 is rounded down to 12:32:00.
Start time between 15 and 63 days ago - Round down to the nearest
5-minute clock interval. For example, 12:32:34 is rounded down to
12:30:00.
Start time greater than 63 days ago - Round down to the nearest
1-hour clock interval. For example, 12:32:34 is rounded down to
12:00:00.



If you set Period to 5, 10, or 30, the start time of your request is
rounded down to the nearest time that corresponds to even 5-, 10-, or
30-second divisions of a minute. For example, if you make a query at
(HH:mm:ss) 01:05:23 for the previous 10-second period, the start time
of your request is rounded down and you receive data from 01:05:10 to
01:05:20. If you make a query at 15:07:17 for the previous 5 minutes
of data, using a period of 5 seconds, you receive data timestamped
between 15:02:15 and 15:07:15.'
  • #end_time ⇒ [Time,DateTime,Integer]
    'The time stamp that determines the last data point to return. The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'end_time'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    

59
60
61
62
63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 59

property :end_time, get_metric_statistics_prop: 'end_time', type: [Time,DateTime,Integer], read_only: false, source: "get_metric_statistics", description: 'The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to
the specified time stamp. In a raw HTTP query, the time stamp must be
in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).'
  • #period ⇒ [Integer]
    'The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second. If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'period'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 64

property :period, get_metric_statistics_prop: 'period', type: [Integer], read_only: false, source: "get_metric_statistics", description: 'The granularity, in seconds, of the returned data points. For metrics
with regular resolution, a period can be as short as one minute (60
seconds) and must be a multiple of 60. For high-resolution metrics
that are collected at intervals of less than one minute, the period
can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
metrics are those metrics stored by a PutMetricData call that
includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater
than 3 hours ago, you must specify the period as follows or no data
points in that time range is returned:


Start time between 3 hours and 15 days ago - Use a multiple of 60
seconds (1 minute).
Start time between 15 and 63 days ago - Use a multiple of 300
seconds (5 minutes).
Start time greater than 63 days ago - Use a multiple of 3600 seconds
(1 hour).'
  • #statistics ⇒ Array of ⇒ [String]
    'The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'statistics'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    

83
84
85
86
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 83

property :statistics, get_metric_statistics_prop: 'statistics', type: [String], array: true, read_only: false, source: "get_metric_statistics", description: 'The metric statistics, other than percentile. For percentile
statistics, use ExtendedStatistics. When calling
GetMetricStatistics, you must specify either Statistics or
ExtendedStatistics, but not both.'
  • #extended_statistics ⇒ Array of ⇒ [String]
    'The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'extended_statistics'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    

87
88
89
90
91
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 87

property :extended_statistics, get_metric_statistics_prop: 'extended_statistics', type: [String], array: true, read_only: false, source: "get_metric_statistics", description: 'The percentile statistics. Specify values between p0.0 and p100. When
calling GetMetricStatistics, you must specify either Statistics or
ExtendedStatistics, but not both. Percentile statistics are not
available for metrics when any of the metric values are negative
numbers.'
  • #unit ⇒ [String]
    'The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.'
    Property Attributes
    • get_metric_statistics_prop ⇒ 'unit'
    • read_only ⇒ false
    • source ⇒ "get_metric_statistics"
    

92
93
94
95
96
97
98
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 92

property :unit, get_metric_statistics_prop: 'unit', type: [String], read_only: false, source: "get_metric_statistics", description: 'The unit for a given metric. If you omit Unit, all data that was
collected with any unit is returned, along with the corresponding
units that were specified when the data was reported to CloudWatch. If
you specify a unit, the operation returns only data that was collected
with that unit specified. If you specify a unit that does not match
the data collected, the results of the operation are null. CloudWatch
does not perform unit conversions.'
  • #name ⇒ [String]

    Property Attributes 
    

99
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 99

property :name, type: [String]
  • #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 
    

103
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 103

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
    

106
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric_statistic.rb', line 106

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

Returns a new instance of MetricStatistic.

Instance Method Details

#get ⇒ Object