Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(AppSync): addRdsDataSource support for DatabaseCluster #29544

Conversation

sebastien6
Copy link
Contributor

@sebastien6 sebastien6 commented Mar 19, 2024

Issue # (if applicable)

(aws-appsync): addRdsDataSource doesnt support taking a DatabaseCluster

Closes #29302

Reason for this change

AppSync CDK construct currently accept only IServerlessCluster for RDS source as cluster type. However, with Aurora V2, serverless aurora clusters such as postgres aurora v14 and above are construct using the DatabaseCluster construct and as such AppSync.addRdsDataSource() method need ability to support both type of cluster interfaces.

Description of changes

To support the change I created a second props to support IDatabaseCluster in addition to IServerlessCluster already supported and I overloaded the constructor to support both type of props.

However, to make the change possible, some modification to aws-rds were also required:

1 - Need IDatabaseCluster interface to have grantDataApiAccess() method published as part of the interface (the method was there but not published in the interface, when IServerlessCLuster interface have it published.

2 - need DatabaseCluster.grantDataApiAccess() to follow the same IAM permission pattern than ServerlessCluster.grantDataApiAccess() to have consistency.

ServerlessCluster.grantDataApiAccess() method is adding automatically the required permission to secret manager if Data API is enabled.

However, DatabaseCluster.grantDataApiAccess() do not. As such without the change it will have been required for end users to add that IAM permission to secret manager as an extra line when they will have assigned a serverless V2 cluster to AppSync datasource.

To keep the experience unified across the 2 type of RDS clusters, i updated the method to have that IAM permission embedded.

Description of how you validated changes

  • Unit test created for the new feature
  • Unit test updated and validated for RDS changes
  • Integration test created for the new feature

I run all unit test and the integration test successfully.

Checklist


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

@github-actions github-actions bot added the p2 label Mar 19, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team March 19, 2024 22:55
@github-actions github-actions bot added the beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK label Mar 19, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@sebastien6 sebastien6 changed the title feat(AppSync) addRdsDataSource support for DatabaseCluster feat(AppSync): addRdsDataSource support for DatabaseCluster Mar 19, 2024
@sebastien6 sebastien6 changed the title feat(AppSync): addRdsDataSource support for DatabaseCluster fix(AppSync): addRdsDataSource support for DatabaseCluster Mar 19, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 20, 2024 03:12

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

@sebastien6 sebastien6 changed the title fix(AppSync): addRdsDataSource support for DatabaseCluster feat(AppSync): addRdsDataSource support for DatabaseCluster Mar 20, 2024
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@aws-cdk-automation aws-cdk-automation dismissed their stale review March 20, 2024 18:38

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

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Mar 20, 2024
@github-actions github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. labels Mar 21, 2024
@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 26, 2024
Copy link
Contributor

@GavinZZ GavinZZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM, some minor comments.

edit: sorry for not noticing the blocking issues earlier

packages/aws-cdk-lib/aws-rds/lib/cluster.ts Outdated Show resolved Hide resolved
packages/aws-cdk-lib/aws-rds/test/cluster.test.ts Outdated Show resolved Hide resolved
@@ -187,7 +187,7 @@ export interface IGraphqlApi extends IResource {
*/
addRdsDataSource(
id: string,
serverlessCluster: IServerlessCluster,
serverlessCluster: IServerlessCluster | IDatabaseCluster,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would not be acceptable change. This function is a public API that customers can use. Although it's perfectly fine in typescript, CDK uses JSII to translate typescript to other languages and this specific code change will break JSII compilation unfortunately.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

made update to have 2 different method to avoid jsii conversion issues.

GavinZZ
GavinZZ previously approved these changes Apr 10, 2024
Copy link
Contributor

@GavinZZ GavinZZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for making the changes and addressing the feedback.

Copy link
Contributor

mergify bot commented Apr 10, 2024

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 aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Apr 10, 2024
Copy link
Contributor

mergify bot commented Apr 10, 2024

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 mergify bot dismissed GavinZZ’s stale review April 10, 2024 21:14

Pull request has been modified.

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

Copy link
Contributor

mergify bot commented Apr 10, 2024

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 mergify bot merged commit 1894f2d into aws:main Apr 10, 2024
11 checks passed
@sebastien6 sebastien6 deleted the sebastien6/feature-appsync-rdsdatasource-databasecluster branch April 10, 2024 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(aws-appsync): addRdsDataSource doesnt support taking a DatabaseCluster
5 participants