Skip to main content
Module definitions describe the inputs, UI, stack, build, and deploy behavior for reusable modules. Use this reference when you create or update module definition versions. For a compact, machine-readable version, fetch https://api.ravion.com/module-definitions/schema.md.

Legend

Module

The root module schema.
inputs
InputProperty[]
required
Input configuration defining the module’s form fieldsSee: InputProperty
stack
ModuleStack
Stack configuration for provisioning this moduleSee: ModuleStack
build
ModuleBuild
Build configuration for this moduleSee: ModuleBuild
deploy
ModuleDeployment
Deployment configuration for this moduleSee: ModuleDeployment
ui
ModuleUI
UI configuration for links, logs, and metrics on the module dashboardSee: ModuleUI
readme
string
Human-readable module documentation in Markdown.

Inputs

Input configuration defining the module’s form fields

InputProperty

Union of all input property types.One of: StringInputProperty, TextInputProperty, ObjectInputProperty, ObjectMapInputProperty, ObjectArrayInputProperty, ArrayInputProperty, ArrayStringInputProperty, NumberInputProperty, BooleanInputProperty, SectionInputProperty, CompoundInputProperty, RefInputProperty, GitRepoInputProperty, KeyValueInputProperty.

ArrayInputProperty

Array editor input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for array editor fieldsAllowed values: array
default
any[] | null
Default array value for the field(templateable)
placeholder
string
Placeholder text when the field is empty
required
boolean
Whether the field must be filled in

ArrayStringInputProperty

Array of strings input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for dynamic string arraysAllowed values: string_array
default
string[] | null
Default array of values(templateable)
placeholder
string
Placeholder text for each input field in the array
add_button_label
string
Label for the “Add” button below the list
values
StringValues
Allowed values — static array of options or dynamic reference for a multi-select dropdownSee: StringValues
required
boolean
Whether at least one item is required
patterns
ValidationPattern[]
Regex patterns to validate each array item againstSee: ValidationPattern

BooleanInputProperty

Boolean toggle/checkbox input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for boolean toggle fieldsAllowed values: boolean
default
boolean
required
Default boolean value(templateable)

CompoundInputProperty

Compound select input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for compound select dropdownsAllowed values: compound
fields
string[]
required
List of field names to expose from the selected compound value(minItems:1)
default
map<string,string | number | integer | boolean | string[]> | "$values:first"
Default value — a record with the field values(templateable)
required
boolean
Whether the field must be filled in
values
CompoundValues
Allowed values — static array of options or dynamic reference (required for compound)See: CompoundValues
no_options_message
string
Message shown when the dropdown has no available options
min_current_value
boolean
Use the current deployed value as the minimum allowed value

GitRepoInputProperty

Git repository input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for git repository selectorAllowed values: gitrepo
default
string
Default repository URL
placeholder
string
Placeholder text when the field is empty
required
boolean
Whether the field must be filled in

KeyValueInputProperty

Key-value pairs input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for key-value editor fieldsAllowed values: keyvalue
default
map<string,string> | null
Default key-value pairs for the field(templateable)
required
boolean
Whether the field must have at least one key-value pair

NumberInputProperty

Numeric input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for numeric fieldsAllowed values: number
default
integer | "$values:first"
Default numeric value(templateable)
placeholder
string
Placeholder text when the field is empty
required
boolean
Whether the field must be filled in
values
NumberValues
Allowed values — static array of options or dynamic reference for a dropdownSee: NumberValues
no_options_message
string
Message shown when the dropdown has no available options
min
integer
Minimum allowed value(format:int32)
max
integer
Maximum allowed value(format:int32)
min_current_value
boolean
Use the current deployed value as the minimum allowed value

ObjectArrayInputProperty

Structured array input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for structured object arraysAllowed values: object_array
default
ObjectArrayDefaultItem[] | null
Default array value for the fieldSee: ObjectArrayDefaultItem(templateable)
required
boolean
Whether the field must contain at least one item
item_label
string
Label for each array item, used in add buttons and editor headers
item_title
ObjectCollectionItemTitleConfig
User-facing title template for each array item.See: ObjectCollectionItemTitleConfig
item_description
string | null
User-facing description template shown as a secondary line for each array item.(templateable)
item_inputs
RefFallbackInputProperty[]
required
Input definitions for each object value in the array.See: RefFallbackInputProperty(minItems:1)

ObjectInputProperty

Object editor input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for object editor fieldsAllowed values: object
default
any | null
Default object value for the field(templateable)
placeholder
string
Placeholder text when the field is empty
required
boolean
Whether the field must be filled in

ObjectMapInputProperty

Structured map input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for structured object mapsAllowed values: object_map
default
map<string,any | null>
Default map value for the field(templateable)
required
boolean
Whether the field must contain at least one entry
key
MapKeyConfig
Metadata for the map entry key field.See: MapKeyConfig
item_title
ObjectCollectionItemTitleConfig
User-facing title template for each map item.See: ObjectCollectionItemTitleConfig
item_label
string
Label for each map item, used in add buttons and editor headers
item_inputs
RefFallbackInputProperty[]
required
Input definitions for each object value in the map.See: RefFallbackInputProperty(minItems:1)

RefInputProperty

Module reference input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
string
required
Reference to another module type — format is “$ref:<module-type>”
mapped_inputs
RefFallbackInputProperty[]
Input definitions that copy values from the selected referenced module into this module’s input values. Each mapped input is saved as a normal input on the c…See: RefFallbackInputProperty
required
boolean
Whether the module reference is required

SectionInputProperty

Visual section separator property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
type
enum
required
Input type for visual section separators — produces no valueAllowed values: section

StringInputProperty

Single-line text input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for single-line text fieldsAllowed values: string
default
string | "$values:first"
Default value for the field(templateable)
placeholder
string
Placeholder text when the field is empty
required
boolean
Whether the field must be filled in
values
StringValues
Allowed values — static array of options or dynamic reference for a dropdownSee: StringValues
no_options_message
string
Message shown when the dropdown has no available options
patterns
ValidationPattern[]
Regex patterns to validate againstSee: ValidationPattern
min_current_value
boolean
Use the current deployed value as the minimum allowed value

TextInputProperty

Multi-line text area input property.
id
string
required
Unique identifier for this input.(minLen:1)
label
string
required
Text shown above the form field(minLen:1)
description
string
Help text shown below the label
show_when
ShowWhen
Only show this field when another field has a specific valueSee: ShowWhen
immutable
boolean
Lock this field after first deploy — prevents changes to destructive settings
collapsible
boolean
Render this field as collapsible (tag when collapsed, full field when expanded) Supported for all value-producing input types.
type
enum
required
Input type for multi-line text areasAllowed values: text
default
string | null
Default value for the field(templateable)
placeholder
string
Placeholder text when the field is empty
required
boolean
Whether the field must be filled in
patterns
ValidationPattern[]
Regex patterns to validate againstSee: ValidationPattern

ShowWhen

Conditional visibility mapping; array source values support contains and contains-all matching.Type: map<string,ShowWhenCondition>

StringValues

String values - either a static array of options or a dynamic reference.One of: StringValueItem[], string.

ValidationPattern

A regex pattern with an error message for validation
pattern
string
required
JavaScript regex the input must match
message
string
required
Error shown to the user when validation fails

CompoundFieldValue

Allowed value types within a compound value item.One of: string, number, integer, boolean, string[].

CompoundValues

Compound values - either a static array of options or a dynamic reference.One of: CompoundValueItem[], string.

DefaultValueRef

Special default references derived from the field’s values list.Allowed values:
  • $values:first

Pipeline.GitRepoUrl

Full git repository URL including host.Type: string

NumberValues

Number values - either a static array of options or a dynamic reference.One of: NumberValueItem[], string.

ObjectArrayDefaultItem

Default value item for structured object arrays.Type: map<string,any | null>

ObjectCollectionItemTitleConfig

Configuration for the title shown for each structured collection item in the form.
template
string
required
Template for the item title. Supports placeholders like {key} for maps and {field_id}.
fallback
string
Fallback title template used when the primary template cannot be resolved.

RefFallbackInputProperty

Input properties allowed inside module reference fallback inputs.Discriminated union. The type field selects which schema applies.

MapKeyConfig

Configuration for the string key of an object_map entry.
label
string
Text shown for the map key field.
placeholder
string
Placeholder text for a new map key.
description
string
Help text shown below the map key field.
patterns
ValidationPattern[]
Regex patterns to validate map keys against.See: ValidationPattern
from_fields
string | null[]
Item input fields used to compute the map key instead of asking for one. Empty/null entries are ignored.
separator
string
String used to join computed key field values. Defaults to ”-”.

RefTypeDiscriminator

Type discriminator for module references.Type: string

