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): eliminating the need for explicit secret.grantRead() invokes when using DataAPI with Aurora cluster #29399

Merged
merged 6 commits into from
Mar 14, 2024

Conversation

badmintoncryer
Copy link
Contributor

@badmintoncryer badmintoncryer commented Mar 7, 2024

Issue # (if applicable)

Closes #29362.

Reason for this change

As discussed there, we should invoke secret.grantRead() explicitly when using DataAPI with Aurora cluster.
Because it's inconvenient for users, I made secret.grantRead() be invoked within cluster.grantDataApiAccess().

Description of changes

  • move cluster.secret from DatabaseClusterNew to DatabaseClusterBase to use it within DatabaseClusterBase.grantDataApiAccess()
  • add secret.grantRead() in cluster.grantDataApiAccess()
  • add secret property to DatabaseClusterAttributes

Points of concern

DatabaseClusterBase class is extended by ImportedDatabaseCluster class. Therefore, it is necessary to define ImportedDatabaseCluster.secret.

I simply added secret props to DatabaseClusterAttributes but I cannot believe this is the best way.
Other ways are..

  • add secretArn to DatabaseClusterAttributes
  • don't add secret info and ImportedDatabaseCluster.secret becomes always undefined

Description of how you validated changes

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 effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 star-contributor [Pilot] contributed between 25-49 PRs to the CDK labels Mar 7, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team March 7, 2024 15:30
@badmintoncryer badmintoncryer changed the title feat(rds): eliminating the need for explicit secret.grantRead() invokes when using DataAPI feat(rds): eliminating the need for explicit secret.grantRead() invokes when using DataAPI with Aurora cluster Mar 7, 2024
@badmintoncryer badmintoncryer marked this pull request as ready for review March 7, 2024 16:23
@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 7, 2024
Copy link
Contributor

@lpizzinidev lpizzinidev left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@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 Mar 9, 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

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 14, 2024
Copy link
Contributor

mergify bot commented Mar 14, 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
Contributor

mergify bot commented Mar 14, 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
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: cb715a7
  • 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 bc9d0b4 into aws:main Mar 14, 2024
10 checks passed
Copy link
Contributor

mergify bot commented Mar 14, 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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 star-contributor [Pilot] contributed between 25-49 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

rds: use DataAPI for Aurora cluster without invoking secret.grantRead()
4 participants