Class: MintPress::Aws::CloudWatch::Metric

Inherits:

Object

• Object
• MintPress::Aws::CloudWatch::Metric

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric.rb

Properties (Read/Write)

• #dimensions ⇒ Hash of ⇒ [MintPress::Aws::CloudWatch::DimensionFilter]
  'The dimensions to filter against. Only the dimensions that match exactly will be returned.'
  Property Attributes
  • source ⇒ "list_metrics"
  • orig_name ⇒ 'dimensions'
  • get_metric_data_prop ⇒ 'dimensions'
  • list_metrics_prop ⇒ 'dimensions'
  • read_only ⇒ false

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric.rb', line 19
  
  property :dimensions, description: 'The dimensions to filter against. Only the dimensions that match
  exactly will be returned.', source: "list_metrics", orig_name: 'dimensions', type: [MintPress::Aws::CloudWatch::DimensionFilter], array: false, get_metric_data_prop: 'dimensions', list_metrics_prop: 'dimensions', read_only: false, hash: true

• #metric_name ⇒ [String] (Default Value: Proc.new { self.name })
  'The name of the metric to filter against. Only the metrics with names that match exactly will be returned.'
  Property Attributes
  • source ⇒ "list_metrics"
  • orig_name ⇒ 'metric_name'
  • get_metric_data_prop ⇒ 'metric_name'
  • list_metrics_prop ⇒ 'metric_name'
  • read_only ⇒ false
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric.rb', line 21
  
  property :metric_name, description: 'The name of the metric to filter against. Only the metrics with names
  that match exactly will be returned.', source: "list_metrics", orig_name: 'metric_name', type: [String], get_metric_data_prop: 'metric_name', list_metrics_prop: 'metric_name', read_only: false, default: Proc.new { self.name }

• #namespace ⇒ [String]
  'The metric namespace to filter against. Only the namespace that matches exactly will be returned.'
  Property Attributes
  • source ⇒ "list_metrics"
  • orig_name ⇒ 'namespace'
  • get_metric_data_prop ⇒ 'namespace'
  • list_metrics_prop ⇒ 'namespace'
  • read_only ⇒ false

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric.rb', line 23
  
  property :namespace, description: 'The metric namespace to filter against. Only the namespace that
  matches exactly will be returned.', source: "list_metrics", orig_name: 'namespace', type: [String], get_metric_data_prop: 'namespace', list_metrics_prop: 'namespace', read_only: false

• #recently_active ⇒ [String]
  'To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter. The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.'
  Property Attributes
  • list_metrics_prop ⇒ 'recently_active'
  • read_only ⇒ false
  • source ⇒ "list_metrics"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/metric.rb', line 25
  
  property :recently_active, list_metrics_prop: 'recently_active', type: [String], read_only: false, source: "list_metrics", description: 'To filter the results to show only metrics that have had data points
  published in the past three hours, specify this parameter with a value
  of PT3H. This is the only valid value for this parameter.
  
  The results that are returned are an approximation of the value you
  specify. There is a low probability that the returned results include
  metrics with last published data as much as 40 minutes more than the
  specified time interval.'

• #name ⇒ [String]
  
  Property Attributes

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

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

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

• #initialize(opts = {}) ⇒ Metric constructor
  A new instance of Metric.
• #list ⇒ Object

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

Returns a new instance of Metric.

Instance Method Details

#list ⇒ Object