ShowWhenCondition

A show_when condition.One of: string | integer | boolean | string | integer | boolean[], ShowWhenNotCondition.

DynamicValuesRef

Dynamic values reference.Type: string

StringValueItem

A selectable option with a string value.
label
string
Text shown in the dropdown
description
string
Extra detail shown alongside the option
group_label
string
Groups options under a shared heading in the dropdown
value
string
required
Actual value sent to Terraform when this option is selected
show_when
ShowWhen
Only show this option when another field has a specific valueSee: ShowWhen

CompoundValueItem

A compound value item - a record with arbitrary fields plus select metadata.
label
string
Text shown in the dropdown
description
string
Extra detail shown alongside the option
group_label
string
Groups options under a shared heading in the dropdown

NumberValueItem

A selectable option with a numeric value.
label
string
Text shown in the dropdown
description
string
Extra detail shown alongside the option
group_label
string
Groups options under a shared heading in the dropdown
value
integer
required
Actual number sent to Terraform when this option is selected(format:int32)
show_when
ShowWhen
Only show this option when another field has a specific valueSee: ShowWhen

ShowWhenComparableValue

Value or values to compare against in a show_when condition; arrays mean membership for scalar sources and contains-all for array sources.One of: string | integer | boolean, string | integer | boolean[].

ShowWhenNotCondition

Negated show_when condition.
not
string | integer | boolean | string | integer | boolean[]
required
Show the property only when the source value does not match this condition.

ShowWhenValue

Value that can be used in a show_when condition.One of: string, integer, boolean.

Stack

Stack configuration for provisioning this module

ModuleStack

Root stack block in module.yaml
type
enum
required
IaC stack typeAllowed values: terraform | opentofu(templateable)
pipelines
StackPipelinesConfig
required
Configuration for all stack pipelinesSee: StackPipelinesConfig
ravion_state_backend_workspace
string | null
The Ravion Cloud workspace name to use for state storage.(templateable)

StackPipelinesConfig

Stack pipeline configuration
defaults
StackPipelineDefaults
required
Defaults applied to stack runs and merged into trigger run inputs.See: StackPipelineDefaults
change
StackActionPipelineConfig
required
Configuration for stack change pipelineSee: StackActionPipelineConfig
destroy
StackActionPipelineConfig
required
Configuration for stack destroy pipelineSee: StackActionPipelineConfig

StackActionPipelineConfig

Pipeline configuration for a stack action
pipeline_id
string
required
Pipeline ID for this stack action(minLen:1; templateable)
triggers
Pipeline.PipelineTrigger[]
Triggers that automatically start pipeline runs on webhook events.See: Pipeline.PipelineTrigger

StackPipelineDefaults

Default stack pipeline run configuration
variant
string
required
Default variant used for stack-triggered runs(minLen:1; templateable)
input
map<string,any | null>
Default input values merged into each trigger run variant(templateable)

Pipeline.PipelineTrigger

Pipeline trigger definition.Discriminated union. The type field selects which schema applies.

Pipeline.GenericPipelineTrigger

Pipeline trigger for generic webhooks.
id
string
required
Unique identifier for this trigger
repo
string
required
Git repository in owner/repo or host/owner/repo format(templateable)
filter
Pipeline.TriggerFilter
Filters to narrow which events trigger the pipelineSee: Pipeline.TriggerFilter
run
map<string,Pipeline.TriggerRunVariantConfig>
required
Maps variant IDs to run configuration — keys must match declared variant IDs.See: Pipeline.TriggerRunVariantConfig
type
enum
required
Webhook type for generic webhook triggers.Allowed values: webhook

Pipeline.GithubPipelineTrigger

Pipeline trigger for GitHub webhooks.
id
string
required
Unique identifier for this trigger
repo
string
required
Git repository in owner/repo or host/owner/repo format(templateable)
filter
Pipeline.TriggerFilter
Filters to narrow which events trigger the pipelineSee: Pipeline.TriggerFilter
run
map<string,Pipeline.TriggerRunVariantConfig>
required
Maps variant IDs to run configuration — keys must match declared variant IDs.See: Pipeline.TriggerRunVariantConfig
type
enum
required
Webhook type — determines which events are supported.Allowed values: webhook:github
event
enum
required
Webhook event type to listen for.Allowed values: push | pull_request | pull_request_review | pull_request_review_comment | pull_request_review_thread | release | deployment

Pipeline.GitlabPipelineTrigger

Pipeline trigger for GitLab webhooks.
id
string
required
Unique identifier for this trigger
repo
string
required
Git repository in owner/repo or host/owner/repo format(templateable)
filter
Pipeline.TriggerFilter
Filters to narrow which events trigger the pipelineSee: Pipeline.TriggerFilter
run
map<string,Pipeline.TriggerRunVariantConfig>
required
Maps variant IDs to run configuration — keys must match declared variant IDs.See: Pipeline.TriggerRunVariantConfig
type
enum
required
Webhook type — determines which events are supported.Allowed values: webhook:gitlab
event
enum
required
Webhook event type to listen for.Allowed values: push | merge_request | tag_push

Pipeline.TriggerFilter

Trigger filter configuration
branch
string | null
Only trigger when this branch is pushed(templateable)
tag
string | null
Only trigger when a tag matching this pattern is pushed(templateable)
action
string | string[]
Only trigger for specific webhook actions.(templateable)
paths
string[] | null
Only trigger when files in these paths are changed(templateable)
payload
Pipeline.PayloadCondition[]
Filter by webhook payload fields using dot-notation paths.See: Pipeline.PayloadCondition

Pipeline.TriggerRepo

Git repository identifier used by webhook triggers.Type: string

Pipeline.TriggerRunVariantConfig

Per-variant run configuration for a trigger.
description
string | null
Description for the pipeline run created by this trigger variant(templateable)
input
map<string,any | null>
Input overrides for this variant run(templateable)

Pipeline.GithubWebhookEvent

GitHub webhook events that can trigger a pipelineAllowed values:
  • push
  • pull_request
  • pull_request_review
  • pull_request_review_comment
  • pull_request_review_thread
  • release
  • deployment

Pipeline.GitlabWebhookEvent

GitLab webhook events that can trigger a pipelineAllowed values:
  • push
  • merge_request
  • tag_push

Pipeline.PayloadCondition

Condition to check against a webhook payload field.
path
string
required
Dot-notation path to the payload field
equals
string | null
Exact string match(templateable)
contains
string | null
Substring match(templateable)
matches
string | null
Glob pattern match(templateable)
one_of
string[] | null
Value must be one of these strings(templateable)
not
Pipeline.PayloadConditionMatcher
Negated payload field matcher. The condition fails when this matcher is true.See: Pipeline.PayloadConditionMatcher

Pipeline.PayloadConditionMatcher

Payload field matcher used by positive conditions and negated conditions.
equals
string | null
Exact string match(templateable)
contains
string | null
Substring match(templateable)
matches
string | null
Glob pattern match(templateable)
one_of
string[] | null
Value must be one of these strings(templateable)

Build

Build configuration for this module

ModuleBuild

Build configuration — discriminated by module build typeDiscriminated union. The type field selects which schema applies.

DisabledModuleBuild

Disabled build configuration for a module. Additional fields are ignored.
type
enum
required
Build type discriminatorAllowed values: disabled

ImageModuleBuild

Image build configuration for a module.
type
enum
required
Build type discriminatorAllowed values: image(templateable)
timeout
integer | null
Maximum execution time in seconds before the build is killed.(format:int32,min:1; templateable)
inputs
InputProperty[]
required
Build-specific inputs shown when running a module build.See: InputProperty
source
Pipeline.GitSource
required
Git source configuration.See: Pipeline.GitSource(templateable)
builder
Pipeline.ImageBuildConfig
required
Builder configuration — dockerfile, nixpacks, or railpack settings.See: Pipeline.ImageBuildConfig(templateable)
environment_variables
Pipeline.EnvironmentVariablesValue
Environment variables available during the build.See: Pipeline.EnvironmentVariablesValue(templateable)
debug
boolean | null
Enable verbose build output for debugging build issues.(templateable)
destinations
Pipeline.EcrDestination[]
required
ECR destinations where the built Docker image will be pushed.See: Pipeline.EcrDestination(minItems:1; templateable)
infrastructure
Pipeline.StepInfrastructure
required
Execution environment configuration used for the build.See: Pipeline.StepInfrastructure(templateable)

LambdaModuleBuild

