MonitoringAlarms Object
Relationships
graph LR
MonitoringAlarms -->|"account"| Accounts
Properties
Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.
What the alarm does on each state change.
For a notification topic: whether it has at least one confirmed subscription. Null for other targets, and for a topic that was not read: one in another account, or a read that failed (for an ALARM-state topic the notifies_confirmed_subscriber entry in unreadable_fields says which). Read on GET, or on the list with fields[]=notifies_confirmed_subscriber.
The topic, when target_type is notification_topic.
1 property
The target's id.
The state change that triggers this action. The provider's own value is in remote_data.
alarmokinsufficient_data
The action target, verbatim (an ARN on AWS).
What kind of target it is. notification_topic: a pub/sub topic (SNS); scaling_policy: an autoscaling policy; instance_action: stop, terminate, reboot or recover a machine; incident_management: an OpsItem or incident; function: a serverless function. The provider's own value is in remote_data.
notification_topicscaling_policyinstance_actionincident_managementfunctionother
Whether the alarm runs its actions. False means it changes state silently.
metric: watches one metric or a metric expression. composite: combines other alarms through a rule. The list reads one type per call (alarm_type query parameter). The provider's own value is in remote_data.
metriccomposite
When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present — not the request time, and not a provider timestamp.
How the value is compared, normalised. outside_band, below_band and above_band compare against an anomaly-detection band instead of a threshold. Null for a composite alarm. The provider's own value is in remote_data.
greater_than_or_equalgreater_thanless_thanless_than_or_equaloutside_bandbelow_bandabove_bandunknown
When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
How many breaching periods within evaluation_periods make the alarm fire.
The alarm's description, verbatim.
How many periods are evaluated.
What a metric alarm watches: one entry for a single-metric alarm, or every metric and expression of a metric-math alarm. Empty for a composite alarm.
Dimension name to value, exactly as set.
A metric-math expression. Null for a plain metric.
The entry's id inside a metric-math alarm. Null for a single-metric alarm.
Metric name, verbatim.
Metric namespace, verbatim (AWS/EC2, or a log metric filter's namespace).
Aggregation period in seconds.
Whether this entry is the value the alarm evaluates.
Statistic or percentile, verbatim (Average, Sum, p99 ...).
The alarm's name, verbatim.
The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
Whether the alarm, when it fires, reaches at least one person or system: actions are enabled and at least one ALARM-state action is a notification topic with a confirmed subscription. False when actions are disabled or no ALARM-state action is a topic. Null when a topic could not be read. Read on GET, or on the list with fields[]=notifies_confirmed_subscriber.
Evaluation period of a single-metric alarm.
Which cloud this object was read from.
awsazuregcp
The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.
Where the object is located. 'global' denotes genuinely global resources (e.g. IAM, GCP VPC networks) rather than a guessed region. A substituted region (when none is derivable) is flagged in unreadable_fields.
Raw data returned from the remote API call.
A composite alarm's rule expression, verbatim. Null for a metric alarm.
Current alarm state. The provider's own value is in remote_data.
okalarminsufficient_dataunknown
Why the alarm is in its state, as the provider words it.
When the state last changed.
Key-value pairs exactly as the customer set them: no case folding, key/value normalization, or merging of separate provider concepts. An empty object means no tags; tags that could not be read appear in unreadable_fields instead.
The threshold. Null for a composite alarm, or a band alarm that compares against another metric.
What missing data points count as. missing: the alarm looks further back for enough points; ignore: the current state is kept. Null for a composite alarm. The provider's own value is in remote_data.
missingnot_breachingbreachingignoreunknown
Fields on this object that could not be read, and why. An empty array means everything was read. Use this to tell a real value from a missing one.
Explanation of the reason, where one adds anything.
The property on this resource that could not be read.
Why the field could not be read. available_on_get: Not read on list to keep the list fast; call GET for this resource's id to get it.
not_supported_by_providernot_configuredpermission_deniednot_collectedcollection_errorpartially_collectedavailable_on_get
When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.