Class: Aws::CloudWatch::Types::CompositeAlarm

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

The details about a composite alarm.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actions_enabledBoolean

Indicates whether actions should be executed during any changes to the alarm state.

Returns:

  • (Boolean)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_actionsArray<String>

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

  • (Array<String>)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_arnString

The Amazon Resource Name (ARN) of the alarm.

Returns:

  • (String)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_configuration_updated_timestampTime

The time stamp of the last update to the alarm configuration.

Returns:

  • (Time)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_descriptionString

The description of the alarm.

Returns:

  • (String)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_nameString

The name of the alarm.

Returns:

  • (String)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#alarm_ruleString

The rule that this alarm uses to evaluate its alarm state.

Returns:

  • (String)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#insufficient_data_actionsArray<String>

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

  • (Array<String>)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#ok_actionsArray<String>

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

  • (Array<String>)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#state_reasonString

An explanation for the alarm state, in text format.

Returns:

  • (String)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason_dataString

An explanation for the alarm state, in JSON format.

Returns:

  • (String)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#state_updated_timestampTime

The time stamp of the last update to the alarm state.

Returns:

  • (Time)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end

#state_valueString

The state value for the alarm.

Returns:

  • (String)


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 207

class CompositeAlarm < Struct.new(
  :actions_enabled,
  :alarm_actions,
  :alarm_arn,
  :alarm_configuration_updated_timestamp,
  :alarm_description,
  :alarm_name,
  :alarm_rule,
  :insufficient_data_actions,
  :ok_actions,
  :state_reason,
  :state_reason_data,
  :state_updated_timestamp,
  :state_value)
  SENSITIVE = []
  include Aws::Structure
end