resource/aws_db_instance: Rename field name to db_name to prevent practitioner confusion

[gdavison]

Most AWS API resources, if they define a field Name (or <resource type>Name), use that field as an identifier for the resource itself, and the corresponding Terraform resource defines a field name.

The AWS API resource DBInstance uses the field DBInstanceIdentifier to identify the resource and the field DBName for the name of the initial database to create in the instance. The Terraform resource type aws_db_instance maps DBInstanceIdentifier to identifier, matching our naming conventions.

aws_db_instance maps the field DBName to name, which strips too much of the field name. In addition, there is a substantial amount of practitioner confusion around this unique usage of name.

In version v4.0 of the Terraform Provider for AWS, the field name should be deprecated and the field db_name should be added.

Since the data source aws_db_instance already uses the db_<field> naming pattern for most fields, we could also bring the remainder of the fields on the resource inline with this naming.

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Affected Resources

• aws_db_instance
• data. aws_db_instance

References

• Upcoming Changes in Version 4.0 of the AWS Provider #20433

[github-actions]

This functionality has been released in v4.0.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.