Class: MintPress::Aws::CloudWatch::InsightRuleReport

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

Properties (Read/Write)

  • #rule_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the rule that you want to see data from.'
    Property Attributes
    • get_insight_rule_report_prop ⇒ 'rule_name'
    • read_only ⇒ false
    • source ⇒ "get_insight_rule_report"
    • default ⇒ Proc.new { self.name }
    

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

property :rule_name, get_insight_rule_report_prop: 'rule_name', type: [String], read_only: false, source: "get_insight_rule_report", description: 'The name of the rule that you want to see data from.', default: Proc.new { self.name }
  • #start_time ⇒ [Time,DateTime,Integer]
    'The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd"T"HH:mm:ss. For example, 2019-07-01T23:59:59.'
    Property Attributes
    • get_insight_rule_report_prop ⇒ 'start_time'
    • read_only ⇒ false
    • source ⇒ "get_insight_rule_report"
    

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

property :start_time, get_insight_rule_report_prop: 'start_time', type: [Time,DateTime,Integer], read_only: false, source: "get_insight_rule_report", description: 'The start time of the data to use in the report. When used in a raw
HTTP Query API, it is formatted as yyyy-MM-dd"T"HH:mm:ss. For
example, 2019-07-01T23:59:59.'
  • #end_time ⇒ [Time,DateTime,Integer]
    'The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as yyyy-MM-dd"T"HH:mm:ss. For example, 2019-07-01T23:59:59.'
    Property Attributes
    • get_insight_rule_report_prop ⇒ 'end_time'
    • read_only ⇒ false
    • source ⇒ "get_insight_rule_report"
    

21
22
23
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/insight_rule_report.rb', line 21

property :end_time, get_insight_rule_report_prop: 'end_time', type: [Time,DateTime,Integer], read_only: false, source: "get_insight_rule_report", description: 'The end time of the data to use in the report. When used in a raw HTTP
Query API, it is formatted as yyyy-MM-dd"T"HH:mm:ss. For example,
2019-07-01T23:59:59.'
  • #period ⇒ [Integer]
    'The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.'
    Property Attributes
    • get_insight_rule_report_prop ⇒ 'period'
    • read_only ⇒ false
    • source ⇒ "get_insight_rule_report"
    

24
25
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/insight_rule_report.rb', line 24

property :period, get_insight_rule_report_prop: 'period', type: [Integer], read_only: false, source: "get_insight_rule_report", description: 'The period, in seconds, to use for the statistics in the
InsightRuleMetricDatapoint results.'
  • #max_contributor_count ⇒ [Integer]
    'The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.'
    Property Attributes
    • get_insight_rule_report_prop ⇒ 'max_contributor_count'
    • read_only ⇒ false
    • source ⇒ "get_insight_rule_report"
    

26
27
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/insight_rule_report.rb', line 26

property :max_contributor_count, get_insight_rule_report_prop: 'max_contributor_count', type: [Integer], read_only: false, source: "get_insight_rule_report", description: 'The maximum number of contributors to include in the report. The range
is 1 to 100. If you omit this, the default of 10 is used.'
  • #metrics ⇒ Array of ⇒ [String]
    'Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more of the following metrics: UniqueContributors -- the number of unique contributors for each data point. MaxContributorValue -- the value of the top contributor for each data point. The identity of the contributor might change for each data point in the graph. If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified by the rule"s Value, during that period. SampleCount -- the number of data points matched by the rule. Sum -- the sum of the values from all contributors during the time period represented by that data point. Minimum -- the minimum value from a single observation during the time period represented by that data point. Maximum -- the maximum value from a single observation during the time period represented by that data point. Average -- the average value from all contributors during the time period represented by that data point.'
    Property Attributes
    • get_insight_rule_report_prop ⇒ 'metrics'
    • read_only ⇒ false
    • source ⇒ "get_insight_rule_report"
    

28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/insight_rule_report.rb', line 28

property :metrics, get_insight_rule_report_prop: 'metrics', type: [String], array: true, read_only: false, source: "get_insight_rule_report", description: 'Specifies which metrics to use for aggregation of contributor values
for the report. You can specify one or more of the following metrics:


UniqueContributors -- the number of unique contributors for each
data point.
MaxContributorValue -- the value of the top contributor for each
data point. The identity of the contributor might change for each
data point in the graph.

If this rule aggregates by COUNT, the top contributor for each data
point is the contributor with the most occurrences in that period.
If the rule aggregates by SUM, the top contributor is the
contributor with the highest sum in the log field specified by the
rule"s Value, during that period.
SampleCount -- the number of data points matched by the rule.
Sum -- the sum of the values from all contributors during the time
period represented by that data point.
Minimum -- the minimum value from a single observation during the
time period represented by that data point.
Maximum -- the maximum value from a single observation during the
time period represented by that data point.
Average -- the average value from all contributors during the time
period represented by that data point.'
  • #order_by ⇒ [String]
    'Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.'
    Property Attributes
    • get_insight_rule_report_prop ⇒ 'order_by'
    • read_only ⇒ false
    • source ⇒ "get_insight_rule_report"
    

52
53
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/insight_rule_report.rb', line 52

property :order_by, get_insight_rule_report_prop: 'order_by', type: [String], read_only: false, source: "get_insight_rule_report", description: 'Determines what statistic to use to rank the contributors. Valid
values are SUM and MAXIMUM.'
  • #name ⇒ [String]

    Property Attributes 
    

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

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 
    

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

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
    

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

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

Returns a new instance of InsightRuleReport.

Instance Method Details

#get ⇒ Object