docs(rds): change default value for deleteAutomatedBackups from false to true #27977
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the default value for deleteAutomatedBackups prop is described as
false
in CDK document.https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_rds.DatabaseInstance.html#deleteautomatedbackups
However, from underlying CloudFormation resource and RDS API perspective,
true
is correct default value.https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deleteautomatedbackups
https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html
Also, From CDK implementation perspective, deleteAutomatedBackups prop is simply passed to deleteAutomatedBackups parameter for CfnDBInstance (AWS::RDS::DBInstance).
aws-cdk/packages/aws-cdk-lib/aws-rds/lib/instance.ts
Line 856 in 5665a95
This PR solves this discrepancy between the documentation for RDS DB Instances in CDK and CFn.
Closes #27973
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license