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(rds): enable grantDataApiAccess method for imported database cluster #31280

Merged
merged 7 commits into from
Oct 3, 2024

Conversation

go-to-k
Copy link
Contributor

@go-to-k go-to-k commented Sep 1, 2024

Issue # (if applicable)

Closes #31116 .

Reason for this change

It was not possible to call the grantDataApiAccess method for an imported database cluster.

Because the imported database cluster always has the enableDataApi with false.

https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-rds/lib/cluster.ts#L983

class ImportedDatabaseCluster extends DatabaseClusterBase implements IDatabaseCluster {
  // ...
  protected readonly enableDataApi = false;

But the grantDataApiAccess throws an error when the enableDataApi is set to false.

https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-rds/lib/cluster.ts#L523-L526

  public grantDataApiAccess(grantee: iam.IGrantable): iam.Grant {
    if (this.enableDataApi === false) {
      throw new Error('Cannot grant Data API access when the Data API is disabled');
    }
    // ...
}

Description of changes

Added the property dataApiEnabled to attributes for the imported database cluster.

If the dataApiEnabled to the attributes is set to true, the enableDataApi in the imported cluster will be set to true and the grantDataApiAccess can be called.

Description of how you validated changes

Unit and integ tests.

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 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK label Sep 1, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team September 1, 2024 17:55
@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p2 labels Sep 1, 2024
@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 Sep 1, 2024
Copy link
Contributor

@badmintoncryer badmintoncryer left a comment

Choose a reason for hiding this comment

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

Thank you for the PR! I've added only a nit comment.

I hardcoded enableDataApi as false for the imported cluster, so I really appreciate the fix!

Co-authored-by: Kazuho Cryer-Shinozuka <malaysia.cryer@gmail.com>
@go-to-k
Copy link
Contributor Author

go-to-k commented Sep 23, 2024

Thanks, changed!

@aws-cdk-automation aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Sep 23, 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 the quick response to my question.

Copy link
Contributor

mergify bot commented Oct 3, 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 Oct 3, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit 3c92012 into aws:main Oct 3, 2024
9 checks passed
Copy link
Contributor

mergify bot commented Oct 3, 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).

Copy link

github-actions bot commented Oct 3, 2024

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 3, 2024
@go-to-k go-to-k deleted the import-aurora-cluster-data-api branch October 4, 2024 12:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue is a bug. distinguished-contributor [Pilot] contributed 50+ PRs to the CDK effort/medium Medium work item – several days of effort p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

aws-rds: Imported Database Cluster cannot grant data API access
4 participants