feature: bring the cdk-preflight rule pack (~3,000 deploy-verified constraints) into the engine

Aperta
#473 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Attiva
Stack tecnologico
aws, rust
Ambito
backend, devtools

Direzione di ricerca

Read the approaches in #452, #467, and #468, along with CUSTOM_RULES.md and the cdk-preflight rules list in docs/rules.md. The issue asks maintainers to decide on review pace, rule grouping and IDs, implementation shape, packaging, evidence, and where to start; no code change is defined as done yet.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Feature summary
I maintain cdk-preflight, a Rego rule pack for CloudFormation
constraints that resource schemas do not express. It runs on this engine through the built-in validator in
aws-cdk-lib. Now that #468 has been merged, I would like to move as much of the pack as possible into this
repository, so that every interface gets these checks, not only CDK users. Before I open more PRs, I would like to
agree with you on how to do it at this scale.

Problem or use case
The constraints in the pack live only in service documentation, in service API validation, or across several
properties. Templates that violate them pass this engine and CloudFormation pre-deployment validation, and then fail
during deployment and roll the stack back. E9014 (#467) is one example: five pack rules about EventPattern became one
engine rule.

What the pack contains (as of 2026-10-21; full list: docs/rules.md)

  • 3,034 rules that this engine does not cover yet, over 76 services and 383 resource types.
  • Every one of them was reproduced against a real account. Each rule has a failing and a passing template, and its
    metadata records the date, the Region and the exact error, for example (shortened):
    bench 2026-09-24 us-east-1: Replicas [{Location: us-east-1}] in a stack deploying to us-east-1 -> "Invalid request provided: Replica location us-east-1 cannot be the same as primary location us-east-1." (ROLLBACK_COMPLETE); pass no Replicas -> CREATE_COMPLETE
  • The rules read only the template (Resources, Outputs, Parameters). None of them depends on CDK metadata or on
    account state.

Questions

  1. Pace. Is a stream of PRs like #468 welcome, and how much can you review? For example, one PR per service or per
    resource type, and how many per week.
  2. Grouping and IDs. #468 grouped the checks for one property under one ID, as E3027 does. If I group the rest the
    same way, the number of new IDs is somewhere between one per resource type (about 380) and one per property (more).
    Engine-assigned rules use the 9xxx range. Is that range meant to hold hundreds of new IDs, and which grouping do you
    prefer?
  3. Implementation shape. #452 and #468 put the logic in template-model and call it from both engines (directly
    from CEL, through a builtin from Rego). Should simple single-property checks follow the same shape, or be written as
    a native CEL rule plus a hand-written Rego policy?
  4. Built-in or optional. Would you rather have some of these as built-in rules and the rest as an optional rule
    set that ships with the engine (for example as custom Rego, as described in CUSTOM_RULES.md)?
  5. Evidence. Is the evidence format of #467 enough for each group, or would you like it in another form?
  6. Where to start. My suggestion is AWS::Pipes::Pipe and Lambda event source mapping FilterCriteria, which use
    the same grammar as EventPattern and can reuse the E9014 code (left as a follow-up in #467). If another service
    matters more to you, I can start there instead.

Relevant interfaces: Not interface-specific

Does this change validation behavior? Yes, once each PR lands. This issue itself is about the process.

Additional context
The pack keeps shipping on its own, so nothing on the CDK side waits on this. When a group lands here, the pack stops
evaluating those rules on engines that include it, and deletes them once every supported aws-cdk-lib bundles such an
engine. Taking rules into this repository therefore never leaves the two sets reporting the same finding twice.

Lingua principale
Rust
Stelle
11
Fork
6
Merge medio
6h 28m
PR unite (30g)
43

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aws-cloudformation/cloudformation-validate

Tutte le issue di aws-cloudformation/cloudformation-validate

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.