-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Rename inconsistent resource/data source names #19999
Comments
Marking this issue as stale due to inactivity. This helps our maintainers find and focus on the active issues. If this issue receives no comments in the next 30 days it will automatically be closed. Maintainers can also remove the stale label. If this issue was automatically closed and you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thank you! |
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. |
Let's prioritize aligning these resources, as it's essential to maintain a polished and consistent experience. Using an outdated name like The approach used by other providers is to create a new resource with the correct name and deprecate the old resource with the wrong name. When the major version arrives, they dispatch the old resource. |
Community Note
Description - TL;DR
The AWS Provider exists in service to AWS. Maintaining consistency with AWS in resource naming projects professionalism and clarity. Imagine a practitioner trying to find the part of the AWS Console, documentation, or CLI dedicated to the
aws_cloudwatch_event_bus
resource. Just from the resource name, they will be lost. This looks shoddy.ec2
,rds
, andmeta
due to their significance and frequency of use. In other words,aws_instance
would stayaws_instance
but there would be a new resourceaws_events_bus
andaws_cloudwatch_event_bus
would be deprecated.Service Name Rules
Resource names should align with the AWS CLI commands and Go SDK package names, with exceptions made for clarity and consistency:
aws_{servicename}_{thing}
.{servicename}
should not have an_
(underscore).Why?
New or Affected Resource(s)
References
The text was updated successfully, but these errors were encountered: