Skip to content

Conversation

@kyledecot
Copy link

@kyledecot kyledecot commented Jan 14, 2026

what

Fixes minor error w/ docs so that role_arn is properly nested under assume_role.

why

Docs incorrectly had role_arn at the top-level of s3 backend configuration.

references

https://developer.hashicorp.com/terraform/language/backend/s3

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated Terraform S3 backend configuration examples to reflect the new nested assume_role structure for specifying IAM role access.

✏️ Tip: You can customize this high-level summary in your review settings.

@kyledecot kyledecot requested a review from a team as a code owner January 14, 2026 04:52
@github-actions github-actions bot added the size/xs Extra small size PR label Jan 14, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 14, 2026

📝 Walkthrough

Walkthrough

Documentation update to Terraform S3 backend configuration examples. The role_arn parameter is relocated from the top level of the backend.s3 block into a nested assume_role object containing role_arn, applied across two YAML configuration samples.

Changes

Cohort / File(s) Summary
Terraform Backend Documentation
website/docs/components/terraform/remote-state.mdx
Updated S3 backend IAM role configuration in two examples: moved role_arn from backend.s3.role_arn to backend.s3.assume_role.role_arn

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

no-release

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: correcting documentation to nest role_arn under assume_role in the S3 backend configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/xs Extra small size PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants