feat(rds): `timeout` and `timeoutAction` properties to ServerlessCluster #28534

badmintoncryer · 2023-12-31T02:02:04Z

This pull request introduces two new properties to the ServerlessCluster class in the AWS CDK RDS package: secondsBeforeTimeout and timeoutAction.

The secondsBeforeTimeout property allows users to specify the amount of time that Aurora Serverless v1 will attempt to find a scaling point to perform seamless scaling before enforcing the timeout action. The default value is 300 seconds (5 minutes).

The timeoutAction property allows users to specify the action to take when the timeout is reached. Users can choose between ForceApplyCapacityChange, which will force the capacity to the specified value as soon as possible, even without a scaling point, and RollbackCapacityChange, which will ignore the capacity change if a scaling point is not found. The default behavior is RollbackCapacityChange.

These enhancements provide users with more control over the scaling behavior of their Aurora Serverless clusters.

Closes #27183

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

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

kaizencc

some comments mostly on naming and typos. Everything else looks good @badmintoncryer :)

packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts

kaizencc · 2024-01-02T11:31:16Z

packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts

+   *
+   * @default - 300 (5 minutes)
+   */
+  readonly secondsBeforeTimeout? : Duration;


Suggested change

readonly secondsBeforeTimeout? : Duration;

readonly secondsBeforeTimeout?: Duration;

I think that this property needs to be changed to just timeout. Since we're providing a Duration here, a user could provide minutes if they wanted to. readonly timeout?: Duration makes the most sense

packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts

packages/aws-cdk-lib/aws-rds/README.md

Pull request has been modified.

badmintoncryer · 2024-01-02T16:41:25Z

@kaizencc Thank you for your review! I have changed the variable name to 'timeout' and accordingly updated the tests and README as well.

kaizencc

Thanks @badmintoncryer. Looks good, just need to update the integ test to get the build succeeding.

Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>

badmintoncryer · 2024-01-03T13:43:01Z

@kaizencc I fixed integ test.

kaizencc

A few review comments that I will try to merge to your branch and hopefully I didnt break the build

packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts

packages/aws-cdk-lib/aws-rds/test/serverless-cluster.test.ts

kaizencc · 2024-01-03T14:50:28Z

packages/aws-cdk-lib/aws-rds/test/serverless-cluster.test.ts

+      ScalingConfiguration: {
+        AutoPause: true,
+        MaxCapacity: 32,
+        MinCapacity: 8,
+        SecondsUntilAutoPause: 600,
+        TimeoutAction: 'ForceApplyCapacityChange',
+      },


Whatever timeout maps to is missing from this assertion

packages/aws-cdk-lib/aws-rds/test/serverless-cluster.test.ts

kaizencc

If all goes well, then approved :)

mergify · 2024-01-03T15:19:22Z

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).

aws-cdk-automation · 2024-01-03T15:46:16Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 4bc9d4b
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-01-03T15:46:37Z

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).

