docs: document S3-native state locking (useLockfile) for the S3 backend#17
Merged
Conversation
Document the new `useLockfile` field on the S3 backend, which enables S3-native state locking (lock file at <key>.tflock) and removes the need for a separate DynamoDB table. Covers enabling it, required S3 permissions, and migrating from `dynamodbTable`, which is now deprecated. - concepts/remote-backends: new "State Locking with the S3 Backend" section with per-language examples and a migration guide - release/s3-native-locking (new page): What's New entry - release/index: What's New link to the new page - docs.json: nav entry for the new release page Documents open-constructs/cdk-terrain#254. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VzSEXFAfYFCKLQU2CHeCRN
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
S3-native locking requires Terraform/OpenTofu 1.10+, which is newer than the default target ranges. Add callouts directing users to declare `targetVersions` in cdktf.json so synthesis validates native locking against the runtimes they target, mirroring the function-usage synth-time validation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VzSEXFAfYFCKLQU2CHeCRN
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation for the S3 backend locking feature shipping in the upcoming release (open-constructs/cdk-terrain#254 — S3-backend: add
useLockfilefield and deprecatedynamodbTable).The
S3Backendnow supports S3-native state locking via a newuseLockfilefield. Terraform/OpenTofu writes a lock file next to the state object (<key>.tflock) instead of requiring a separate DynamoDB table, and thedynamodbTablefield is now deprecated.Changes
concepts/remote-backends: new "State Locking with the S3 Backend" section — compares S3-native vs. DynamoDB locking, shows how to enableuseLockfilewith per-language examples (TypeScript, Java, Python, C#, Go), notes the requireds3:GetObject/s3:PutObject/s3:DeleteObjectpermissions, and adds a step-by-step migration guide fromdynamodbTabletouseLockfile.release/s3-native-locking(new page): What's New entry summarizing the new field, thedynamodbTabledeprecation, and the migration path.release/index: adds a "What's New" link to the new release page.docs.json: nav entry for the new release page.Notes
content/api-reference/**/s3-backend-configpages will pick upuseLockfileand the updateddynamodbTableJSDoc when the API reference is regenerated from source — they are intentionally not hand-edited (perCLAUDE.md).targetVersionswork already documented in #16. Both PRs add a## What's Newentry torelease/index.mdxand a nav line todocs.json, so a trivial merge of those two lists may be needed depending on merge order.🤖 Generated with Claude Code
Generated by Claude Code