feat(origin_groups): added support for custom group_id

[atimofeev]

what

Added support for optional group_id in origin_groups object, which can be referenced in ordered_cache block.

why

The module code does not allow setting up custom id for origin group.
Instead, the module names groups in this format:
$name-group[$id]

This is not ideal, as when specifying target_origin_id in ordered_cache config, we have to reference it by an arbitrary group id, based on its order of appearance in config, instead of actual name and purpose.

references

closes #339

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes introduce an optional group_id attribute to the origin_groups configuration, update its usage in examples, and alter the logic in the main module to use this value as the origin_id for CloudFront origin groups if provided. The variable type definition is updated accordingly.

Changes

File(s)	Change Summary
variables.tf	Added optional group_id string attribute to origin_groups object type definition.
main.tf	Modified origin_id assignment in origin_group block to use group_id if present and non-empty.
examples/complete/main.tf README.yaml	Updated example and documentation to include group_id in origin_groups usage.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Allow optional attribute to specify custom group name (group_name) in origin_groups (#339)	✅
Use custom group name as CloudFront origin group origin_id if provided (#339)	✅
Update documentation and examples to show usage of custom group name (#339)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.

✨ Finishing touches

🧪 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

variables.tf (2)

656-656: Add validation for group_id.
The optional group_id attribute should be validated to ensure it is non-empty, matches allowed characters for CloudFront origin IDs, and is unique across all origin groups.

---

662-669: Document the new group_id attribute.
The variable description for origin_groups does not mention the new group_id option. Update the documentation to explain its purpose and how it is used in the origin_group block.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a65f7e and 4c60c05.

⛔ Files ignored due to path filters (1)

• README.md is excluded by !README.md

📒 Files selected for processing (4)

• README.yaml (1 hunks)
• examples/complete/main.tf (1 hunks)
• main.tf (1 hunks)
• variables.tf (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`examples/complete/*.tf`: This is framework for testing and standards are very relaxed, plus certain things need to be certain ways for testing. Exclude from review unless you find...

examples/complete/*.tf: This is framework for testing and standards are very relaxed, plus certain things need to be certain ways for testing. Exclude from review unless you find misspelling or similar error in comments or serious errors in code.

• examples/complete/main.tf

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Summary

🔇 Additional comments (3)

main.tf (1)

492-492: Conditional origin_id fallback is correct.
The use of try(length(origin_group.value.group_id), 0) > 0 cleanly handles missing or empty group_id values and falls back to the autogenerated naming.

README.yaml (1)

134-134: Skip: Illustration only.
The addition of group_id = "groupS3" in the README example aligns with the module enhancement and requires no further action.

examples/complete/main.tf (1)

121-121: Skip: Example demonstration.
The example usage correctly demonstrates the new group_id attribute in the origin_groups block.

[atimofeev]

Any chance of getting this merged?