…ter (aws#28534) This pull request introduces two new properties to the `ServerlessCluster` class in the AWS CDK RDS package: `secondsBeforeTimeout` and `timeoutAction`. The `secondsBeforeTimeout` property allows users to specify the amount of time that Aurora Serverless v1 will attempt to find a scaling point to perform seamless scaling before enforcing the timeout action. The default value is 300 seconds (5 minutes). The `timeoutAction` property allows users to specify the action to take when the timeout is reached. Users can choose between `ForceApplyCapacityChange`, which will force the capacity to the specified value as soon as possible, even without a scaling point, and `RollbackCapacityChange`, which will ignore the capacity change if a scaling point is not found. The default behavior is `RollbackCapacityChange`. These enhancements provide users with more control over the scaling behavior of their Aurora Serverless clusters. Closes aws#27183 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

aws-cdk-automation requested a review from a team December 31, 2023 02:02

github-actions bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 valued-contributor [Pilot] contributed between 6-12 PRs to the CDK labels Dec 31, 2023

aws-cdk-automation previously requested changes Dec 31, 2023

View reviewed changes

badmintoncryer force-pushed the 27183-supportForScailingConfiguration branch from 5091b1f to e39be9c Compare December 31, 2023 02:05

github-actions bot mentioned this pull request Jan 1, 2024

Monthly PR metrics report - Dec 2023 #28544

Closed

badmintoncryer force-pushed the 27183-supportForScailingConfiguration branch from 7ff08ca to a3b6616 Compare January 2, 2024 11:31

kaizencc previously requested changes Jan 2, 2024

View reviewed changes

badmintoncryer force-pushed the 27183-supportForScailingConfiguration branch from 1f2cd3b to 0dbf982 Compare January 2, 2024 16:11

badmintoncryer changed the title ~~feat(rds): Add secondsBeforeTimeout and timeoutAction properties to ServerlessCluster~~ feat(rds): Add timeout and timeoutAction properties to ServerlessCluster Jan 2, 2024

kaizencc reviewed Jan 2, 2024

View reviewed changes

kaizencc changed the title ~~feat(rds): Add timeout and timeoutAction properties to ServerlessCluster~~ feat(rds): timeout and timeoutAction properties to ServerlessCluster Jan 2, 2024

badmintoncryer and others added 13 commits January 3, 2024 13:35

feat: supportForScailingProperties

0760ab1

test: integ test

71ec328

docs: update README

5588fbe

fix: unit test

c8a7f5b

test: integ test

6f7c382

refactor: unit test

ec6672b

test: integ test

a5a98c8

Update packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts

b9c45e1

Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>

Update packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts

28b5c2d

Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>

Update packages/aws-cdk-lib/aws-rds/README.md

8b48450

Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>

Update packages/aws-cdk-lib/aws-rds/lib/serverless-cluster.ts

d31b8b2

Co-authored-by: Kaizen Conroy <36202692+kaizencc@users.noreply.github.com>

feat: rename timeout

350ccd5

test: integ test

62e1083

docs: README

e1234da

badmintoncryer force-pushed the 27183-supportForScailingConfiguration branch from 9034014 to e1234da Compare January 3, 2024 04:35

refactor: integ test

b5cd408

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Jan 3, 2024

kaizencc reviewed Jan 3, 2024

View reviewed changes

kaizencc added 2 commits January 3, 2024 15:52

Merge branch 'main' into 27183-supportForScailingConfiguration

9ff9c7d

Apply suggestions from code review

e2eadaf

kaizencc approved these changes Jan 3, 2024

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 Jan 3, 2024

Merge branch 'main' into 27183-supportForScailingConfiguration

4bc9d4b

mergify bot merged commit 508825b into aws:main Jan 3, 2024
9 checks passed

badmintoncryer deleted the 27183-supportForScailingConfiguration branch January 4, 2024 06:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(rds): `timeout` and `timeoutAction` properties to ServerlessCluster #28534

feat(rds): `timeout` and `timeoutAction` properties to ServerlessCluster #28534

badmintoncryer commented Dec 31, 2023

aws-cdk-automation left a comment

kaizencc left a comment

kaizencc Jan 2, 2024

kaizencc Jan 2, 2024

badmintoncryer commented Jan 2, 2024 •

edited

Loading

kaizencc left a comment

badmintoncryer commented Jan 3, 2024

kaizencc left a comment

kaizencc Jan 3, 2024

kaizencc left a comment

mergify bot commented Jan 3, 2024

aws-cdk-automation commented Jan 3, 2024

mergify bot commented Jan 3, 2024

	readonly secondsBeforeTimeout? : Duration;
	readonly secondsBeforeTimeout?: Duration;

feat(rds): timeout and timeoutAction properties to ServerlessCluster #28534

feat(rds): timeout and timeoutAction properties to ServerlessCluster #28534

Conversation

badmintoncryer commented Dec 31, 2023

aws-cdk-automation left a comment

Choose a reason for hiding this comment

kaizencc left a comment

Choose a reason for hiding this comment

kaizencc Jan 2, 2024

Choose a reason for hiding this comment

kaizencc Jan 2, 2024

Choose a reason for hiding this comment

badmintoncryer commented Jan 2, 2024 • edited Loading

kaizencc left a comment

Choose a reason for hiding this comment

badmintoncryer commented Jan 3, 2024

kaizencc left a comment

Choose a reason for hiding this comment

kaizencc Jan 3, 2024

Choose a reason for hiding this comment

kaizencc left a comment

Choose a reason for hiding this comment

mergify bot commented Jan 3, 2024

aws-cdk-automation commented Jan 3, 2024

AWS CodeBuild CI Report

mergify bot commented Jan 3, 2024

feat(rds): `timeout` and `timeoutAction` properties to ServerlessCluster #28534

feat(rds): `timeout` and `timeoutAction` properties to ServerlessCluster #28534

badmintoncryer commented Jan 2, 2024 •

edited

Loading