Skip to main content

AWSCloudWatchCompositeAlarm

No description

type AWSCloudWatchCompositeAlarm {
metadata: ResourceMetadata!
actionsEnabled: Boolean!
actionsSuppressedBy: AWSCloudWatchCompositeAlarmActionsSuppressedByType!
actionsSuppressedReason: String!
actionsSuppressor: String!
actionsSuppressorExtensionPeriod: Int!
actionsSuppressorWaitPeriod: Int!
alarmActions: [AWSCloudWatchAlarmAction!]!
arn: String!
configurationUpdatedAt: DateTime
description: String!
name: String!
rule: String!
insufficientDataActions: [AWSCloudWatchAlarmAction!]!
okActions: [AWSCloudWatchAlarmAction!]!
stateReason: String!
stateReasonData: String!
stateTransitionedAt: DateTime
stateUpdatedAt: DateTime
stateValue: AWSCloudWatchAlarmStateValueType!
}

Fields

AWSCloudWatchCompositeAlarm.metadata ● ResourceMetadata! non-null object

The metadata to identify this API in Shisho Cloud

AWSCloudWatchCompositeAlarm.actionsEnabled ● Boolean! non-null scalar

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

AWSCloudWatchCompositeAlarm.actionsSuppressedBy ● AWSCloudWatchCompositeAlarmActionsSuppressedByType! non-null enum

When the value is ALARM , it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod , it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state

AWSCloudWatchCompositeAlarm.actionsSuppressedReason ● String! non-null scalar

Captures the reason for action suppression

AWSCloudWatchCompositeAlarm.actionsSuppressor ● String! non-null scalar

Actions will be suppressed if the suppressor alarm is in the ALARM state

AWSCloudWatchCompositeAlarm.actionsSuppressorExtensionPeriod ● Int! non-null scalar

The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state. After this time, the composite alarm performs its actions. ExtensionPeriod is required only when ActionsSuppressor is specified

AWSCloudWatchCompositeAlarm.actionsSuppressorWaitPeriod ● Int! non-null scalar

The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state. After this time, the composite alarm performs its actions. WaitPeriod is required only when ActionsSuppressor is specified

AWSCloudWatchCompositeAlarm.alarmActions ● [AWSCloudWatchAlarmAction!]! non-null union

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)

AWSCloudWatchCompositeAlarm.arn ● String! non-null scalar

The Amazon Resource Name (ARN) of the alarm

AWSCloudWatchCompositeAlarm.configurationUpdatedAt ● DateTime scalar

The time stamp of the last update to the alarm configuration

AWSCloudWatchCompositeAlarm.description ● String! non-null scalar

The description of the alarm

AWSCloudWatchCompositeAlarm.name ● String! non-null scalar

The name of the alarm

AWSCloudWatchCompositeAlarm.rule ● String! non-null scalar

The rule that this alarm uses to evaluate its alarm state

AWSCloudWatchCompositeAlarm.insufficientDataActions ● [AWSCloudWatchAlarmAction!]! non-null union

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)

AWSCloudWatchCompositeAlarm.okActions ● [AWSCloudWatchAlarmAction!]! non-null union

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)

AWSCloudWatchCompositeAlarm.stateReason ● String! non-null scalar

An explanation for the alarm state, in text format

AWSCloudWatchCompositeAlarm.stateReasonData ● String! non-null scalar

An explanation for the alarm state, in JSON format

AWSCloudWatchCompositeAlarm.stateTransitionedAt ● DateTime scalar

The timestamp of the last change to the alarm's StateValue

AWSCloudWatchCompositeAlarm.stateUpdatedAt ● DateTime scalar

Tracks the timestamp of any state update, even if StateValue doesn't change

AWSCloudWatchCompositeAlarm.stateValue ● AWSCloudWatchAlarmStateValueType! non-null enum

The state value for the alarm

Implemented by

AWSCloudWatchAlarm union