Skip to main content
EXAMPLE

Scaffolds

Concrete, ready-to-run scaffold templates — the same catalog atmos init pulls from.

DX
cloudposse / atmos

Try it out

Copy the example into a new directory and make it your own:

atmos init examples/scaffolds
cd scaffolds

Follow the README for prerequisites and next steps.

See it in action

RECORDED DEMO
scaffolds
 
Recorded from this example
Real commands. Real output.
README.md2.9 KB
View on GitHub

Example: Scaffolds

Concrete, ready-to-run scaffold templates, organized by cloud. These are the same templates atmos init's catalog pulls from (aws/app, aws/landing-zone, gcp/landing-zone, azure/landing-zone) — this directory is their source of truth.

Learn more in the Init Command Documentation and the Scaffold Command Documentation.

What You'll See

  • A real, emulator-provable landing zone generated from a local template directory with atmos scaffold generate
  • How the generated project's !terraform.state dependency (kms first, then everything that reads its key) drives apply order

Try It

cd examples/scaffolds

# See the templates this directory provides
atmos scaffold generate ./aws/landing-zone ./my-landing-zone --set project_name=my-landing-zone --dry-run

# Or generate for real
atmos scaffold generate ./aws/landing-zone ./my-landing-zone --set project_name=my-landing-zone
atmos --chdir=./my-landing-zone emulator up aws -s dev
atmos --chdir=./my-landing-zone terraform apply kms -s dev -auto-approve
atmos --chdir=./my-landing-zone terraform apply audit-trail -s dev -auto-approve
atmos --chdir=./my-landing-zone terraform apply baseline -s dev -auto-approve
atmos --chdir=./my-landing-zone terraform apply monitoring -s dev -auto-approve
atmos --chdir=./my-landing-zone terraform apply iam-baseline -s dev -auto-approve
atmos --chdir=./my-landing-zone terraform output monitoring -s dev
atmos --chdir=./my-landing-zone emulator down aws -s dev

The same templates are also reachable by name through the catalog once published (atmos init aws/landing-zone ./my-landing-zone or atmos scaffold generate aws/landing-zone ./my-landing-zone).

Templates

DirectoryPurpose
aws/appApplication SDLC repository for AWS
aws/landing-zoneAWS landing zone environments (audit trail, KMS, SSM, monitoring, IAM)
gcp/landing-zoneGCP landing zone environments (GCS, Secret Manager, service accounts)
azure/landing-zoneAzure landing zone environments (resource group, VNet, subnet, NSG)

Creating Custom Templates

For a minimal walkthrough of scaffold-template mechanics (prompts, Go templating, atmos.yaml-registered templates), see examples/scaffolding instead — these templates are meant to be used, not edited as a tutorial.