Skip to content

Commit eb7b686

Browse files
quetzalliwritessimonrwremotesynth
authored
docs: document new CloudFormation engine and its implications (#188)
Co-authored-by: Simon Walker <[email protected]> Co-authored-by: Brian Rinaldi <[email protected]>
1 parent e449468 commit eb7b686

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

src/content/docs/aws/services/cloudformation.mdx

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,40 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
1111

1212
## Introduction
1313

14+
:::note
15+
With LocalStack version 4.8.0 (and above) we've introduced a **new CloudFormation engine** with Change Sets at its core, which would allow proper update and rollback support in the near future.
16+
17+
This includes internal changes that may affect existing stacks or deployment behavior. Most users will benefit from the new behavior automatically, but there are a few important notes to be aware of:
18+
19+
- **Persistence is not backwards-compatible:** If you use persistent state, your stacks may not load correctly between the new and old engines.
20+
- **Default behavior has changed:** If your deployment logic depends on specific legacy quirks or unsupported update behavior, you may encounter issues.
21+
- **New features and improvements:** are now available under the new engine.
22+
23+
If you encounter problems or regressions you can **revert to the legacy engine** by setting:
24+
25+
```bash
26+
PROVIDER_OVERRIDE_CLOUDFORMATION=engine-legacy
27+
```
28+
:::
29+
30+
:::note
31+
32+
## Upcoming Change in Handling Unsupported Resource Types
33+
34+
In a future LocalStack release, the behavior of the CloudFormation engine will change when stacks contain **unsupported AWS resource types**.
35+
36+
**Currently**, unsupported resources are silently ignored or mocked so that the rest of the stack can proceed.
37+
38+
**With the upcoming change**, CloudFormation will instead **fail the deployment** if the template includes unsupported resource types.
39+
40+
To keep the current behavior and prepare for this breaking change ahead, you can enable it manually:
41+
42+
```bash
43+
CFN_IGNORE_UNSUPPORTED_RESOURCE_TYPES=1
44+
```
45+
46+
:::
47+
1448
CloudFormation is a service provided by Amazon Web Services (AWS) that allows you to define and provision infrastructure as code.
1549
It enables you to create, update, and manage resources in a repeatable and automated manner using declarative templates.
1650
With CloudFormation, you can use JSON or YAML templates to define your desired infrastructure state.

0 commit comments

Comments
 (0)