feat: bitrate utility function by jamiepmullan · Pull Request #37244 · aws/aws-cdk

jamiepmullan · 2026-03-13T13:11:21Z

Issue # (if applicable)

Closes #.

Reason for this change

Description of changes

Introduction of a Bitrate utility function (similar to Duration) which can be used in AWS Elemental Media Services.
Example of usage:
video_bitrate in https://docs.aws.amazon.com/mediapackage/latest/ug/manifest-filtering.html
maxBitrate in https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_mediaconnect.CfnFlow.SourceProperty.html

Describe any new or updated permissions being added

Description of how you validated changes

Added tests

Checklist

[ X ] My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

aws-cdk-automation

(This review is outdated)

jamiepmullan · 2026-03-13T13:26:06Z

Exemption Request - I don't believe there are integration tests for core lib (following existing style for Duration in the lib)

alvazjor · 2026-03-13T14:05:36Z

+  }
+
+  private constructor(private readonly bps: number) {
+    if (bps < 0) {


This validation will throw on CDK tokens (CloudFormation parameters, Fn.ref, etc.) because token-encoded numbers use special representations like -1.8881545897087626e+289 that incorrectly trigger the negative check.

Both Duration and Size guard their constructor validation with Token.isUnresolved(). This needs the same treatment:

private constructor(private readonly bps: number) { if (!Token.isUnresolved(bps) && bps < 0) { throw new UnscopedValidationError(`Bitrate amounts cannot be negative. Received: ${bps}`); } }

Also note the suggested code already includes the value the customer send, so its clearer, please preserve that.

alvazjor · 2026-03-13T14:06:49Z

+ * This class provides a type-safe way to specify bitrates with clear units,
+ * preventing confusion between bits per second, kilobits per second, etc.
+ */
+export class Bitrate {


Please add an isUnresolved() method (both Duration and Size have one) so consumers can check if the value they are working with is a token and if it is unresolved

alvazjor · 2026-03-13T14:10:09Z

+ *
+ * This class provides a type-safe way to specify bitrates with clear units,
+ * preventing confusion between bits per second, kilobits per second, etc.
+ */


The class docstring doesn't mention token behavior. Both Duration and Size document this explicitly since it affects how the class can be used

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

alvazjor · 2026-03-13T14:14:10Z

+
+An instance of `Bitrate` is initialized through one of its static factory methods:
+
+```ts


Rosetta is complaining about this examples missing the correct referece. Please also review that

Pull request has been modified.

alvazjor

In general, all the new additions (token validation, conversion checks, etc) need to have unit tests. Since this is not a construct per se, we cannot do integ test yet, but then we should make sure unit test provide the highest coverage possible. That needs to be changed too, since we are missing test scenarios

alvazjor · 2026-03-16T10:57:19Z

+
+  private constructor(private readonly bps: number) {
+    if (!Token.isUnresolved(bps) && bps < 0) {
+      throw new UnscopedValidationError('Bitrate cannot be negative');


Please add here in the error message the the value they are sending, so the customers understand what is wrong

alvazjor · 2026-03-16T10:58:14Z

+    return this.bps;
+  }
+
+  /**


The conversion methods (this and all the ones below) perform arithmetic on the stored value without checking for tokens. When the underlying value is a token, this produces corrupted results that silently generate invalid CloudFormation templates.

This comment was not addressed. Validations are required before trying do the conversion

thanks! I've fixed this one properly now

mergify · 2026-03-17T14:13:05Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2026-03-17T14:13:41Z

mergify · 2026-03-17T14:17:38Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2026-03-17T14:54:53Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

github-actions · 2026-03-17T14:55:27Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

bitrate utility function

4111281

jamiepmullan requested a review from a team as a code owner March 13, 2026 13:11

jamiepmullan temporarily deployed to automation March 13, 2026 13:11 — with GitHub Actions Inactive

github-actions Bot added beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK p2 labels Mar 13, 2026

aws-cdk-automation requested a review from a team March 13, 2026 13:11

jamiepmullan temporarily deployed to automation March 13, 2026 13:11 — with GitHub Actions Inactive

aws-cdk-automation previously requested changes Mar 13, 2026

View reviewed changes

jamiepmullan changed the title ~~bitrate utility function~~ feat: bitrate utility function Mar 13, 2026

jamiepmullan temporarily deployed to automation March 13, 2026 13:14 — with GitHub Actions Inactive

update README

32fd2a3

jamiepmullan temporarily deployed to automation March 13, 2026 13:18 — with GitHub Actions Inactive

aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Mar 13, 2026

aws-cdk-automation temporarily deployed to automation March 13, 2026 13:26 — with GitHub Actions Inactive

alvazjor previously requested changes Mar 13, 2026

View reviewed changes

alvazjor self-assigned this Mar 13, 2026

alvazjor added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Mar 13, 2026

alvazjor temporarily deployed to automation March 13, 2026 14:12 — with GitHub Actions Inactive

alvazjor reviewed Mar 13, 2026

View reviewed changes

pahud mentioned this pull request Mar 13, 2026

Failed CodeBuild CI - 15 PR(s) pahud/aws-cdk#17

Open

fixes

d394bbf

jamiepmullan temporarily deployed to automation March 13, 2026 15:14 — with GitHub Actions Inactive

aws-cdk-automation temporarily deployed to automation March 13, 2026 15:59 — with GitHub Actions Inactive

jamiepmullan requested a review from alvazjor March 16, 2026 08:19

Merge branch 'main' into feat/common-bitrate-helper

9b2a0b2

jamiepmullan temporarily deployed to automation March 16, 2026 08:19 — with GitHub Actions Inactive

alvazjor reviewed Mar 16, 2026

View reviewed changes

review comment fixes

e687bda

jamiepmullan temporarily deployed to automation March 17, 2026 10:33 — with GitHub Actions Inactive

Merge branch 'main' into feat/common-bitrate-helper

9b2e621

jamiepmullan temporarily deployed to automation March 17, 2026 10:42 — with GitHub Actions Inactive

fix UnscopedValidationError

76f4b94

jamiepmullan temporarily deployed to automation March 17, 2026 10:53 — with GitHub Actions Inactive

jamiepmullan temporarily deployed to automation March 17, 2026 10:54 — with GitHub Actions Inactive

jamiepmullan requested a review from alvazjor March 17, 2026 11:22

alvazjor approved these changes Mar 17, 2026

View reviewed changes

aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Mar 17, 2026

aws-cdk-automation temporarily deployed to automation March 17, 2026 14:15 — with GitHub Actions Inactive

Merge branch 'main' into feat/common-bitrate-helper

a26d081

mergify Bot temporarily deployed to automation March 17, 2026 14:24 Inactive

mergify Bot merged commit 2a21279 into aws:main Mar 17, 2026
18 of 19 checks passed

github-actions Bot locked as resolved and limited conversation to collaborators Mar 17, 2026


		An instance of `Bitrate` is initialized through one of its static factory methods:

		```ts

Conversation

jamiepmullan commented Mar 13, 2026

Issue # (if applicable)

Reason for this change

Description of changes

Describe any new or updated permissions being added

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jamiepmullan commented Mar 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alvazjor left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mergify Bot commented Mar 17, 2026

Uh oh!

mergify Bot commented Mar 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge Queue Status

Uh oh!

mergify Bot commented Mar 17, 2026

Uh oh!

mergify Bot commented Mar 17, 2026

Uh oh!

Uh oh!

github-actions Bot commented Mar 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aws-cdk-automation left a comment •

edited

Loading

mergify Bot commented Mar 17, 2026 •

edited

Loading