Install

Properties

Property	Description	Values	Example
`name` string	name of the install Unique identifier for this install configuration	✅ Required	`"production"`, `"staging"`, `"customer-acme"`
`app_branch` string	app branch name or ID App branch this install belongs to, by name or ID. Changing it moves the install and applies the branch’s latest run.	✅ Required	`"main"`
`app_branch_group` string	app branch deployment group Deployment group this install belongs to within its app branch. This explicit selection takes precedence over label matching.	Optional	`"canary"`
`approval_option` string	approval option for the install Controls how deployments are approved. Options: ‘approve-all’ (automatic approval) or ‘prompt’ (requires confirmation)	Optional	`"approve-all"`, `"prompt"`
`telemetry` InstallTelemetry	Install telemetry settings	Optional	-
`labels` object	key/value labels for the install Tag installs with arbitrary metadata like environment, region, or version. Values can use the .nuon templating syntax to render from install state, and re-render as…	Optional	`{"env":"production","region":"{{ .nuon.cloud_account.aws.region }}"}`
`aws_account` AWSAccount	AWS account configuration AWS-specific settings for this install, including region and other account details	Optional	-
`gcp_account` GCPAccount	GCP account configuration GCP-specific settings for this install, including project ID and region	Optional	-
`azure_account` AzureAccount	Azure account configuration Azure-specific settings for this install, including the deployment location	Optional	-
`cloud_connection` string	cloud connection name or ID AWS cloud connection this install uses for provisioning, by name or ID. The connection must exist in the organization and be verified. When omitted, the install falls ba…	Optional	`"demo-aws"`
`inputs` array	input values Array of input groups with key-value pairs for customer inputs provided during installation	Optional	-
`stack_overrides` InstallStackOverrides	Stack template overrides Per-install overrides for the app-level stack template configuration. For cloud-connected installs, Git config creation provisions the managed stack; changes reprovision it…	Optional	-
`cloudformation` CloudFormation	Per-install CloudFormation configuration Root and nested stack parameters supported by Git-backed install config sync only, not nuon installs sync. Requires an AWS cloud_connection. Values merge ov…	Optional	-
`component_toggles` object	-	Optional	-
`components` object	-	Optional	-

`telemetry`

Property	Description	Values	Example
`enabled` boolean	Enable telemetry Enable or disable telemetry for this install. Omit to preserve the current setting; new installs inherit the organization default.	Optional	-

`aws_account`

Property	Description	Values	Example
`region` string	AWS region AWS region where the infrastructure will be deployed	✅ Required	`"us-east-1"`, `"us-west-2"`, `"eu-west-1"`
`account_id` string	AWS account ID AWS account this install targets. Required when phone home authentication is enabled for the organization. Immutable once the install exists.	Optional	`"123456789012"`

`gcp_account`

Property	Description	Values	Example
`project_id` string	GCP project ID GCP project where the infrastructure will be deployed	Optional	`"my-gcp-project"`
`region` string	GCP region GCP region where the infrastructure will be deployed	Optional	`"us-central1"`, `"europe-west1"`

`azure_account`

Property	Description	Values	Example
`location` string	Azure location Azure location/region where the infrastructure will be deployed	✅ Required	`"eastus"`, `"westus2"`, `"westeurope"`
`subscription_id` string	Azure subscription ID Azure subscription this install targets. Required when phone home authentication is enabled for the organization. Immutable once the install exists.	Optional	`"00000000-0000-0000-0000-000000000000"`

`stack_overrides`

Property	Description	Values	Example
`vpc_nested_template_url` string	VPC nested template URL override Per-install override for the VPC nested CloudFormation template URL. Overrides the app-level default from stack.toml.	Optional	`"https://nuon-artifacts.s3.us-west-2.amazonaws.com/templates/custom-vpc.yaml"`
`runner_nested_template_url` string	Runner nested template URL override Per-install override for the runner nested CloudFormation template URL. Overrides the app-level default from stack.toml.	Optional	`"https://nuon-artifacts.s3.us-west-2.amazonaws.com/templates/custom-runner.yaml"`
`ui_definition` string	Azure createUiDefinition override Per-install override for the Azure createUiDefinition path. Only supported when the app stack type is azure-bicep.	Optional	`"./arm/ui.json"`
`custom_nested_stacks` object	Custom nested stack overrides Per-install overrides for custom install stacks. Entries with the same name as app-level stacks replace them; new names are appended. Supports AWS CloudFormation, Azur…	Optional	-
`runner_image_auto_update` boolean	Runner image auto-update override Per-install override for runner.toml image_auto_update. Set true to resolve the latest runner image at every launch for this install only, or false to turn it off …	Optional	`"true"`
`runner_image_id` string	Runner image pin override Per-install override for runner.toml image_id. Pins this install’s runner host to a specific image (an AMI ID for aws), overriding auto-update. Only applies to aws runners…	Optional	`"ami-0abcdef1234567890"`

`cloudformation`

Property	Description	Values	Example
`root` CloudFormationStack	Root CloudFormation stack Parameters passed on root stack creation and update, not embedded as template defaults. Omit parameters to preserve saved overrides; an empty parameters table clears them.	Optional	-
`nested_stacks` object	Nested CloudFormation parameters Stack configurations keyed by custom stack name, or VPC / RunnerAutoScalingGroup for built-in stacks. Override individual parameters without repeating template URLs…	Optional	-