aws / aws/aws-cdk

aws_cloudfront_origins: OriginGroup support custom originId

Open
#31,468 2 comments 0 reactions 0 assignees View on GitHub
@aws-cdk/aws-cloudfront-origins closed-for-staleness effort/small feature-request p3
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the feature

OriginGroup does not appear to support setting an explicit originId currently. The auto-generated ID is very long and hard to read. We would like to set the originId as with other origin types such as HttpOrigin or RestApiOrigin.

### Use Case

Create easy to read origin IDs for Origin Groups so we can more easily understand the configuration when looking at it in the CloudFront console.

### Proposed Solution

Add originId to OriginGroupProps.

I might be able to implement this; I'm not very familiar with CDK internals but it seems that wherever the auto-generated ID is created, it could instead use the explicit prop if set. I could use a little hint on where this happens.

### Other Information

_No response_

### Acknowledgements

- [X] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### CDK version used

2.158.0

### Environment details (OS name and version, etc.)

macOS

Contributor guide

Open the contributing guide

Research direction

Start by locating OriginGroupProps and the code that creates the auto-generated OriginGroup ID. Trace how other origin types accept and use an explicit originId, then identify the relevant tests for OriginGroup behavior. Done means OriginGroup supports a readable explicit originId while retaining the generated ID when no prop is supplied.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
cloud, infrastructure
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.