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): rename 'kmsKey' properties to 'encryptionKey' #8324

Merged
merged 1 commit into from
Jun 5, 2020

Conversation

skinny85
Copy link
Contributor

@skinny85 skinny85 commented Jun 2, 2020

The conventional CDK name for properties that hold KMS Keys is 'encryptionKey',
not 'kmsKey' (we don't use the service name as part of the class or property name).

BREAKING CHANGE: DatabaseClusterProps.kmsKey has been renamed to storageEncryptionKey

  • rds: DatabaseInstanceNewProps.performanceInsightKmsKey has been renamed to performanceInsightEncryptionKey
  • rds: DatabaseInstanceSourceProps.secretKmsKey has been renamed to masterUserPasswordEncryptionKey
  • rds: DatabaseInstanceProps.kmsKey has been renamed to storageEncryptionKey
  • rds: DatabaseInstanceReadReplicaProps.kmsKey has been renamed to storageEncryptionKey
  • rds: Login.kmsKey has been renamed to encryptionKey

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

@skinny85 skinny85 requested a review from nija-at June 2, 2020 18:12
@skinny85 skinny85 self-assigned this Jun 2, 2020
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jun 2, 2020
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: ce7e9b7
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

Copy link
Contributor

@shivlaks shivlaks left a comment

Choose a reason for hiding this comment

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

seems like a sensible breaking change to become consistent with a straightforward migration path.

does the README have any examples that need updating? might need to add a linter exemption if it doesn't or add an example to the README

@nija-at nija-at added the pr/do-not-merge This PR should not be merged at this time. label Jun 3, 2020
Copy link
Contributor

@nija-at nija-at left a comment

Choose a reason for hiding this comment

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

As @shivlaks mentioned, check the README.

packages/@aws-cdk/aws-rds/lib/instance.ts Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-rds/lib/instance.ts Outdated Show resolved Hide resolved
packages/@aws-cdk/aws-rds/lib/cluster.ts Outdated Show resolved Hide resolved
@skinny85 skinny85 added pr-linter/exempt-readme The PR linter will not require README changes and removed pr/do-not-merge This PR should not be merged at this time. labels Jun 4, 2020
The conventional CDK name for properties that hold KMS Keys is 'encryptionKey',
not 'kmsKey' (we don't use the service name as part of the class or property name).

BREAKING CHANGE: DatabaseClusterProps.kmsKey has been renamed to storageEncryptionKey
* **rds**: DatabaseInstanceNewProps.performanceInsightKmsKey has been renamed to performanceInsightEncryptionKey
* **rds**: DatabaseInstanceSourceProps.secretKmsKey has been renamed to masterUserPasswordEncryptionKey
* **rds**: DatabaseInstanceProps.kmsKey has been renamed to storageEncryptionKey
* **rds**: DatabaseInstanceReadReplicaProps.kmsKey has been renamed to storageEncryptionKey
* **rds**: Login.kmsKey has been renamed to encryptionKey
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-qxepHUsryhcu
  • Commit ID: 6d15eaf
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify
Copy link
Contributor

mergify bot commented Jun 5, 2020

Thank you for contributing! Your pull request will be updated from master 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 4eefbbe into aws:master Jun 5, 2020
@skinny85 skinny85 deleted the fix/rds-kms-key branch June 5, 2020 18:21
@skinny85 skinny85 added this to the RDS to 'developer preview' milestone Jul 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. pr-linter/exempt-readme The PR linter will not require README changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants