Class: MintPress::Aws::CloudWatch::AlarmsForMetric

Inherits:

Object

• Object
• MintPress::Aws::CloudWatch::AlarmsForMetric

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

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

Properties (Read/Write)

• #metric_name ⇒ [String] (Default Value: Proc.new { self.name })
  'The name of the metric.'
  Property Attributes
  • describe_alarms_for_metric_prop ⇒ 'metric_name'
  • source ⇒ "describe_alarms_for_metric"
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarms_for_metric.rb', line 18
  
  property :metric_name, describe_alarms_for_metric_prop: 'metric_name', type: [String], source: "describe_alarms_for_metric", description: 'The name of the metric.', default: Proc.new { self.name }

• #namespace ⇒ [String]
  'The namespace of the metric.'
  Property Attributes
  • describe_alarms_for_metric_prop ⇒ 'namespace'
  • source ⇒ "describe_alarms_for_metric"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarms_for_metric.rb', line 19
  
  property :namespace, describe_alarms_for_metric_prop: 'namespace', type: [String], source: "describe_alarms_for_metric", description: 'The namespace of the metric.'

• #statistic ⇒ [String]
  'The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.'
  Property Attributes
  • describe_alarms_for_metric_prop ⇒ 'statistic'
  • source ⇒ "describe_alarms_for_metric"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarms_for_metric.rb', line 20
  
  property :statistic, describe_alarms_for_metric_prop: 'statistic', type: [String], source: "describe_alarms_for_metric", description: 'The statistic for the metric, other than percentiles. For percentile
  statistics, use ExtendedStatistics.'

• #extended_statistic ⇒ [String]
  'The percentile statistic for the metric. Specify a value between p0.0 and p100.'
  Property Attributes
  • describe_alarms_for_metric_prop ⇒ 'extended_statistic'
  • source ⇒ "describe_alarms_for_metric"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarms_for_metric.rb', line 22
  
  property :extended_statistic, describe_alarms_for_metric_prop: 'extended_statistic', type: [String], source: "describe_alarms_for_metric", description: 'The percentile statistic for the metric. Specify a value between p0.0
  and p100.'

• #dimensions ⇒ Hash of ⇒ [MintPress::Aws::CloudWatch::Dimension]
  'The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.'
  Property Attributes
  • describe_alarms_for_metric_prop ⇒ 'dimensions'
  • source ⇒ "describe_alarms_for_metric"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarms_for_metric.rb', line 24
  
  property :dimensions, describe_alarms_for_metric_prop: 'dimensions', type: [MintPress::Aws::CloudWatch::Dimension], array: false, source: "describe_alarms_for_metric", description: 'The dimensions associated with the metric. If the metric has any
  associated dimensions, you must specify them in order for the call to
  succeed.', hash: true

• #period ⇒ [Integer]
  'The period, in seconds, over which the statistic is applied.'
  Property Attributes
  • describe_alarms_for_metric_prop ⇒ 'period'
  • source ⇒ "describe_alarms_for_metric"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarms_for_metric.rb', line 27
  
  property :period, describe_alarms_for_metric_prop: 'period', type: [Integer], source: "describe_alarms_for_metric", description: 'The period, in seconds, over which the statistic is applied.'

• #unit ⇒ [String]
  'The unit for the metric.'
  Property Attributes
  • describe_alarms_for_metric_prop ⇒ 'unit'
  • source ⇒ "describe_alarms_for_metric"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarms_for_metric.rb', line 28
  
  property :unit, describe_alarms_for_metric_prop: 'unit', type: [String], source: "describe_alarms_for_metric", description: 'The unit for the metric.'

• #name ⇒ [String]
  
  Property Attributes

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

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

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

Returns a new instance of AlarmsForMetric.

Instance Method Details

#describe ⇒ Object