Lambda build configuration for a module. Produces a zip artifact uploaded to S3, sized for the Lambda Zip package type. Wraps the existing `Pipeline.BuildLam…
type
enum
required
Build type discriminatorAllowed values: lambda(templateable)
timeout
integer | null
Maximum execution time in seconds before the build is killed.(format:int32,min:1; templateable)
inputs
InputProperty[]
required
Build-specific inputs shown when running a module build.See: InputProperty
source
Pipeline.GitSource
required
Git source configuration.See: Pipeline.GitSource(templateable)
builder
Pipeline.LambdaBuildConfig
required
Builder configuration — dockerfile or nixpacks settings for the Lambda zip build. Reuses the existing Pipeline.LambdaBuildConfig shape so module builds and…See: Pipeline.LambdaBuildConfig(templateable)
environment_variables
Pipeline.EnvironmentVariablesValue
Environment variables available during the build.See: Pipeline.EnvironmentVariablesValue(templateable)
debug
boolean | null
Enable verbose build output for debugging build issues.(templateable)
destinations
Pipeline.S3Destination[]
required
S3 destinations where the Lambda deployment package will be uploaded. At least one is required; the resulting key is passed to the deploy step as `deploy.inp…See: Pipeline.S3Destination(minItems:1; templateable)
infrastructure
Pipeline.StepInfrastructure
required
Execution environment configuration used for the build.See: Pipeline.StepInfrastructure(templateable)

StaticModuleBuild

Static build configuration for a module.
type
enum
required
Build type discriminatorAllowed values: static(templateable)
timeout
integer | null
Maximum execution time in seconds before the build is killed.(format:int32,min:1; templateable)
inputs
InputProperty[]
required
Build-specific inputs shown when running a module build.See: InputProperty
source
Pipeline.GitSource
required
Git source configuration.See: Pipeline.GitSource(templateable)
builder
Pipeline.StaticBuildConfig
required
Builder configuration — dockerfile, nixpacks, or railpack settings.See: Pipeline.StaticBuildConfig(templateable)
environment_variables
Pipeline.EnvironmentVariablesValue
Environment variables available during the build.See: Pipeline.EnvironmentVariablesValue(templateable)
debug
boolean | null
Enable verbose build output for debugging build issues.(templateable)
destinations
Pipeline.S3Destination[]
required
S3 destinations where the built static assets will be uploaded.See: Pipeline.S3Destination(minItems:1; templateable)
infrastructure
Pipeline.StepInfrastructure
required
Execution environment configuration used for the build.See: Pipeline.StepInfrastructure(templateable)

Pipeline.EcrDestination

ECR destination for image builds
id
string
required
Unique destination identifier within the build step(templateable)
type
enum
required
ECR destination typeAllowed values: ecr(templateable)
repository_arn
string
required
ECR repository ARN(templateable)
tags
string[] | null
Docker image tags to apply in ECR after the build finishes(templateable)

Pipeline.EnvironmentVariablesValue

Environment variable map value.One of: map<string,Pipeline.EnvironmentVariable>, string.

Pipeline.GitSource

Git source configuration for fetching code
type
enum
required
Source type identifierAllowed values: git(templateable)
repo
string
required
Full repository URL including host(templateable)
branch
string
required
Branch to check out(minLen:1; templateable)
ref
string | null
Git ref to check out — branch, commit SHA, tag, or other ref. Overrides branch HEAD if set.(templateable)
base_path
string | null
default:"."
Base path within the repository to use as the working root(templateable)

Pipeline.ImageBuildConfig

Image build configuration — discriminated by build methodDiscriminated union. The type field selects which schema applies.

Pipeline.StepInfrastructure

Step infrastructure configuration
execution_environment_id
string | null
ID or given ID of a pre-configured execution environment(templateable)
aws_account_id
string | null
AWS account reference for automatic network selection.(templateable)
region
string | null
AWS region for automatic network selection(templateable)
type
enum
required
Instance type — “ec2” for on-demand or “ec2-spot” for cheaper spot instancesAllowed values: ec2 | ec2-spot(templateable)
instance_size
string | string[]
required
Instance size — a single size like “large” or an array like [“large”, “xlarge”] for spot fallback(templateable)
ami
string | null
AMI ID for the runner instance(templateable)
permissions
Pipeline.AwsPermissions
IAM permissions for the runner role — “attach” to add policies or “replace” to override step defaultsSee: Pipeline.AwsPermissions(templateable)
storage
Pipeline.StorageConfig
Root volume storage configurationSee: Pipeline.StorageConfig(templateable)

Pipeline.LambdaBuildConfig

Lambda build configuration — discriminated by build methodDiscriminated union. The type field selects which schema applies.

Pipeline.S3Destination

S3 destination for build artifacts
id
string
required
Unique destination identifier within the build step(minLen:1; templateable)
type
enum
required
S3 destination typeAllowed values: s3(templateable)
bucket
string
required
S3 bucket name where built assets will be uploaded(templateable)
directory
string | null
S3 directory override for the uploaded build output.(templateable)
region
string
required
AWS region for the destination S3 bucket(templateable)

Pipeline.StaticBuildConfig

Static build configuration — discriminated by build methodDiscriminated union. The type field selects which schema applies.

Pipeline.EnvironmentVariable

Environment variable — can be a plain string, Parameter Store reference, or Secrets Manager referenceOne of: string | null, Pipeline.ParameterStoreEnvVar, Pipeline.SecretsManagerEnvVar.

Pipeline.DisabledBuildConfig

Disabled build configuration. Valid only for module-driven builds.
type
enum
required
Build method — disables module build executionAllowed values: disabled(templateable)

Pipeline.ImageDockerfileBuildConfig

Dockerfile configuration for image builds
type
enum
required
Build method — use a custom DockerfileAllowed values: dockerfile(templateable)
dockerfile
string | null
default:"Dockerfile"
Path to Dockerfile relative to source.base_path(minLen:1; templateable)
context
string | null
default:"."
Docker build context path relative to source.base_path(templateable)
inject_env_variables_in_dockerfile
boolean | null
Whether to inject environment variables as Docker build args Accepts either a boolean literal or a full template token(templateable)
cache_from
Pipeline.CacheFromConfig
Docker layer cache configurationSee: Pipeline.CacheFromConfig(templateable)

Pipeline.ImageNixpacksBuildConfig

Nixpacks configuration for image builds
type
enum
required
Build method — use Nixpacks auto-detectionAllowed values: nixpacks(templateable)
nixpacks_version
string | null
Nixpacks version to use(templateable)
build_path
string | null
Directory to run the Nixpacks build from, relative to the repository root(templateable)
config_file_path
string | null
Path to the Nixpacks configuration file relative to the repository root(templateable)
nix_pkgs
string[] | null
Additional Nix packages to install(templateable)
apt_pkgs
string[] | null
Additional apt packages to install(templateable)
nix_libs
string[] | null
Additional Nix libraries to install(templateable)
install_cmd
string | null
Custom install command(templateable)
build_cmd
string | null
Custom build command(templateable)
start_cmd
string | null
Application start command(templateable)
cache_from
Pipeline.CacheFromConfig
Docker layer cache configurationSee: Pipeline.CacheFromConfig(templateable)

Pipeline.ImageRailpackBuildConfig

Railpack configuration for image builds
type
enum
required
Build method — use Railpack auto-detectionAllowed values: railpack(templateable)
railpack_version
string | null
Railpack version to use(templateable)
install_cmd
string | null
Custom install command(templateable)
build_cmd
string | null
Custom build command(templateable)
start_cmd
string | null
Application start command(templateable)
cache_from
Pipeline.CacheFromConfig
Docker layer cache configurationSee: Pipeline.CacheFromConfig(templateable)

Pipeline.AwsPermissions

IAM policies configuration for runner roles Used by EC2-backed steps to specify additional permissionsOne of: Pipeline.AwsPermissionsAttach, Pipeline.AwsPermissionsReplace.

Pipeline.InfrastructureType

Execution environment typeAllowed values:
  • ec2
  • ec2-spot

Pipeline.InstanceSize

Instance size can be a single string or array of stringsOne of: string, string[].

Pipeline.StorageConfig

Root volume storage configuration
type
enum
Volume typeAllowed values: gp3 | gp2 | io2 | io1(templateable)
size
integer | null
Volume size in GiB(format:int32; templateable)
iops
integer | null
Provisioned IOPS(format:int32; templateable)
throughput
integer | null
Provisioned throughput in MiB/s(format:int32; templateable)

Pipeline.LambdaDockerfileBuildConfig

Dockerfile configuration for Lambda builds
type
enum
required
Build method — use a custom DockerfileAllowed values: dockerfile(templateable)
dockerfile
string | null
default:"Dockerfile"
Path to Dockerfile relative to source.base_path(minLen:1; templateable)
context
string | null
default:"."
Docker build context path relative to source.base_path(templateable)
inject_env_variables_in_dockerfile
boolean | null
Whether to inject environment variables as Docker build args Accepts either a boolean literal or a full template token(templateable)
output_directory
string
required
Directory inside the built image containing the Lambda package contents(minLen:1; templateable)
max_zip_size
integer | null
default:"52428800"
Maximum allowed zip size in bytes — build fails if exceeded(format:int32; templateable)

