Skip to main content

UpdateInstanceAlarmInput

Update a registered alarm's mutable fields. Omit a field to leave it unchanged.

input UpdateInstanceAlarmInput {
cloudResourceId: String
comparisonOperator: String
displayName: String
metric: AlarmMetricInput
period: Int
threshold: Float
}

Fields

UpdateInstanceAlarmInput.cloudResourceId ● String scalar {#cloud-resource-id}

The cloud provider's unique identifier for the alarm. Updating this changes which incoming webhooks correlate to this alarm.

UpdateInstanceAlarmInput.comparisonOperator ● String scalar {#comparison-operator}

How the metric is compared against threshold (e.g., GREATER_THAN, LESS_THAN).

UpdateInstanceAlarmInput.displayName ● String scalar {#display-name}

Human-readable name for the alarm. Shown in the UI and in notifications.

UpdateInstanceAlarmInput.metric ● AlarmMetricInput input {#metric}

The cloud metric this alarm evaluates.

UpdateInstanceAlarmInput.period ● Int scalar {#period}

Evaluation window in seconds over which the metric is aggregated.

UpdateInstanceAlarmInput.threshold ● Float scalar {#threshold}

The value crossed to trigger the alarm.

Member Of

updateInstanceAlarm mutation