feat(msk): support ServerlessCluster #32780

mazyu36 · 2025-01-07T15:18:51Z

Issue # (if applicable)

Closes #28709.

Reason for this change

L2 Construct for MSK Serverless is not supported.

Description of changes

Add ServerlessCluster class.

Describe any new or updated permissions being added

Nothing

Description of how you validated changes

Add unit tests and integ test.

Checklist

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

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.

codecov · 2025-01-08T03:21:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.84%. Comparing base (f004c7e) to head (c4db54e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #32780   +/-   ##
=======================================
  Coverage   80.84%   80.84%           
=======================================
  Files         236      236           
  Lines       14230    14230           
  Branches     2487     2487           
=======================================
  Hits        11504    11504           
  Misses       2442     2442           
  Partials      284      284

Flag	Coverage Δ
suite.unit	`80.84% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`79.64% <ø> (ø)`
packages/aws-cdk-lib/core	`82.14% <ø> (ø)`

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

mazyu36 · 2025-01-08T07:04:57Z

packages/@aws-cdk/aws-msk-alpha/lib/serverless-cluster.ts

+      clientAuthentication: {
+        sasl: {
+          iam: {
+            enabled: true,


This property is required and cannot be false.
I tried deploying with enabled set to false, but the deployment failed with the following error:

A serverless cluster must use SASL/IAM authentication. (Service: Kafka, Status Code: 400, Request ID...

As a result, I have decided not to expose this property.

Thank you for your information.
All the CloudFormation documents are useless, and I wish something could be done about it.

Can we add a TODO or some sort of comment here? My concern is that MSK team fix this issue and in the future if it supports IAM as disabled but something else as enabled, we know that this section of code needs to be updated.

@GavinZZ
Thank you. I have added a TODO comment.
Since MSK Serverless currently only supports IAM authentication, the inability to disable it seems to be the expected behavior.

https://docs.aws.amazon.com/msk/latest/developerguide/serverless.html

MSK Serverless requires IAM access control for all clusters. Apache Kafka access control lists (ACLs) are not supported.

If additional authentication methods are supported in the future, it may become possible to disable it.

packages/@aws-cdk/aws-msk-alpha/lib/serverless-cluster.ts

badmintoncryer

Thank you for your contribution! I've made some comments.

badmintoncryer · 2025-01-10T12:58:43Z

packages/@aws-cdk/aws-msk-alpha/lib/serverless-cluster.ts

+      clientAuthentication: {
+        sasl: {
+          iam: {
+            enabled: true,


Thank you for your information.
All the CloudFormation documents are useless, and I wish something could be done about it.

packages/@aws-cdk/aws-msk-alpha/lib/serverless-cluster.ts

Co-authored-by: Kazuho Cryer-Shinozuka <[email protected]>

Pull request has been modified.

mazyu36 · 2025-02-01T06:50:45Z

@GavinZZ
Thanks. I've fixed it.

mergify · 2025-02-03T03:49:21Z

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 · 2025-02-03T03:54:31Z

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

mazyu36 · 2025-02-03T04:37:59Z

@Mergifyio update

mergify · 2025-02-03T04:38:09Z

update

☑️ Nothing to do

#commits-behind > 0 [📌 update requirement]
-closed [📌 update requirement]
-conflict [📌 update requirement]
queue-position = -1 [📌 update requirement]

mazyu36 · 2025-02-03T06:49:22Z

@Mergifyio refresh

mergify · 2025-02-03T06:49:26Z

refresh

✅ Pull request refreshed

mazyu36 · 2025-02-03T08:40:16Z

@Mergifyio requeue

mergify · 2025-02-03T08:40:20Z

requeue

❌ Command disallowed due to command restrictions in the Mergify configuration.

sender-permission >= write

mazyu36 · 2025-02-03T12:52:44Z

@Mergifyio update

mergify · 2025-02-03T12:52:53Z

update

✅ Branch has been successfully updated

mergify · 2025-02-03T13:24:59Z

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

GavinZZ · 2025-02-03T19:27:54Z

@mergify update

mergify · 2025-02-03T19:28:04Z

update

✅ Branch has been successfully updated

mergify · 2025-02-03T20:00:16Z

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 · 2025-02-03T21:02:15Z

AWS CodeBuild CI Report

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

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

mergify · 2025-02-03T21:02: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).

github-actions · 2025-02-03T21:02:53Z

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.

aws-cdk-automation requested a review from a team January 7, 2025 15:19

github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Jan 7, 2025

aws-cdk-automation previously requested changes Jan 7, 2025

View reviewed changes

feat(msk): support ServerlessCluster

6147f11

mazyu36 force-pushed the msk-serverless branch from b5f1c88 to 6147f11 Compare January 8, 2025 03:02

mazyu36 added 2 commits January 8, 2025 14:51

README

f743a99

remove cluster name validation

c9280c6

fix

8816239

mazyu36 commented Jan 8, 2025

View reviewed changes

mazyu36 marked this pull request as ready for review January 8, 2025 07:16

Merge branch 'main' into msk-serverless

e8bf0bf

mazyu36 commented Jan 8, 2025

View reviewed changes

packages/@aws-cdk/aws-msk-alpha/lib/serverless-cluster.ts Show resolved Hide resolved

mazyu36 added 2 commits January 8, 2025 16:44

fix

d955c5b

Merge branch 'main' into msk-serverless

c4daabd

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 9, 2025

badmintoncryer suggested changes Jan 10, 2025

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 10, 2025

mazyu36 and others added 2 commits January 10, 2025 22:18

Update packages/@aws-cdk/aws-msk-alpha/lib/serverless-cluster.ts

379ac23

Co-authored-by: Kazuho Cryer-Shinozuka <[email protected]>

fix test

bde2073

badmintoncryer approved these changes Jan 10, 2025

View reviewed changes

Merge branch 'main' into msk-serverless

9c3ddcc

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 10, 2025

mazyu36 added 2 commits January 13, 2025 19:26

Merge branch 'main' into msk-serverless

a18aff3

Merge branch 'main' into msk-serverless

55a3ca1

QuantumNeuralCoder self-assigned this Jan 28, 2025

fix lint

cc8f2c8

Merge branch 'main' into msk-serverless

f72c134

mazyu36 requested a review from GavinZZ February 1, 2025 06:51

GavinZZ approved these changes Feb 3, 2025

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Feb 3, 2025

Merge branch 'main' into msk-serverless

81a1ede

Merge branch 'main' into msk-serverless

9f93036

Merge branch 'main' into msk-serverless

c4db54e

mergify bot merged commit 86ce155 into aws:main Feb 3, 2025
20 checks passed

github-actions bot locked as resolved and limited conversation to collaborators Feb 3, 2025

mazyu36 deleted the msk-serverless branch February 3, 2025 22:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(msk): support ServerlessCluster #32780

feat(msk): support ServerlessCluster #32780

mazyu36 commented Jan 7, 2025 •

edited

Loading

aws-cdk-automation left a comment

codecov bot commented Jan 8, 2025 •

edited

Loading

mazyu36 Jan 8, 2025

badmintoncryer Jan 10, 2025

GavinZZ Jan 31, 2025 •

edited

Loading

mazyu36 Jan 31, 2025

badmintoncryer left a comment

badmintoncryer Jan 10, 2025

mazyu36 commented Feb 1, 2025

mergify bot commented Feb 3, 2025

mergify bot commented Feb 3, 2025

mazyu36 commented Feb 3, 2025

mergify bot commented Feb 3, 2025

mazyu36 commented Feb 3, 2025

mergify bot commented Feb 3, 2025

mazyu36 commented Feb 3, 2025

mergify bot commented Feb 3, 2025

mazyu36 commented Feb 3, 2025

mergify bot commented Feb 3, 2025

mergify bot commented Feb 3, 2025

GavinZZ commented Feb 3, 2025

mergify bot commented Feb 3, 2025

mergify bot commented Feb 3, 2025

aws-cdk-automation commented Feb 3, 2025

mergify bot commented Feb 3, 2025

github-actions bot commented Feb 3, 2025

feat(msk): support ServerlessCluster #32780

feat(msk): support ServerlessCluster #32780

Conversation

mazyu36 commented Jan 7, 2025 • edited Loading

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

aws-cdk-automation left a comment

Choose a reason for hiding this comment

codecov bot commented Jan 8, 2025 • edited Loading

Codecov Report

mazyu36 Jan 8, 2025

Choose a reason for hiding this comment

badmintoncryer Jan 10, 2025

Choose a reason for hiding this comment

GavinZZ Jan 31, 2025 • edited Loading

Choose a reason for hiding this comment

mazyu36 Jan 31, 2025

Choose a reason for hiding this comment

badmintoncryer left a comment

Choose a reason for hiding this comment

badmintoncryer Jan 10, 2025

Choose a reason for hiding this comment

mazyu36 commented Feb 1, 2025

mergify bot commented Feb 3, 2025

mergify bot commented Feb 3, 2025

mazyu36 commented Feb 3, 2025

mergify bot commented Feb 3, 2025

☑️ Nothing to do

mazyu36 commented Feb 3, 2025

mergify bot commented Feb 3, 2025

✅ Pull request refreshed

mazyu36 commented Feb 3, 2025

mergify bot commented Feb 3, 2025

❌ Command disallowed due to command restrictions in the Mergify configuration.

mazyu36 commented Feb 3, 2025

mergify bot commented Feb 3, 2025

✅ Branch has been successfully updated

mergify bot commented Feb 3, 2025

GavinZZ commented Feb 3, 2025

mergify bot commented Feb 3, 2025

✅ Branch has been successfully updated

mergify bot commented Feb 3, 2025

aws-cdk-automation commented Feb 3, 2025

AWS CodeBuild CI Report

mergify bot commented Feb 3, 2025

github-actions bot commented Feb 3, 2025

mazyu36 commented Jan 7, 2025 •

edited

Loading

codecov bot commented Jan 8, 2025 •

edited

Loading

GavinZZ Jan 31, 2025 •

edited

Loading