Skip to main content

​
Legend

​
UI

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

​
ModuleUI

UI configuration for the module.
​
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.
​
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) fr…
​
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.
​
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 (fro…See: MetricSource(templateable)

​
LogSource

A CloudWatch Logs source for a module log stream. Mirrors
​
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. &lt;&lt; stack.output.\* &gt;&gt;). The server uses `aws_…
​
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…(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
​
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. &lt;&lt; stack.output.\* &gt;&gt;). The server uses `aws_…
​
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…(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.