Pipeline.LambdaNixpacksBuildConfig

Nixpacks configuration for Lambda builds
type
enum
required
Build method — use Nixpacks auto-detectionAllowed values: nixpacks(templateable)
nixpacks_version
string | null
Nixpacks version to use(templateable)
build_path
string | null
Directory to run the Nixpacks build from, relative to the repository root(templateable)
config_file_path
string | null
Path to the Nixpacks configuration file relative to the repository root(templateable)
nix_pkgs
string[] | null
Additional Nix packages to install(templateable)
apt_pkgs
string[] | null
Additional apt packages to install(templateable)
nix_libs
string[] | null
Additional Nix libraries to install(templateable)
install_cmd
string | null
Custom install command(templateable)
build_cmd
string | null
Custom build command(templateable)
start_cmd
string | null
Application start command(templateable)
output_directory
string
required
Directory inside the built image containing the Lambda package contents(minLen:1; templateable)
max_zip_size
integer | null
default:"52428800"
Maximum allowed zip size in bytes — build fails if exceeded(format:int32; templateable)

Pipeline.StaticDockerfileBuildConfig

Dockerfile configuration for static builds
type
enum
required
Build method — use a custom DockerfileAllowed values: dockerfile(templateable)
dockerfile
string | null
default:"Dockerfile"
Path to Dockerfile relative to source.base_path(minLen:1; templateable)
context
string | null
default:"."
Docker build context path relative to source.base_path(templateable)
inject_env_variables_in_dockerfile
boolean | null
Whether to inject environment variables as Docker build args Accepts either a boolean literal or a full template token(templateable)
output_directory
string
required
Directory inside the built image containing the static assets to upload This path is resolved relative to source.base_path(minLen:1; templateable)

Pipeline.StaticNixpacksBuildConfig

Nixpacks configuration for static builds
type
enum
required
Build method — use Nixpacks auto-detectionAllowed values: nixpacks(templateable)
nixpacks_version
string | null
Nixpacks version to use(templateable)
build_path
string | null
Directory to run the Nixpacks build from, relative to the repository root(templateable)
config_file_path
string | null
Path to the Nixpacks configuration file relative to the repository root(templateable)
nix_pkgs
string[] | null
Additional Nix packages to install(templateable)
apt_pkgs
string[] | null
Additional apt packages to install(templateable)
nix_libs
string[] | null
Additional Nix libraries to install(templateable)
install_cmd
string | null
Custom install command(templateable)
build_cmd
string | null
Custom build command(templateable)
output_directory
string
required
Directory inside the built image containing the static assets to upload This path is resolved relative to source.base_path(minLen:1; templateable)

Pipeline.StaticRailpackBuildConfig

Railpack configuration for static builds
type
enum
required
Build method — use Railpack auto-detectionAllowed values: railpack(templateable)
railpack_version
string | null
Railpack version to use(templateable)
install_cmd
string | null
Custom install command(templateable)
build_cmd
string | null
Custom build command(templateable)
output_directory
string
required
Directory inside the built image containing the static assets to upload This path is resolved relative to source.base_path(minLen:1; templateable)

Pipeline.ParameterStoreEnvVar

Environment variable from AWS Parameter Store
from_parameter_store
Pipeline.ParameterStoreReferenceValue
required
Parameter Store referenceSee: Pipeline.ParameterStoreReferenceValue(templateable)

Pipeline.SecretsManagerEnvVar

Environment variable from AWS Secrets Manager
from_secrets_manager
Pipeline.SecretsManagerReferenceValue
required
Secrets Manager referenceSee: Pipeline.SecretsManagerReferenceValue(templateable)

Pipeline.CacheFromConfig

Configuration for Docker layer cache source from ECR
digest
string | null
Specific image digest to use for cache(templateable)
tag
string | null
Specific image tag to use for cache(templateable)

Pipeline.AwsPermissionsAttach

IAM policies to attach alongside step default policies
attach
string[]
required
AWS managed policy ARNs to attach alongside step default policies(templateable)

Pipeline.AwsPermissionsReplace

IAM policies to replace step default policies entirely
replace
string[]
required
AWS managed policy ARNs to use instead of step default policies(templateable)

Pipeline.EbsVolumeType

EBS volume type for the runner root volumeAllowed values:
  • gp3
  • gp2
  • io2
  • io1

Pipeline.ParameterStoreReferenceValue

Parameter Store reference — shorthand string or object with optional version metadataOne of: string, Pipeline.ParameterStoreReference.

Pipeline.SecretsManagerReferenceValue

Secrets Manager reference — shorthand string or object with optional JSON key/version metadataOne of: string, Pipeline.SecretsManagerReference.

Pipeline.ParameterStoreReference

Parameter Store reference with optional version metadata
key
string
required
Parameter Store parameter name or path(templateable)
version
string | null
Parameter version number(templateable)

Pipeline.SecretsManagerReference

Secrets Manager reference with optional JSON key and version metadata
key
string
required
Secret name or ARN in Secrets Manager(templateable)
json_key
string | null
JSON key to extract from a JSON-structured secret(templateable)
version
string | null
Secret version ID or stage(templateable)

Deploy

Deployment configuration for this module

ModuleDeployment

Deployment configuration — discriminated by deployment typeDiscriminated union. The type field selects which schema applies.

AwsStaticModuleDeployment

