Skip to main content

Break Glass

Properties

PropertyDescriptionValuesExample
role
array
Roles to be used for breaking glass.Optional-

role

PropertyDescriptionValuesExample
name
string
name of the role Name used for the role in the target cloud platform. Supports Go templating using standard template variables (e.g., {{.nuon.install.id}})✅ Required"app-{{.nuon.install.id}}-role", "admin-role"
description
string
description of the role Human-readable description that explains the role’s purpose. Rendered in the installer to customers. Supports templating✅ Required"Provides S3 bucket access for the application", "Database migration role with elevated permissions"
policies
array
policy definitions for the role List of policies to attach to the role. Each policy defines cloud-specific permissions (AWS IAM policies, GCP IAM permissions, or GCP predefined roles)✅ Required-
type
string
role type in permission directory Used when defining permissions in a directory. Indicates when the role is active (provision, maintenance, or deprovision). Supports templatingOptional"provision", "maintenance", "deprovision"
cloud_platform
string
target cloud platform Cloud platform this role targets. Determines which downstream renderer processes the role (e.g., AWS CloudFormation vs GCP IAM). Defaults to aws if omittedOptional
"aws", "azure", "gcp"
"aws", "gcp"
display_name
string
display name of the role Human-readable display name shown in the installer UI. Supports templatingOptional"Application S3 Access", "Database Admin"
permissions_boundary
string
[AWS] permissions boundary policy [AWS only] Optional ARN of a permissions boundary policy. Limits the maximum permissions the role can have. Supports templating and external file sources: HTTP(S) …Optional"./provision_boundary.json", "./maintenance_boundary.json"
enabled_in_stack
boolean
whether the role is enabled by default in the install stack Controls the default value of the Enable parameter for this role in the install stack (CloudFormation parameter or Terraform variable, de…Optional-