Class: MintPress::Aws::CloudWatch::AlarmHistory

Inherits:

Object

• Object
• MintPress::Aws::CloudWatch::AlarmHistory

Includes:

MintLogger, AwsCommon, Mixins::Properties

Defined in:

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

Properties (Read/Write)

• #alarm_name ⇒ [String] (Default Value: Proc.new { self.name })
  'The name of the alarm.'
  Property Attributes
  • describe_alarm_history_prop ⇒ 'alarm_name'
  • source ⇒ "describe_alarm_history"
  • default ⇒ Proc.new { self.name }

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm_history.rb', line 17
  
  property :alarm_name, describe_alarm_history_prop: 'alarm_name', type: [String], source: "describe_alarm_history", description: 'The name of the alarm.', default: Proc.new { self.name }

• #alarm_types ⇒ Array of ⇒ [String]
  'Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned.'
  Property Attributes
  • describe_alarm_history_prop ⇒ 'alarm_types'
  • source ⇒ "describe_alarm_history"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm_history.rb', line 18
  
  property :alarm_types, describe_alarm_history_prop: 'alarm_types', type: [String], array: true, source: "describe_alarm_history", description: 'Use this parameter to specify whether you want the operation to return
  metric alarms or composite alarms. If you omit this parameter, only
  metric alarms are returned.'

• #history_item_type ⇒ [String]
  'The type of alarm histories to retrieve.'
  Property Attributes
  • describe_alarm_history_prop ⇒ 'history_item_type'
  • source ⇒ "describe_alarm_history"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm_history.rb', line 21
  
  property :history_item_type, describe_alarm_history_prop: 'history_item_type', type: [String], source: "describe_alarm_history", description: 'The type of alarm histories to retrieve.'

• #start_date ⇒ [Time,DateTime,Integer]
  'The starting date to retrieve alarm history.'
  Property Attributes
  • describe_alarm_history_prop ⇒ 'start_date'
  • source ⇒ "describe_alarm_history"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm_history.rb', line 22
  
  property :start_date, describe_alarm_history_prop: 'start_date', type: [Time,DateTime,Integer], source: "describe_alarm_history", description: 'The starting date to retrieve alarm history.'

• #end_date ⇒ [Time,DateTime,Integer]
  'The ending date to retrieve alarm history.'
  Property Attributes
  • describe_alarm_history_prop ⇒ 'end_date'
  • source ⇒ "describe_alarm_history"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm_history.rb', line 23
  
  property :end_date, describe_alarm_history_prop: 'end_date', type: [Time,DateTime,Integer], source: "describe_alarm_history", description: 'The ending date to retrieve alarm history.'

• #max_records ⇒ [Integer]
  'The maximum number of alarm history records to retrieve.'
  Property Attributes
  • describe_alarm_history_prop ⇒ 'max_records'
  • source ⇒ "describe_alarm_history"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm_history.rb', line 24
  
  property :max_records, describe_alarm_history_prop: 'max_records', type: [Integer], source: "describe_alarm_history", description: 'The maximum number of alarm history records to retrieve.'

• #scan_by ⇒ [String]
  'Specified whether to return the newest or oldest alarm history first. Specify TimestampDescending to have the newest event history returned first, and specify TimestampAscending to have the oldest history returned first.'
  Property Attributes
  • describe_alarm_history_prop ⇒ 'scan_by'
  • source ⇒ "describe_alarm_history"

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm_history.rb', line 25
  
  property :scan_by, describe_alarm_history_prop: 'scan_by', type: [String], source: "describe_alarm_history", description: 'Specified whether to return the newest or oldest alarm history first.
  Specify TimestampDescending to have the newest event history
  returned first, and specify TimestampAscending to have the oldest
  history returned first.'

• #name ⇒ [String]
  
  Property Attributes

  # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm_history.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/alarm_history.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/alarm_history.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 = {}) ⇒ AlarmHistory constructor
  A new instance of AlarmHistory.

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

Returns a new instance of AlarmHistory.

Instance Method Details

#describe ⇒ Object