AWS static site deployment configuration
type
enum
required
Deployment type discriminatorAllowed values: aws:static
infrastructure
AwsStaticDeploymentInfrastructure
required
Infrastructure resources required by the deploymentSee: AwsStaticDeploymentInfrastructure
timeout
integer
Maximum total wall-clock budget (in seconds) for a single deploy, measured from the moment the workflow starts (including time spent waiting for the deployme…(format:int32,min:60)
inputs
InputProperty[]
required
Deployment-specific inputs shown in the deploy modal.See: InputProperty
definition
AwsStaticDeploymentDefinition
required
Per-deploy definition. Templateable — supports both module.input and deploy.input references inside string fields.See: AwsStaticDeploymentDefinition(templateable)

EcsModuleDeployment

AWS ECS deployment configuration
type
enum
required
Deployment type discriminatorAllowed values: aws:ecs
infrastructure
EcsDeploymentInfrastructure
required
Infrastructure resources required by the deploymentSee: EcsDeploymentInfrastructure
strategy
EcsDeploymentStrategyConfig
Deployment strategy — rolling (default), blue_green, linear, or canary.See: EcsDeploymentStrategyConfig(templateable)
concurrency
EcsDeployConcurrency
Concurrency policy — controls how simultaneous deploy requests are handled.See: EcsDeployConcurrency
timeout
integer
Maximum total wall-clock budget (in seconds) for a single deploy, measured from the moment the workflow starts (including time spent waiting for the deployme…(format:int32,min:60)
inputs
InputProperty[]
required
Deployment-specific inputs shown in the deploy modal Same types as module inputs — reuses the InputProperty unionSee: InputProperty
task_definition
EcsTaskDefinition
required
AWS ECS task definition — fully typed per the RegisterTaskDefinition API Templateable — supports both module.input and deploy.input referencesSee: EcsTaskDefinition(templateable)
pre_deploy
EcsRunTaskOverrides
See: EcsRunTaskOverrides(templateable)
post_deploy
EcsRunTaskOverrides
See: EcsRunTaskOverrides(templateable)

LambdaModuleDeployment

AWS Lambda deployment configuration. v1 supports UpdateFunctionCode + PublishVersion + UpdateAlias. Pre/post deploy hooks and weighted- routing alias shifts…
type
enum
required
Deployment type discriminatorAllowed values: aws:lambda
infrastructure
LambdaDeploymentInfrastructure
required
Infrastructure resources required by the deployment.See: LambdaDeploymentInfrastructure
timeout
integer
Maximum total wall-clock budget (in seconds) for a single deploy, measured from the moment the workflow starts (including time spent waiting for the deployme…(format:int32,min:60)
inputs
InputProperty[]
required
Deployment-specific inputs shown in the deploy modal.See: InputProperty
definition
LambdaDeploymentDefinition
required
Per-deploy definition. Templateable — supports both module.input and deploy.input references inside string fields.See: LambdaDeploymentDefinition(templateable)
function_configuration
LambdaFunctionConfiguration
Per-deploy function-configuration overrides applied via UpdateFunctionConfiguration before the new code is published.See: LambdaFunctionConfiguration(templateable)

AwsStaticDeploymentDefinition

Per-deploy definition for AWS static deployments. The deploy manager promotes the resolved s3_directory to the active KVS key and (optionally) issues a b…
s3_directory
string
required
S3 directory (version prefix) to promote to active.(minLen:1; templateable)
cloudfront_invalidation_paths
string[] | null
CloudFront cache invalidation paths to issue across every distribution after the KVS write succeeds. Runs in the background — the deploy is marked complete o…(templateable)
keep_latest_successful_deploy_count
integer | null
Number of latest successful deploys to keep in S3. Older S3 directories are pruned in the background after a successful deploy. Omit or set to 0 to disable p…(format:int32,min:0; templateable)

AwsStaticDeploymentInfrastructure

Infrastructure resources required for AWS static site deployment.
cloudfront_keyvaluestore_arn
string
required
CloudFront KeyValueStore ARN that holds the active version pointer.(minLen:1; templateable)
cloudfront_distribution_arns
string[]
required
CloudFront distribution ARNs that share this origin/KVS.(minItems:1; templateable)
s3_region
string
required
AWS region of the S3 hosting bucket.(minLen:1; templateable)
s3_bucket
string
required
S3 bucket name that hosts the versioned build directories.(minLen:1; templateable)

EcsDeployConcurrency

Concurrency policy for ECS deployments targeting this module instance.
queue_size
integer
Number of pending deploy requests that can wait in the queue.(format:int32,min:0)
queue_overflow
enum
What to do when the queue is full and a new deploy request arrives.Allowed values: oldest | newest | reject

EcsDeploymentInfrastructure

Infrastructure resources required for ECS deployment. Not provisioned by the deploy manager — must already exist.
ecs_cluster_arn
string
required
ECS cluster ARN where the service runs(minLen:1; templateable)
ecs_service_arn
string
required
ECS service ARN of the service the deploy manager updates. The deploy strategy (rolling, blue/green, linear, canary) is executed natively by the ECS deployme…(minLen:1; templateable)
ecs_target_group_arn
string | null
ARN of the main (blue / production) target group attached to the ECS service. Forwarded as the UpdateService loadBalancers[].targetGroupArn when Ravion syn…(templateable)
ecs_alternate_target_group_arn
string | null
ARN of the alternate (green) target group ECS shifts traffic to during native traffic-shift deployments (blue_green / linear / canary). Forwarded into the Up…(templateable)
ecs_production_listener_rule_arn
string | null
ARN of the production listener rule (ALB) or listener (NLB) ECS rewrites to shift production traffic during native traffic-shift deployments.(templateable)
ecs_infrastructure_role_arn
string | null
ARN of the IAM infrastructure role ECS assumes to manage the load-balancer wiring (register/deregister targets, rewrite listener rules) during native traffic…(templateable)
ecs_test_listener_rule_arn
string | null
ARN of the optional test listener rule (ALB) or listener (NLB) ECS rewrites during the TEST_TRAFFIC_SHIFT lifecycle stages to route test traffic to the green…(templateable)

EcsDeploymentStrategyConfig

Deployment strategy executed natively by the ECS deployment controller.
type
enum
required
Deployment strategy: - rolling — in-place rolling update (default) - blue_green — full green revision, all-at-once traffic shift + bake - linear — traffic sh…Allowed values: rolling | blue_green | linear | canary(templateable)
bake_time_in_minutes
integer | null
Minutes both revisions keep running after production traffic has fully shifted, before the old revision is terminated. Rollback during the bake window is ins…(format:int32,min:0,max:1440; templateable)
canary
EcsCanaryConfig
Canary tuning — only valid when type is canary.See: EcsCanaryConfig(templateable)
linear
EcsLinearConfig
Linear tuning — required when type is linear.See: EcsLinearConfig(templateable)
pause_stages
EcsPauseStage[] | null
Native PAUSE lifecycle hooks. Each entry pauses the deployment at the given stage until continued via the dashboard or API. Max 10.See: EcsPauseStage(templateable)

EcsRunTaskOverrides

Full AWS ECS RunTask request payload — both the TaskOverride fields and the top-level RunTask parameters that aren’t part of TaskOverride (launchType, ne…
container_overrides
EcsContainerOverride[] | null
Per-container overrides. Each entry’s name matches a container in the task definition. AWS RunTask supports overriding any subset of containers; the array…See: EcsContainerOverride(templateable)
cpu
string | null
Task-level CPU override (string for AWS compatibility — same format as task-definition cpu, e.g. "256", "1024").(templateable)
memory
string | null
Task-level memory override (MiB, string format).(templateable)
task_role_arn
string | null
IAM task role ARN override — what the container assumes when calling AWS APIs from inside the task.(templateable)
execution_role_arn
string | null
IAM execution role ARN override — what ECS uses to pull the image, push logs, and read secrets at task launch.(templateable)
ephemeral_storage
EcsEphemeralStorage
Fargate ephemeral storage size override (20–200 GiB).See: EcsEphemeralStorage(templateable)
launch_type
enum | null
Launch type: FARGATE, EC2, or EXTERNAL. When omitted the hook inherits the parent service’s launch type. Mutually exclusive with capacity_provider_strategyAllowed values: FARGATE | EC2 | EXTERNAL(templateable)
capacity_provider_strategy
EcsCapacityProviderStrategyItem[] | null
Capacity-provider strategy — overrides launch_type when set.See: EcsCapacityProviderStrategyItem(templateable)
platform_version
string | null
Fargate platform version (e.g. "1.4.0", "LATEST").(templateable)
network_configuration
EcsNetworkConfiguration
VPC / subnet / security-group config. Required for awsvpc network-mode task definitions; inherited from the parent service when omitted.See: EcsNetworkConfiguration(templateable)
placement_constraints
EcsPlacementConstraint[] | null
Placement constraints — limits which container instances can run the task. EC2/EXTERNAL launch types only.See: EcsPlacementConstraint(templateable)
placement_strategy
EcsPlacementStrategy[] | null
Placement strategy — how tasks get distributed across instances.See: EcsPlacementStrategy(templateable)
propagate_tags
enum | null
How tags propagate from task definition / service onto the task.Allowed values: TASK_DEFINITION | SERVICE | NONE(templateable)
tags
EcsTag[] | null
Metadata tags applied to the task.See: EcsTag(templateable)
enable_ecs_managed_tags
boolean | null
Whether to enable AWS-managed aws:ecs: tags on the task.(templateable)
enable_execute_command
boolean | null
Whether to enable ECS Exec on the task (for aws ecs execute-command).(templateable)
group
string | null
Logical group name — used for placement constraints (memberOf(group:&lt;group&gt;)). Defaults to family:&lt;task-def-family&gt; when AWS picks.(templateable)
reference_id
string | null
Caller-supplied reference id (UUID-shaped). Echoed back on the resulting Task and useful for client-side correlation.(templateable)
volume_configurations
EcsTaskVolumeConfiguration[] | null
Per-task volume bindings — name must match a volume in the task definition. Used for Fargate-managed ephemeral EBS volumes.See: EcsTaskVolumeConfiguration(templateable)
timeout
integer | null
Wall-clock timeout in seconds before the task is stopped and the deployment fails. Only meaningful when used as a pre/post deploy hook config — ignored on th…(format:int32,min:1; templateable)

EcsTaskDefinition

AWS ECS task definition — models the RegisterTaskDefinition API input.
family
string
required
Task definition family name(templateable)
container_definitions
EcsContainerDefinition[]
required
Container definitions — at least one requiredSee: EcsContainerDefinition(minItems:1; templateable)
cpu
string | null
Task-level CPU units (required for Fargate) Valid values: “256”, “512”, “1024”, “2048”, “4096” etc.(templateable)
memory
string | null
Task-level memory in MiB (required for Fargate)(templateable)
network_mode
enum | null
Network mode — “awsvpc” required for FargateAllowed values: awsvpc | bridge | host | none(templateable)
requires_compatibilities
enum[FARGATE,EC2][] | null
Launch type compatibility(templateable)
task_role_arn
string | null
IAM role ARN for task permissions (containers assume this role)(templateable)
execution_role_arn
string | null
IAM role ARN for ECS agent to pull images and write logs(templateable)
runtime_platform
EcsRuntimePlatform
Runtime platform (Fargate only)See: EcsRuntimePlatform(templateable)
ephemeral_storage
EcsEphemeralStorage
Ephemeral storage (Fargate only, >20 GiB)See: EcsEphemeralStorage(templateable)
volumes
EcsVolume[] | null
Volumes available to containersSee: EcsVolume(templateable)
tags
EcsTag[] | null
AWS resource tagsSee: EcsTag(templateable)
ipc_mode
enum | null
IPC mode for containers (EC2 only)Allowed values: host | task | none(templateable)
pid_mode
enum | null
PID mode for containers (EC2 only)Allowed values: host | task(templateable)
proxy_configuration
EcsProxyConfiguration
App Mesh proxy configurationSee: EcsProxyConfiguration(templateable)
inference_accelerators
EcsInferenceAccelerator[] | null
Inference accelerators (EC2 only)See: EcsInferenceAccelerator(templateable)

LambdaDeploymentDefinition

Per-deploy Lambda definition — discriminated by package_type.Discriminated union. The package_type field selects which schema applies.

LambdaDeploymentInfrastructure

Infrastructure resources required for AWS Lambda deployment.
function_arn
string
required
Full ARN of the Lambda function the deploy targets.(minLen:1; templateable)
region
string
required
AWS region of the function. Mirrors aws_static_module_deployment’s s3_region — needed because Lambda’s regional endpoint is the only thing the workflow c…(minLen:1; templateable)
alias_name
string | null
Alias the deploy flips after publishing the new function version.(templateable)
s3_artifact_bucket
string | null
S3 bucket the build step uploaded the zip artifact into. Optional — captured into the deploy snapshot for audit even when the deploy itself targets an Image-…(templateable)

LambdaFunctionConfiguration

AWS Lambda function configuration — every field optional, applied as a partial update via UpdateFunctionConfiguration. Fields the user omits are left untou…
role
string | null
IAM execution role ARN.(templateable)
handler
string | null
Handler entrypoint (Zip only — ignored for Image).(templateable)
runtime
string | null
Lambda runtime (Zip only — ignored for Image).(templateable)
memory_size
integer | null
Memory size in MiB. 128–10240.(format:int32,min:128,max:10240; templateable)
timeout
integer | null
Wall-clock timeout in seconds. 1–900.(format:int32,min:1,max:900; templateable)
description
string | null
Function description shown in the AWS console.(templateable)
architectures
enum[x86_64,arm64][] | null
CPU architectures — exactly one of x86_64 or arm64.(templateable)
environment
LambdaEnvironment
Environment variables applied to the function.See: LambdaEnvironment(templateable)
vpc_config
LambdaVpcConfig
VPC configuration. Setting empty arrays disconnects the function from the VPC.See: LambdaVpcConfig(templateable)
layers
string[] | null
Lambda layer ARNs (versioned, e.g.(templateable)
ephemeral_storage
LambdaEphemeralStorage
Ephemeral /tmp storage size.See: LambdaEphemeralStorage(templateable)
tracing_config
LambdaTracingConfig
X-Ray tracing mode.See: LambdaTracingConfig(templateable)
kms_key_arn
string | null
Customer-managed KMS key ARN for environment variable encryption.(templateable)
dead_letter_config
LambdaDeadLetterConfig
Dead-letter destination for async invocations.See: LambdaDeadLetterConfig(templateable)
file_system_configs
LambdaFileSystemConfig[] | null
EFS file systems attached to the function.See: LambdaFileSystemConfig(templateable)
snap_start
LambdaSnapStart
SnapStart configuration. Java-only on AWS today, but the field is forwarded as-is to Lambda.See: LambdaSnapStart(templateable)
logging_config
LambdaLoggingConfig
CloudWatch logging configuration.See: LambdaLoggingConfig(templateable)
image_config
LambdaImageConfig
Image overrides — image-packaged functions only.See: LambdaImageConfig(templateable)

EcsCanaryConfig

Canary traffic-shift tuning. Only valid when strategy.type is canary.
canary_percent
number | null
Percentage of production traffic to shift to the new service revision during the canary phase. Multiples of 0.1 from 0.1 to 100.0.(format:double,min:0.1,max:100; templateable)
canary_bake_time_in_minutes
integer | null
Minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision.(format:int32,min:0,max:1440; templateable)

EcsLinearConfig

Linear traffic-shift tuning. Required when strategy.type is linear.
step_percentage
integer
required
Percentage of production traffic shifted per step.(format:int32,min:1,max:100; templateable)
step_bake_time_in_minutes
integer
required
Minutes to bake between each traffic-shift step.(format:int32,min:0,max:1440; templateable)

EcsPauseStage

A native ECS PAUSE lifecycle hook. The deployment pauses at the given stage until a continue/rollback control is sent (dashboard or `POST /deployments/{id}/c…
stage
enum
required
Lifecycle stage at which the deployment pauses.Allowed values: RECONCILE_SERVICE | PRE_SCALE_UP | POST_SCALE_UP | POST_TEST_TRAFFIC_SHIFT | PRE_PRODUCTION_TRAFFIC_SHIFT | POST_PRODUCTION_TRAFFIC_SHIFT(templateable)
timeout_in_minutes
integer | null
Minutes to wait for a continue before AWS applies timeout_action.(format:int32,min:1,max:20160; templateable)
timeout_action
enum | null
What AWS does when the pause times out. Default: ROLLBACK.Allowed values: ROLLBACK | CONTINUE(templateable)

EcsCapacityProviderStrategyItem

Capacity-provider strategy entry. Mirrors AWS exactly.
capacity_provider
string
required
Capacity provider name (e.g. FARGATE, FARGATE_SPOT, or a custom EC2 capacity provider).(templateable)
weight
integer | null
Relative share of tasks placed onto this provider when the strategy has multiple entries.(format:int32,min:0,max:1000; templateable)
base
integer | null
Minimum number of tasks placed onto this provider before weighting kicks in. At most one entry in the strategy may set base.(format:int32,min:0,max:100000; templateable)

EcsContainerOverride

Per-container portion of EcsRunTaskOverrides. Mirrors the AWS ECS RunTask ContainerOverride struct field-for-field — every override AWS supports for a co…
name
string
required
Container name from the task definition. Required.(minLen:1; templateable)
command
string[] | null
Replacement command — replaces the container’s CMD array.(templateable)
environment
EcsEnvironmentVariable[] | null
Environment variables merged on top of the task definition’s.See: EcsEnvironmentVariable(templateable)
environment_files
EcsEnvironmentFile[] | null
Environment files (S3 references) layered on top of environment.See: EcsEnvironmentFile(templateable)
cpu
integer | null
CPU units override for this container.(format:int32; templateable)
memory
integer | null
Hard memory limit (MiB) override for this container.(format:int32; templateable)
memory_reservation
integer | null
Soft memory reservation (MiB) override for this container.(format:int32; templateable)
resource_requirements
EcsResourceRequirement[] | null
GPU / InferenceAccelerator requirements override.See: EcsResourceRequirement(templateable)

EcsEphemeralStorage

ECS ephemeral storage configuration
size_in_gib
integer
required
Storage size in GiB (21–200 for Fargate, minimum 20)(format:int32,min:20,max:200; templateable)

EcsNetworkConfiguration

AWS ECS network configuration. Only the awsvpc shape exists on RunTask (host / bridge networking is task-definition-driven).
awsvpc_configuration
EcsAwsVpcConfiguration
required
VPC configuration — required when set.See: EcsAwsVpcConfiguration(templateable)

EcsPlacementConstraint

AWS ECS placement constraint. EC2/EXTERNAL launch types only — Fargate ignores these.
type
enum
required
Constraint type. distinctInstance spreads tasks one-per-host; memberOf filters by a cluster query expression.Allowed values: distinctInstance | memberOf(templateable)
expression
string | null
Cluster query expression — required when type is memberOf.(templateable)

EcsPlacementStrategy

AWS ECS placement strategy. EC2/EXTERNAL launch types only — Fargate ignores these.
type
enum
required
Strategy type. random ignores field; spread and binpack require field.Allowed values: random | spread | binpack(templateable)
field
string | null
Attribute the strategy operates on (e.g. instanceId, attribute:ecs.availability-zone, cpu, memory).(templateable)

EcsTag

AWS resource tag
key
string
required
Tag key(templateable)
value
string
required
Tag value(templateable)

EcsTaskVolumeConfiguration

Per-task volume binding for ECS-managed volumes (today: ephemeral EBS for Fargate). The name must match a volume entry in the task definition’s volumes l…
name
string
required
Volume name — must match a name in the task definition.(templateable)
managed_ebs_volume
EcsTaskManagedEBSVolumeConfiguration
Managed-EBS volume configuration.See: EcsTaskManagedEBSVolumeConfiguration(templateable)

EcsContainerDefinition

ECS container definition — models a single container within a task.
name
string
required
Container name — must be unique within the task(templateable)
image
string
required
Docker image URI(templateable)
cpu
integer | null
Container-level CPU units(format:int32; templateable)
memory
integer | null
Hard memory limit in MiB — container is killed if it exceeds this(format:int32; templateable)
memory_reservation
integer | null
Soft memory limit in MiB — used for memory reservation(format:int32; templateable)
essential
boolean | null
Whether the task should stop if this container exits(templateable)
port_mappings
EcsPortMapping[] | null
Port mappingsSee: EcsPortMapping(templateable)
environment
EcsEnvironmentVariable[] | null
Environment variablesSee: EcsEnvironmentVariable(templateable)
secrets
EcsSecret[] | null
Secrets from Parameter Store or Secrets ManagerSee: EcsSecret(templateable)
command
string[] | null
Startup command — overrides the Docker CMD(templateable)
entry_point
string[] | null
Entrypoint — overrides the Docker ENTRYPOINT(templateable)
working_directory
string | null
Working directory inside the container(templateable)
health_check
EcsHealthCheck
Container health checkSee: EcsHealthCheck(templateable)
log_configuration
EcsLogConfiguration
Log configurationSee: EcsLogConfiguration(templateable)
linux_parameters
EcsLinuxParameters
Linux-specific parametersSee: EcsLinuxParameters(templateable)
docker_labels
map<string,string> | null
Docker labels(templateable)
privileged
boolean | null
Run as privileged (EC2 only)(templateable)
user
string | null
User to run as (uid or uid:gid)(templateable)
stop_timeout
integer | null
Stop timeout in seconds before SIGKILL(format:int32; templateable)
disable_networking
boolean | null
Disable networking for this container(templateable)
resource_requirements
EcsResourceRequirement[] | null
GPU and inference accelerator requirementsSee: EcsResourceRequirement(templateable)
mount_points
EcsMountPoint[] | null
Volume mount pointsSee: EcsMountPoint(templateable)
volumes_from
EcsVolumeFrom[] | null
Volumes to inherit from other containersSee: EcsVolumeFrom(templateable)
depends_on
EcsContainerDependency[] | null
Container startup dependenciesSee: EcsContainerDependency(templateable)
repository_credentials
EcsRepositoryCredentials
Private registry credentialsSee: EcsRepositoryCredentials(templateable)
firelens_configuration
EcsFirelensConfiguration
Firelens log routing configurationSee: EcsFirelensConfiguration(templateable)
system_controls
EcsSystemControl[] | null
System controls — kernel parameter overridesSee: EcsSystemControl(templateable)
environment_files
EcsEnvironmentFile[] | null
Files containing environment variablesSee: EcsEnvironmentFile(templateable)
readonly_root_filesystem
boolean | null
Read-only root filesystem(templateable)
interactive
boolean | null
Interactive mode (stdin)(templateable)
pseudo_terminal
boolean | null
Pseudo-terminal allocation(templateable)

EcsInferenceAccelerator

Inference accelerator for ML workloads
device_name
string
required
Accelerator name(templateable)
device_type
string
required
Accelerator type(templateable)

EcsProxyConfiguration

App Mesh proxy configuration
type
enum | null
Proxy typeAllowed values: APPMESH(templateable)
container_name
string
required
Container name for the proxy(templateable)
properties
EcsProxyConfigurationProperty[] | null
Proxy configuration propertiesSee: EcsProxyConfigurationProperty(templateable)

EcsRuntimePlatform

ECS runtime platform configuration
cpu_architecture
enum | null
CPU architecture — X86_64 or ARM64Allowed values: X86_64 | ARM64(templateable)
operating_system_family
enum | null
Operating system familyAllowed values: LINUX | WINDOWS_SERVER_2019_FULL | WINDOWS_SERVER_2019_CORE | WINDOWS_SERVER_2022_FULL | WINDOWS_SERVER_2022_CORE(templateable)

EcsVolume

ECS volume — host path or Docker volume
name
string
required
Volume name — referenced by container mount points(templateable)
host_path
string | null
Host path for bind mounts (EC2 only)(templateable)
efs_volume_configuration
EcsEfsVolumeConfiguration
EFS volume configurationSee: EcsEfsVolumeConfiguration(templateable)

LambdaImageDefinition

Image-packaged Lambda deploy definition. The image must already exist in ECR (typically pushed by the upstream build step’s ecr destination).
package_type
enum
required
Definition type discriminator.Allowed values: image(templateable)
image_uri
string
required
Full ECR image URI. Prefer &lt;repo&gt;@sha256:&lt;digest&gt; form for reproducibility — Lambda resolves a mutable tag at deploy time and silently pins it, but the dep…(minLen:1; templateable)

LambdaZipDefinition

Zip-packaged Lambda deploy definition. The code object must already exist in S3 (typically uploaded by the upstream build step’s s3-zip destination).
package_type
enum
required
Definition type discriminator.Allowed values: zip(templateable)
s3_key
string
required
S3 key the build step uploaded into.(minLen:1; templateable)

LambdaDeadLetterConfig

Dead-letter destination for async invocations.
target_arn
string | null
SQS queue ARN or SNS topic ARN.(templateable)

LambdaEnvironment

Lambda function environment block. Mirrors AWS Lambda’s Environment shape — a single variables map of string → string.
variables
map<string,string> | null
Environment variables applied to the function. Replaces the existing variable set on AWS — the API doesn’t merge.(templateable)

LambdaEphemeralStorage

Function-level ephemeral storage (/tmp) size in MiB.
size
integer
required
Size in MiB. 512–10240.(format:int32,min:512,max:10240; templateable)

LambdaFileSystemConfig

EFS file system attached to the function.
arn
string
required
EFS access point ARN.(templateable)
local_mount_path
string
required
Mount path inside the container — must start with /mnt/.(templateable)

LambdaImageConfig

Container image configuration overrides — image-packaged functions only.
command
string[] | null
Override the image’s CMD.(templateable)
entry_point
string[] | null
Override the image’s ENTRYPOINT.(templateable)
working_directory
string | null
Override the image’s WORKDIR.(templateable)

LambdaLoggingConfig

Function logging configuration (CloudWatch destination + log levels).
log_format
enum | null
Format the logs are emitted in.Allowed values: JSON | Text(templateable)
application_log_level
enum | null
Application log level — only valid when log_format is JSON.Allowed values: TRACE | DEBUG | INFO | WARN | ERROR | FATAL(templateable)
system_log_level
enum | null
System log level — only valid when log_format is JSON.Allowed values: DEBUG | INFO | WARN(templateable)
log_group
string | null
Destination CloudWatch log group.(templateable)

LambdaSnapStart

SnapStart configuration.
apply_on
enum
required
When to take the snapshot. None disables SnapStart; PublishedVersions snapshots each PublishVersion call.Allowed values: None | PublishedVersions(templateable)

LambdaTracingConfig

AWS X-Ray tracing configuration.
mode
enum
required
Active samples + traces requests; PassThrough only propagates an upstream sampling decision.Allowed values: Active | PassThrough(templateable)

LambdaVpcConfig

VPC configuration for a Lambda function.
subnet_ids
string[] | null
Subnet IDs the function’s ENIs are placed into.(templateable)
security_group_ids
string[] | null
Security group IDs attached to the function’s ENIs.(templateable)
ipv6_allowed_for_dual_stack
boolean | null
Whether the function gets dual-stack IPv6 networking.(templateable)

EcsEnvironmentFile

Environment file from S3
value
string
required
S3 ARN of the environment file(templateable)
type
enum
required
File typeAllowed values: s3(templateable)

EcsEnvironmentVariable

Environment variable as name-value pair
name
string
required
Variable name(templateable)
value
string
required
Variable value(templateable)

EcsResourceRequirement

GPU or other resource requirement
type
enum
required
Resource type — currently only GPUAllowed values: GPU | InferenceAccelerator(templateable)
value
string
required
Number of resources(templateable)

EcsAwsVpcConfiguration

AWS VPC configuration for awsvpc-mode tasks.
subnets
string[]
required
Subnet IDs the task ENI is placed into.(minItems:1; templateable)
security_groups
string[] | null
Security groups attached to the task ENI.(templateable)
assign_public_ip
enum | null
Whether the task ENI gets a public IP. Required for Fargate tasks pulling images from non-VPC-routable registries (e.g.Allowed values: ENABLED | DISABLED(templateable)

EcsTaskManagedEBSVolumeConfiguration

AWS-managed Fargate ephemeral EBS volume configuration.
role_arn
string
required
IAM role ARN AWS uses to provision the EBS volume on the customer’s behalf. Required.(templateable)
volume_type
string | null
EBS volume type (gp3, gp2, io2, io1, sc1, st1, standard).(templateable)
size_in_gib
integer | null
Volume size (GiB). Range depends on volume_type.(format:int32; templateable)
snapshot_id
string | null
Snapshot id to restore from.(templateable)
iops
integer | null
Provisioned IOPS — required for io1/io2, optional for gp3.(format:int32; templateable)
throughput
integer | null
Provisioned throughput (MiB/s) — gp3 only.(format:int32; templateable)
filesystem_type
string | null
Filesystem type to format the volume with (ext3, ext4, xfs, ntfs). Defaults per OS family.(templateable)
kms_key_id
string | null
KMS key id (alias or ARN) for at-rest encryption.(templateable)
encrypted
boolean | null
Whether the volume is encrypted at rest.(templateable)
tag_specifications
EcsEBSTagSpecification[] | null
Tag specifications applied to the EBS volume.See: EcsEBSTagSpecification(templateable)
termination_policy
EcsTaskManagedEBSVolumeTerminationPolicy
Termination policy — controls whether the volume is deleted when the task stops.See: EcsTaskManagedEBSVolumeTerminationPolicy(templateable)
volume_initialization_rate
integer | null
Initialization rate (MiB/s) for snapshot-restored volumes — controls how fast blocks are pre-warmed.(format:int32; templateable)

EcsContainerDependency

Container dependency — controls startup order
container_name
string
required
Name of the dependency container(templateable)
condition
enum
required
Condition to wait forAllowed values: START | COMPLETE | SUCCESS | HEALTHY(templateable)

EcsFirelensConfiguration

Firelens log routing configuration
type
enum
required
Router typeAllowed values: fluentbit | fluentd(templateable)
options
map<string,string> | null
Router options(templateable)

EcsHealthCheck

Container health check configuration
command
string[]
required
Command to run — prefix with CMD or CMD-SHELL(templateable)
interval
integer | null
Interval between checks in seconds(format:int32; templateable)
timeout
integer | null
Timeout for each check in seconds(format:int32; templateable)
retries
integer | null
Number of retries before marking unhealthy(format:int32; templateable)
start_period
integer | null
Grace period before health checks start in seconds(format:int32; templateable)

EcsLinuxParameters

Linux-specific container settings
init_process_enabled
boolean | null
Run an init process inside the container(templateable)
capabilities
EcsLinuxCapabilities
Linux capabilities to add or dropSee: EcsLinuxCapabilities(templateable)
shared_memory_size
integer | null
Shared memory size in MiB(format:int32; templateable)
tmpfs
EcsTmpfs[] | null
Tmpfs mountsSee: EcsTmpfs(templateable)

EcsLogConfiguration

Log configuration for a container
log_driver
enum
required
Log driver — awslogs for CloudWatch, awsfirelens for FirelensAllowed values: awslogs | awsfirelens | json-file | syslog | fluentd | splunk(templateable)
options
map<string,string> | null
Driver-specific options(templateable)
secret_options
EcsSecret[] | null
Secret log options (ARN references)See: EcsSecret(templateable)

EcsMountPoint

Container mount point referencing a volume
source_volume
string
required
Name of the volume (must match a volume in the task definition)(templateable)
container_path
string
required
Path inside the container to mount(templateable)
read_only
boolean | null
Whether the mount is read-only(templateable)

EcsPortMapping

Port mapping for a container
container_port
integer
required
Port on the container(format:int32; templateable)
host_port
integer | null
Port on the host (EC2) or omit for awsvpc(format:int32; templateable)
protocol
enum | null
Transport protocolAllowed values: tcp | udp(templateable)
app_protocol
enum | null
Application protocol for service connectAllowed values: http | http2 | grpc(templateable)

EcsRepositoryCredentials

Private registry credentials
credentials_parameter
string
required
ARN of the Secrets Manager secret containing registry credentials(templateable)

EcsSecret

Secret injected from Parameter Store or Secrets Manager
name
string
required
Environment variable name in the container(templateable)
value_from
string
required
Full ARN of the secret in Parameter Store or Secrets Manager(templateable)

EcsSystemControl

System control — kernel parameter override
namespace
string
required
Namespace (e.g., net.core.somaxconn)(templateable)
value
string
required
Value to set(templateable)

EcsVolumeFrom

Volume-from reference — mount volumes from another container
source_container
string
required
Source container name(templateable)
read_only
boolean | null
Whether the mount is read-only(templateable)

EcsProxyConfigurationProperty

Proxy configuration key-value property
name
string
required
Property name(templateable)
value
string
required
Property value(templateable)

EcsEfsVolumeConfiguration

EFS volume configuration for ECS tasks
file_system_id
string
required
EFS file system ID(templateable)
root_directory
string | null
Root directory on the EFS file system(templateable)
transit_encryption
enum | null
Whether to enable IAM authorizationAllowed values: ENABLED | DISABLED(templateable)
transit_encryption_port
integer | null
Port for transit encryption (default 2049)(format:int32; templateable)
authorization_config
EcsEfsAuthorizationConfig
EFS access point IDSee: EcsEfsAuthorizationConfig(templateable)

EcsEBSTagSpecification

Tag specification for an ECS-managed EBS volume.
resource_type
enum
required
Resource type the tags apply to. Currently only volume is supported.Allowed values: volume(templateable)
propagate_tags
enum | null
Where the tags come from — explicit list, propagated from the task definition, or none.Allowed values: TASK_DEFINITION | SERVICE | NONE(templateable)
tags
EcsTag[] | null
Explicit tags.See: EcsTag(templateable)

EcsTaskManagedEBSVolumeTerminationPolicy

Termination policy for an ECS-managed EBS volume.
delete_on_termination
boolean
required
Whether to delete the volume when the task stops.(templateable)

EcsLinuxCapabilities

Linux kernel capabilities
add
string[] | null
Capabilities to add(templateable)
drop
string[] | null
Capabilities to drop(templateable)

EcsTmpfs

Tmpfs mount configuration
container_path
string
required
Mount path in the container(templateable)
size
integer
required
Maximum size in MiB(format:int32; templateable)
mount_options
string[] | null
Mount options(templateable)

EcsEfsAuthorizationConfig

EFS authorization config
access_point_id
string | null
EFS access point ID(templateable)
iam
enum | null
Whether to use the task execution role for EFSAllowed values: ENABLED | DISABLED(templateable)

UI

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

ModuleUI

UI configuration for the module.
Links to display, such as service URLs, documentation, etc.See: UILink(templateable)
metrics
UIMetric[] | null
Metrics charts displayed on the module dashboard.See: UIMetric(templateable)
logs
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.
name
string
required
Display name for the link(minLen:1; templateable)
href
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…
id
string
required
Stable identifier for the log source, used as the React key / scope id.(minLen:1; templateable)
name
string
required
Display name for the log source (shown as the source label).(minLen:1; templateable)
source
LogSource
required
Data source for the logs. Discriminated union — currently cloudwatch.See: LogSource(templateable)

UIMetric

A metric displayed in the module UI.
id
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)
name
string
required
Display name for the metric(minLen:1; templateable)
type
enum
required
Chart type for the metricAllowed values: line | bar(templateable)
source
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
type
enum
required
Allowed values: cloudwatch(templateable)
aws_account_id
string
required
(minLen:1; templateable)
region
string
required
(minLen:1; templateable)
log_group
string
required
(minLen:1; templateable)
log_stream_prefix
string | null
(templateable)
filter_pattern
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_…
type
enum
required
Source type discriminatorAllowed values: cloudwatch(templateable)
aws_account_id
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)
region
string
required
AWS region the metric lives in.(minLen:1; templateable)
namespace
string
required
CloudWatch namespace(minLen:1; templateable)
name
string
required
CloudWatch metric name(minLen:1; templateable)
statistic
string
required
CloudWatch statistic to apply(minLen:1; templateable)
dimensions
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
type
enum
required
Allowed values: cloudwatch(templateable)
aws_account_id
string
required
(minLen:1; templateable)
region
string
required
(minLen:1; templateable)
log_group
string
required
(minLen:1; templateable)
log_stream_prefix
string | null
(templateable)
filter_pattern
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_…
type
enum
required
Source type discriminatorAllowed values: cloudwatch(templateable)
aws_account_id
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)
region
string
required
AWS region the metric lives in.(minLen:1; templateable)
namespace
string
required
CloudWatch namespace(minLen:1; templateable)
name
string
required
CloudWatch metric name(minLen:1; templateable)
statistic
string
required
CloudWatch statistic to apply(minLen:1; templateable)
dimensions
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.

Template expressions

Fields marked templateable accept << expression >> template tokens.
  • Block mode preserves the resolved type:
  • Interpolation mode always produces a string:
Supported operators: +, -, *, /, %, >, <, >=, <=, ==, !=, &&, ||, !.Ternary: << condition ? trueVal : falseVal >>. Default fallback: << input.x || "fallback" >>.Access: array[0], map["key"], map.key. Functions: len(), upper(), lower().Available namespaces: module.input.*, stack.id, trigger.payload.{branch,commit,ref,repository,event,tag}.Array spreads can insert an array expression into an array field: