aws / aws/aws-cdk

aws-cdk-lib/aws-rds: instanceUpdateBehaviour uses British English spelling

Open
#32,023 1 comment 1 reaction 0 assignees View on GitHub
@aws-cdk/aws-rds bug effort/medium p3
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the bug

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_rds.InstanceUpdateBehaviour.html

Much as it pains me to report it, this is inconsistent with other spelling in the CDK that use US English spelling, such as:

- https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.Color.html
- https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.SizeRoundingBehavior.html

### Regression Issue

- [ ] Select this option if this issue appears to be a regression.

### Last Known Working CDK Version

_No response_

### Expected Behavior

Consistent US English spelling.

### Current Behavior

Some British English spelling.

### Reproduction Steps

n/a

### Possible Solution

Fix the naming, possibly with a shim to allow backwards compatibility. Maybe something in the tooling could be taught to check for this as I imagine its very easy for things like this to sneak in and a pain to rectify afterwards.

### Additional Information/Context

_No response_

### CDK CLI Version

2.165.0

### Framework Version

_No response_

### Node.js Version

18

### OS

Linux

### Language

TypeScript

### Language Version

_No response_

### Other information

_No response_

Contributor guide

Open the contributing guide

Research direction

Start with the InstanceUpdateBehaviour API documentation linked in the issue and trace it to the corresponding AWS CDK source or generated declaration. Determine the US-English name and the compatibility implications, then verify that the public API and its documentation use consistent spelling.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
infrastructure
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.