Skip to main content

​
Legend

​
UI

UI configuration for links, logs, and metrics on the module dashboard

​
ModuleUI

UI configuration for the module. Defines links and metrics to display in the module’s dashboard.
​
UILink[] | null
Links to display, such as service URLs, documentation, etc.See: UILink(templateable)
​
UIMetric[] | null
Metrics charts displayed on the module dashboard.See: UIMetric(templateable)
​
UILog[] | null
Log sources displayed on the module’s Logs tab. Each entry is a CloudWatch log group the module emits to.See: UILog(templateable)
A link displayed in the module UI. Used to provide quick access to external resources like consoles, documentation, etc.
​
string
required
Display name for the link(minLen:1; templateable)
​
string
required
URL — can use template syntax like << output.xxx >> for dynamic values(templateable)

​
UILog

A log source displayed in the module UI’s Logs tab. Every field is templateable so module authors can pass an entire log definition (or individual fields) from stack outputs.
​
string
required
Stable identifier for the log source, used as the React key / scope id.(minLen:1; templateable)
​
string
required
Display name for the log source (shown as the source label).(minLen:1; templateable)
​
LogSource
required
Data source for the logs. Discriminated union — currently cloudwatch.See: LogSource(templateable)

​
UIMetric

A metric displayed in the module UI. Used to show CloudWatch metrics or other time-series data. Every field is templateable so module authors can pass an entire metric definition as a stack output (e.g. << stack.output.cpu_metric >>) or template individual fields piecemeal.
​
string
required
Stable identifier for the metric, used as the React key on the dashboard and in the metric query cache key. Must be unique within a module’s UI.(minLen:1; templateable)
​
string
required
Display name for the metric(minLen:1; templateable)
​
enum
required
Chart type for the metricAllowed values: line | bar(templateable)
​
MetricSource
required
Data source for the metric. Discriminated union — the only type currently supported is cloudwatch. The aggregation period is chosen by the requester (frontend) based on the selected time range, not by the module definition. The display unit is auto-detected server-side from the namespace + metric name; module authors no longer specify it.See: MetricSource(templateable)

​
LogSource

A CloudWatch Logs source for a module log stream. Mirrors CloudWatchMetricSource: every field is templateable so module authors can wire concrete values from stack outputs.
​
enum
required
Allowed values: cloudwatch(templateable)
​
string
required
(minLen:1; templateable)
​
string
required
(minLen:1; templateable)
​
string
required
(minLen:1; templateable)
​
string | null
(templateable)
​
string | null
(templateable)

​
MetricSource

CloudWatch-backed metric source. Module authors fill this in with literal values or templated references (e.g. << stack.output.* >>). The server uses aws_account_id to look up credentials and region to scope the CloudWatch call — no ARN parsing required. Every field is templateable so the entire source can be wired from a stack output map.
​
enum
required
Source type discriminatorAllowed values: cloudwatch(templateable)
​
string
required
Ravion AWS account reference used to resolve credentials for the CloudWatch call. Accepts either the Flightcontrol AWS account database ID (e.g. awsact_123) or the user-provided givenId configured on the AWS account. The resolver normalizes the value to the DB id before any downstream use; the givenId form is an input alias only and is never persisted as the canonical reference. The 12-digit AWS account number is rejected because the same number can map to multiple connected accounts.(minLen:1; templateable)
​
string
required
AWS region the metric lives in.(minLen:1; templateable)
​
string
required
CloudWatch namespace(minLen:1; templateable)
​
string
required
CloudWatch metric name(minLen:1; templateable)
​
string
required
CloudWatch statistic to apply(minLen:1; templateable)
​
map<string,string>
required
Dimensions used to scope the metric. Required — no longer derived from any ARN since the source no longer carries one.(templateable)

​
MetricType

Allowed metric chart types.Allowed values:
  • line
  • bar

​
CloudWatchLogSource

A CloudWatch Logs source for a module log stream. Mirrors CloudWatchMetricSource: every field is templateable so module authors can wire concrete values from stack outputs.
​
enum
required
Allowed values: cloudwatch(templateable)
​
string
required
(minLen:1; templateable)
​
string
required
(minLen:1; templateable)
​
string
required
(minLen:1; templateable)
​
string | null
(templateable)
​
string | null
(templateable)

​
CloudWatchMetricSource

CloudWatch-backed metric source. Module authors fill this in with literal values or templated references (e.g. << stack.output.* >>). The server uses aws_account_id to look up credentials and region to scope the CloudWatch call — no ARN parsing required. Every field is templateable so the entire source can be wired from a stack output map.
​
enum
required
Source type discriminatorAllowed values: cloudwatch(templateable)
​
string
required
Ravion AWS account reference used to resolve credentials for the CloudWatch call. Accepts either the Flightcontrol AWS account database ID (e.g. awsact_123) or the user-provided givenId configured on the AWS account. The resolver normalizes the value to the DB id before any downstream use; the givenId form is an input alias only and is never persisted as the canonical reference. The 12-digit AWS account number is rejected because the same number can map to multiple connected accounts.(minLen:1; templateable)
​
string
required
AWS region the metric lives in.(minLen:1; templateable)
​
string
required
CloudWatch namespace(minLen:1; templateable)
​
string
required
CloudWatch metric name(minLen:1; templateable)
​
string
required
CloudWatch statistic to apply(minLen:1; templateable)
​
map<string,string>
required
Dimensions used to scope the metric. Required — no longer derived from any ARN since the source no longer carries one.(templateable)

​
Readme

Human-readable module documentation in Markdown. Supports multiline content.