Class: MintPress::Aws::CloudWatch::Alarm

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

Properties (Read/Write)

  • #alarm_names ⇒ Array of ⇒ [String]
    'The names of the alarms to retrieve information about.'
    Property Attributes
    • delete_alarms_prop ⇒ 'alarm_names'
    • read_only ⇒ false
    • source ⇒ "describe_alarms"
    • describe_alarms_prop ⇒ 'alarm_names'
    

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

property :alarm_names, delete_alarms_prop: 'alarm_names', type: [String], array: true, read_only: false, source: "describe_alarms", description: 'The names of the alarms to retrieve information about.', describe_alarms_prop: 'alarm_names'
  • #alarm_name_prefix ⇒ [String]
    'An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix. If this parameter is specified, you cannot specify AlarmNames.'
    Property Attributes
    • describe_alarms_prop ⇒ 'alarm_name_prefix'
    • source ⇒ "describe_alarms"
    

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

property :alarm_name_prefix, describe_alarms_prop: 'alarm_name_prefix', type: [String], source: "describe_alarms", description: 'An alarm name prefix. If you specify this parameter, you receive
information about all alarms that have names that start with this
prefix.

If this parameter is specified, you cannot specify AlarmNames.'
  • #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_alarms_prop ⇒ 'alarm_types'
    • source ⇒ "describe_alarms"
    

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

property :alarm_types, describe_alarms_prop: 'alarm_types', type: [String], array: true, source: "describe_alarms", 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.'
  • #children_of_alarm_name ⇒ [String]
    'If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the AlarmRule field of the composite alarm that you specify in ChildrenOfAlarmName. Information about the composite alarm that you name in ChildrenOfAlarmName is not returned. If you specify ChildrenOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error. Only the Alarm Name, ARN, StateValue (OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.'
    Property Attributes
    • describe_alarms_prop ⇒ 'children_of_alarm_name'
    • source ⇒ "describe_alarms"
    

29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm.rb', line 29

property :children_of_alarm_name, describe_alarms_prop: 'children_of_alarm_name', type: [String], source: "describe_alarms", description: 'If you use this parameter and specify the name of a composite alarm,
the operation returns information about the "children" alarms of the
alarm you specify. These are the metric alarms and composite alarms
referenced in the AlarmRule field of the composite alarm that you
specify in ChildrenOfAlarmName. Information about the composite
alarm that you name in ChildrenOfAlarmName is not returned.

If you specify ChildrenOfAlarmName, you cannot specify any other
parameters in the request except for MaxRecords and NextToken. If
you do so, you receive a validation error.

 Only the Alarm Name, ARN, StateValue
(OK/ALARM/INSUFFICIENT_DATA), and StateUpdatedTimestamp information
are returned by this operation when you use this parameter. To get
complete information about these alarms, perform another
DescribeAlarms operation and specify the parent alarm names in the
AlarmNames parameter.'
  • #parents_of_alarm_name ⇒ [String]
    'If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have AlarmRule parameters that reference the alarm named in ParentsOfAlarmName. Information about the alarm that you specify in ParentsOfAlarmName is not returned. If you specify ParentsOfAlarmName, you cannot specify any other parameters in the request except for MaxRecords and NextToken. If you do so, you receive a validation error. Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another DescribeAlarms operation and specify the parent alarm names in the AlarmNames parameter.'
    Property Attributes
    • describe_alarms_prop ⇒ 'parents_of_alarm_name'
    • source ⇒ "describe_alarms"
    

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm.rb', line 46

property :parents_of_alarm_name, describe_alarms_prop: 'parents_of_alarm_name', type: [String], source: "describe_alarms", description: 'If you use this parameter and specify the name of a metric or
composite alarm, the operation returns information about the
"parent" alarms of the alarm you specify. These are the composite
alarms that have AlarmRule parameters that reference the alarm named
in ParentsOfAlarmName. Information about the alarm that you specify
in ParentsOfAlarmName is not returned.

If you specify ParentsOfAlarmName, you cannot specify any other
parameters in the request except for MaxRecords and NextToken. If
you do so, you receive a validation error.

 Only the Alarm Name and ARN are returned by this operation when you
use this parameter. To get complete information about these alarms,
perform another DescribeAlarms operation and specify the parent
alarm names in the AlarmNames parameter.'
  • #state_value ⇒ [String]
    'Specify this parameter to receive information only about alarms that are currently in the state that you specify.'
    Property Attributes
    • describe_alarms_prop ⇒ 'state_value'
    • source ⇒ "describe_alarms"
    

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

property :state_value, describe_alarms_prop: 'state_value', type: [String], source: "describe_alarms", description: 'Specify this parameter to receive information only about alarms that
are currently in the state that you specify.'
  • #action_prefix ⇒ [String]
    'Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.'
    Property Attributes
    • describe_alarms_prop ⇒ 'action_prefix'
    • source ⇒ "describe_alarms"
    

63
64
65
66
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/cloud_watch/alarm.rb', line 63

property :action_prefix, describe_alarms_prop: 'action_prefix', type: [String], source: "describe_alarms", description: 'Use this parameter to filter the results of the operation to only
those alarms that use a certain alarm action. For example, you could
specify the ARN of an SNS topic to find all alarms that send
notifications to that topic.'
  • #max_records ⇒ [Integer]
    'The maximum number of alarm descriptions to retrieve.'
    Property Attributes
    • describe_alarms_prop ⇒ 'max_records'
    • source ⇒ "describe_alarms"
    

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

property :max_records, describe_alarms_prop: 'max_records', type: [Integer], source: "describe_alarms", description: 'The maximum number of alarm descriptions to retrieve.'
  • #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 
    

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

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
    

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

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

Returns a new instance of Alarm.

Instance Method Details

#delete ⇒ Object

#delete_cascade ⇒ Object

#describe ⇒ Object