Class: MintPress::Aws::Lightsail::Alarm

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

Properties (Read/Write)

  • #alarm_name ⇒ [String]
    'The name of the alarm. Specify an alarm name to return information about a specific alarm.'
    Property Attributes
    • delete_alarm_prop ⇒ 'alarm_name'
    • read_only ⇒ false
    • source ⇒ "get_alarms"
    • get_alarms_prop ⇒ 'alarm_name'
    

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

property :alarm_name, delete_alarm_prop: 'alarm_name', type: [String], read_only: false, source: "get_alarms", description: 'The name of the alarm.

Specify an alarm name to return information about a specific alarm.', get_alarms_prop: 'alarm_name'
  • #arn ⇒ [String]
    'The Amazon Resource Name (ARN) of the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'arn'
    

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

property :arn, disposition: :attribute, description: 'The Amazon Resource Name (ARN) of the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'arn', type: [String]
  • #comparison_operator ⇒ [String]
    'The arithmetic operation used when comparing the specified statistic and threshold.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'comparison_operator'
    

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

property :comparison_operator, disposition: :attribute, description: 'The arithmetic operation used when comparing the specified statistic and threshold.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'comparison_operator', type: [String]
  • #contact_protocols ⇒ Array of ⇒ [String]
    'The contact protocols for the alarm, such as Email, SMS (text messaging), or both.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'contact_protocols'
    

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

property :contact_protocols, disposition: :attribute, description: 'The contact protocols for the alarm, such as Email, SMS (text messaging), or both.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'contact_protocols', type: [String], array: true
  • #created_at ⇒ [Time]
    'The timestamp when the alarm was created.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'created_at'
    

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

property :created_at, disposition: :attribute, description: 'The timestamp when the alarm was created.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'created_at', type: [Time]
  • #datapoints_to_alarm ⇒ [Integer]
    'The number of data points that must not within the specified threshold to trigger the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'datapoints_to_alarm'
    

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

property :datapoints_to_alarm, disposition: :attribute, description: 'The number of data points that must not within the specified threshold to trigger the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'datapoints_to_alarm', type: [Integer]
  • #evaluation_periods ⇒ [Integer]
    'The number of periods over which data is compared to the specified threshold.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'evaluation_periods'
    

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

property :evaluation_periods, disposition: :attribute, description: 'The number of periods over which data is compared to the specified threshold.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'evaluation_periods', type: [Integer]
  • #location ⇒ [MintPress::Aws::Lightsail::ResourceLocation] (Default Value: MintPress::Aws::Lightsail::ResourceLocation.new)
    'An object that lists information about the location of the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'location'
    • default ⇒ MintPress::Aws::Lightsail::ResourceLocation.new
    

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

property :location, disposition: :attribute, description: 'An object that lists information about the location of the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'location', type: [MintPress::Aws::Lightsail::ResourceLocation], default: MintPress::Aws::Lightsail::ResourceLocation.new
  • #metric_name ⇒ [String]
    'The name of the metric associated with the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'metric_name'
    

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

property :metric_name, disposition: :attribute, description: 'The name of the metric associated with the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'metric_name', type: [String]
  • #monitored_resource_info ⇒ [MintPress::Aws::Lightsail::MonitoredResourceInfo] (Default Value: MintPress::Aws::Lightsail::MonitoredResourceInfo.new)
    'An object that lists information about the resource monitored by the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'monitored_resource_info'
    • default ⇒ MintPress::Aws::Lightsail::MonitoredResourceInfo.new
    

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

property :monitored_resource_info, disposition: :attribute, description: 'An object that lists information about the resource monitored by the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'monitored_resource_info', type: [MintPress::Aws::Lightsail::MonitoredResourceInfo], default: MintPress::Aws::Lightsail::MonitoredResourceInfo.new
  • #name ⇒ [String]
    'The name of the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'name'
    

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

