Skip to main content

Break Glass

Properties

PropertyTypeRequiredDescriptionDefaultExample
typestringNorole type in permission directory Used when defining permissions in a directory. Indicates when the role is active (provision, maintenance, or deprovision). Supports templating-"provision"
namestring✅ Yesname of the IAM role Name used for the role in AWS. Supports Go templating using standard template variables (e.g., {{.nuon.install.id}})-"app-{{.nuon.install.id}}-role"
descriptionstring✅ Yesdescription of the role Human-readable description that explains the role’s purpose. Rendered in the installer to customers. Supports templating-"Provides S3 bucket access for the application"
display_namestringNodisplay name of the role Human-readable display name shown in the installer UI. Supports templating-"Application S3 Access"
policiesarray✅ Yespolicy definitions for the role List of IAM policies to attach to the role. Each policy defines specific AWS permissions--
permissions_boundarystringNopermissions boundary policy Optional ARN of a permissions boundary policy. Limits the maximum permissions the role can have. Supports templating and external file sources: HTTP(S) URLs (https://exa--

Property Details

type

Examples:
"provision"
"maintenance"
"deprovision"

name

Examples:
"app-{{.nuon.install.id}}-role"
"admin-role"

description

Examples:
"Provides S3 bucket access for the application"
"Database migration role with elevated permissions"

display_name

Examples:
"Application S3 Access"
"Database Admin"