CreateInstanceAlarmInput

Register a cloud metric alarm with an instance. The alarm appears in the UI immediately and receives state transitions as soon as the cloud provider reports them. Webhooks from AWS CloudWatch, Azure Monitor, GCP Cloud Monitoring, and Prometheus Alertmanager match against cloudResourceId to attach state.

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

Fields

CreateInstanceAlarmInput.cloudResourceId ● String! non-null scalar {#cloud-resource-id}

The cloud provider's unique identifier for the alarm. Used to correlate incoming state transition webhooks back to this alarm. Examples: a CloudWatch AlarmArn, a GCP alert policy name, an Azure alert id.

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

How the metric is compared against threshold (e.g., GREATER_THAN, LESS_THAN). Optional for providers that don't expose this concept (e.g., Alertmanager, GCP).

CreateInstanceAlarmInput.displayName ● String! non-null scalar {#display-name}

Human-readable name for the alarm. Shown in the UI and in notifications. Typically the alarm name registered with the cloud provider.

CreateInstanceAlarmInput.metric ● AlarmMetricInput input {#metric}

The cloud metric this alarm evaluates. Optional; not all providers expose structured metric data.

CreateInstanceAlarmInput.period ● Int scalar {#period}

Evaluation window in seconds over which the metric is aggregated before the comparison is applied. Optional.

CreateInstanceAlarmInput.threshold ● Float scalar {#threshold}

The value crossed to trigger the alarm. Compared against the metric using comparisonOperator. Optional.

Member Of

createInstanceAlarm mutation