property :name, disposition: :attribute, description: 'The name of the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'name', type: [String]
  • #notification_enabled ⇒ [TrueClass,FalseClass]
    'Indicates whether the alarm is enabled.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'notification_enabled'
    

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

property :notification_enabled, disposition: :attribute, description: 'Indicates whether the alarm is enabled.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'notification_enabled', type: [TrueClass,FalseClass]
  • #notification_triggers ⇒ Array of ⇒ [String]
    'The alarm states that trigger a notification.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'notification_triggers'
    

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

property :notification_triggers, disposition: :attribute, description: 'The alarm states that trigger a notification.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'notification_triggers', type: [String], array: true
  • #period ⇒ [Integer]
    'The period, in seconds, over which the statistic is applied.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'period'
    

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

property :period, disposition: :attribute, description: 'The period, in seconds, over which the statistic is applied.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'period', type: [Integer]
  • #resource_type ⇒ [String]
    'The Lightsail resource type (e.g., Alarm).'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'resource_type'
    

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

property :resource_type, disposition: :attribute, description: 'The Lightsail resource type (e.g., Alarm).', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'resource_type', type: [String]
  • #state ⇒ [String]
    'The current state of the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'state'
    

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

property :state, disposition: :attribute, description: 'The current state of the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'state', type: [String]
  • #statistic ⇒ [String]
    'The statistic for the metric associated with the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'statistic'
    

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

property :statistic, disposition: :attribute, description: 'The statistic for the metric associated with the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'statistic', type: [String]
  • #support_code ⇒ [String]
    'The support code.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'support_code'
    

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

property :support_code, disposition: :attribute, description: 'The support code.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'support_code', type: [String]
  • #threshold ⇒ [Float]
    'The value against which the specified statistic is compared.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'threshold'
    

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

property :threshold, disposition: :attribute, description: 'The value against which the specified statistic is compared.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'threshold', type: [Float]
  • #treat_missing_data ⇒ [String]
    'Specifies how the alarm handles missing data points.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'treat_missing_data'
    

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

property :treat_missing_data, disposition: :attribute, description: 'Specifies how the alarm handles missing data points.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'treat_missing_data', type: [String]
  • #unit ⇒ [String]
    'The unit of the metric associated with the alarm.'
    Property Attributes
    • disposition ⇒ :attribute
    • source ⇒ "MintPress::Aws::Lightsail::Alarm"
    • orig_name ⇒ 'unit'
    

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

property :unit, disposition: :attribute, description: 'The unit of the metric associated with the alarm.', source: "MintPress::Aws::Lightsail::Alarm", orig_name: 'unit', type: [String]
  • #page_token ⇒ [String]
    'The token to advance to the next page of results from your request. To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.'
    Property Attributes
    • get_alarms_prop ⇒ 'page_token'
    • read_only ⇒ false
    • source ⇒ "get_alarms"
    

44
45
46
47
48
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/alarm.rb', line 44

property :page_token, get_alarms_prop: 'page_token', type: [String], read_only: false, source: "get_alarms", description: 'The token to advance to the next page of results from your request.

To get a page token, perform an initial GetAlarms request. If your
results are paginated, the response will return a next page token that
you can specify as the page token in a subsequent request.'
  • #monitored_resource_name ⇒ [String]
    'The name of the Lightsail resource being monitored by the alarm. Specify a monitored resource name to return information about all alarms for a specific resource.'
    Property Attributes
    • get_alarms_prop ⇒ 'monitored_resource_name'
    • read_only ⇒ false
    • source ⇒ "get_alarms"
    

49
50
51
52
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lightsail/alarm.rb', line 49

property :monitored_resource_name, get_alarms_prop: 'monitored_resource_name', type: [String], read_only: false, source: "get_alarms", description: 'The name of the Lightsail resource being monitored by the alarm.

Specify a monitored resource name to return information about all
alarms for a specific resource.'
  • #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 
    

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

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
    

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

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

#get ⇒ Object