Archetype Overrides

Filename patterns:

*.alz_archetype_override.json
*.alz_archetype_override.yaml
*.alz_archetype_override.yml

An archetype override is a delta of an existing archetype. it is used by callers to modify the behavior of an archetype without changing the archetype itself.

Archetype overrides are designed to be used in local libraries as the last step in customization by the caller. They should not be stored in a central library.

We publish the schema of an archetype override here and we have registered the file extensions with schemastore.org to enable automatic validation in editors.

An archetype override has a name, which must be unique amongst all archetypes and override archetypes. It also has and a set of policy definitions, policy set definitions, policy assignments, and role definitions to add and remove from the referenced base archetype. All of these associated assets are referenced by their name (JSON .name) property.

Example

Here is an example archetype definition file:

name: "landing_zones_override"
base_archetype: "landing_zones"
policy_assignments_to_add: []
policy_assignments_to_remove:
  - "Deny-IP-forwarding"
policy_definitions_to_add: []
policy_definitions_to_remove: []
policy_set_definitions_to_add: []
policy_set_definitions_to_remove: []
role_definitions_to_add: []
role_definitions_to_remove: []