@aws-cdk/rds: Cluster requires VPC, doc says otherwise
Open
@aws-cdk/aws-rds
bug
investigating
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 71
Description
### Describe the issue
The documentation says that the vpc prop for a Cluster is optional, but there's a check in code that throws an error if it isn't set.
### Links
https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_rds-readme.html#default-vpc
https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-rds/lib/cluster.ts#L795
Contributor guide
Research direction
Compare the default VPC documentation at the linked AWS CDK RDS README section with the check in packages/aws-cdk-lib/aws-rds/lib/cluster.ts around line 795. Start by tracing the Cluster vpc requirement and any related tests. Done means the documentation and implementation consistently describe whether vpc is optional.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, typescript
- Domain
- cloud, databases, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100