aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap

Document a custom resource solution for AutoMinorVersionUpgrade property under AWS::RDS::DBInstance resource

Open
#1,308 6 comments 1 reaction 0 assignees View on GitHub
documentation NeedTriage
Dominant language
No language data
Stars
1.1k
Forks
62
PR merge metrics
No merged PRs in 30d

Description

### Name of the resource

AWS::RDS::DBInstance

### Resource name

AWS::RDS::DBInstance

### Reference Link

1) https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html
2) https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html

### Details

The AWS::RDS::DBInstance resource results in drift when the `AutoMinorVersionUpgrade`property is set to true and there is a minor version update. This causes the stack to go into drift.

### Documentation Request -
1) An update to the documentation for `AutoMinorVersionUpgrade` ([doc](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html )) parameter that it may result in drift due to out of band changes and the user needs to keep the template updated with current version of the DB instance.

2) Document a solution with a sample custom resource implementation which queries the current version on the instance and passes it to the `AWS::RDS::DBInstance` resource. In real world, it is usually not a single ops engineer who manages cloud formation templates, and it is difficult for customers to be already be aware of such an issue to occur in future and co-ordinate when it is not documented. Hence, it would be great to have this custom solution or a similar workaround documented either as an AWS Doc or an AWS Blog.

### Documents/pages where this custom resource solution can be added -
1) https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html
2) https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html #https://github.com/awsdocs/aws-cloudformation-user-guide/issues

Contributor guide

Open the contributing guide

Research direction

Read USER_UpgradeDBInstance.Maintenance.html and aws-resource-rds-dbinstance.html, focusing on AutoMinorVersionUpgrade and drift behavior. Document the caveat and a custom-resource workaround that queries the current DB version and passes it to AWS::RDS::DBInstance; done when both referenced pages contain the agreed guidance and example.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud, databases, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.