Class: Aws::IoTEvents::Types::CreateAlarmModelRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotevents/types.rb

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#alarm_capabilities ⇒ Types::AlarmCapabilities

Contains the configuration information of alarm state changes.

Returns:



838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_event_actions ⇒ Types::AlarmEventActions

Contains information about one or more alarm actions.

Returns:



838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_model_description ⇒ String

A description that tells you what the alarm model detects.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_model_name ⇒ String

A unique name that helps you identify the alarm model. You can’t change this name after you create the alarm model.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_notification ⇒ Types::AlarmNotification

Contains information about one or more notification actions.

Returns:



838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_rule ⇒ Types::AlarmRule

Defines when your alarm is invoked.

Returns:



838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

An input attribute used as a key to create an alarm. AWS IoT Events routes [inputs] associated with this key to the alarm.

[1]: docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)] in the *AWS General Reference*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#severity ⇒ Integer

A non-negative integer that reflects the severity level of the alarm.

Returns:

  • (Integer) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see

Tagging your AWS IoT Events resources][1

in the *AWS IoT Events

Developer Guide*.

You can create up to 50 tags for one alarm model.

[1]: docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html

Returns:



838
839
840
841
842
843
844
845
846
847
848
849
850
851
 
# File 'lib/aws-sdk-iotevents/types.rb', line 838

class CreateAlarmModelRequest < Struct.new(
  :alarm_model_name,
  :alarm_model_description,
  :role_arn,
  :tags,
  :key,
  :severity,
  :alarm_rule,
  :alarm_notification,
  :alarm_event_actions,
  :alarm_capabilities)
  SENSITIVE = []
  include Aws::Structure
end