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

chore(rds): undeprecated APIs whose migration will cause interruption #17683

Merged
merged 2 commits into from
Nov 24, 2021

Conversation

nija-at
Copy link
Contributor

@nija-at nija-at commented Nov 24, 2021

All deprecated APIs will be removed from CDKv2.

Migrating from SnapshotCredentials.fromGeneratedPassword() to
its documented alternative will modify the RDS
instance in ways that may impact usability of the resource. This API
must not be deprecated.

The alternative APIs to the DatabaseInstanceEngine APIs refereced in
this PR will cause the CFN EngineVersion to be modified.
Modification of this property causes some interruption to the
resource.
This may cause "some interruption" to users' running applications.


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

@nija-at nija-at requested review from njlynch and a team November 24, 2021 10:41
@nija-at nija-at self-assigned this Nov 24, 2021
@gitpod-io
Copy link

gitpod-io bot commented Nov 24, 2021

@github-actions github-actions bot added the @aws-cdk/aws-rds Related to Amazon Relational Database label Nov 24, 2021
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Nov 24, 2021
All deprecated APIs will be removed from CDKv2.

The `SnapshotCredentials.fromGeneratedPassword()` will modify the RDS
instance in ways that may impact usability of the resource. This API
must not be deprecated.

The alternative APIs to the `DatabaseInstanceEngine` APIs refereced in
this PR will cause the [CFN EngineVersion][1] to be modified.
Modification of this property causes [some interruption][2] to the
resource.
This may cause "some interruption" to users' running applications.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt
@nija-at nija-at changed the title chore(rds): undeprecated SnapshotCredentials.fromGeneratedPassword() chore(rds): undeprecated APIs whose migration will cause interruption Nov 24, 2021
Copy link
Contributor

@njlynch njlynch left a comment

Choose a reason for hiding this comment

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

What do you think about only removing them from the deprecated APIs lists, but keeping them deprecated? This means they remain deprecated, but won't be removed in V2.

@mergify
Copy link
Contributor

mergify bot commented Nov 24, 2021

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

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 229e57e
  • 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 797edbd into master Nov 24, 2021
@mergify mergify bot deleted the nija-at/rds-undep branch November 24, 2021 12:16
@mergify
Copy link
Contributor

mergify bot commented Nov 24, 2021

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

@skinny85
Copy link
Contributor

What do you think about only removing them from the deprecated APIs lists, but keeping them deprecated? This means they remain deprecated, but won't be removed in V2.

@nija-at why wasn't this option considered?

Additionally, why did we un-deprecate a bunch of unversioned Instance engines? This wasn't included in the description of the PR.

Can we revert this PR?

@nija-at
Copy link
Contributor Author

nija-at commented Nov 25, 2021

why did we un-deprecate a bunch of unversioned Instance engines? This wasn't included in the description of the PR.

The PR description includes this.

why wasn't this option considered?

I don't see the value of this option. There is no point of providing warnings on APIs that we likely cannot remove (at least not according how deprecations are modeled today)

beezly pushed a commit to beezly/aws-cdk that referenced this pull request Nov 29, 2021
…aws#17683)

All deprecated APIs will be removed from CDKv2.

Migrating from `SnapshotCredentials.fromGeneratedPassword()` to
its documented alternative will modify the RDS
instance in ways that may impact usability of the resource. This API
must not be deprecated.

The alternative APIs to the `DatabaseInstanceEngine` APIs refereced in
this PR will cause the [CFN EngineVersion][1] to be modified.
Modification of this property causes [some interruption][2] to the
resource.
This may cause "some interruption" to users' running applications.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
TikiTDO pushed a commit to TikiTDO/aws-cdk that referenced this pull request Feb 21, 2022
…aws#17683)

All deprecated APIs will be removed from CDKv2.

Migrating from `SnapshotCredentials.fromGeneratedPassword()` to
its documented alternative will modify the RDS
instance in ways that may impact usability of the resource. This API
must not be deprecated.

The alternative APIs to the `DatabaseInstanceEngine` APIs refereced in
this PR will cause the [CFN EngineVersion][1] to be modified.
Modification of this property causes [some interruption][2] to the
resource.
This may cause "some interruption" to users' running applications.

[1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-engineversion
[2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-rds Related to Amazon Relational Database contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants