-
Notifications
You must be signed in to change notification settings - Fork 9.8k
[Docs] aws_codebuild_project: Fix import identifier to arn
#44941
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
base: main
Are you sure you want to change the base?
[Docs] aws_codebuild_project: Fix import identifier to arn
#44941
Conversation
Community GuidelinesThis comment is added to every new Pull Request to provide quick reference to how the Terraform AWS Provider is maintained. Please review the information below, and thank you for contributing to the community that keeps the provider thriving! 🚀 Voting for Prioritization
Pull Request Authors
|
gdavison
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR, @tabito-hara. One item to change.
| * `arn` - ARN of the CodeBuild project. | ||
| * `badge_url` - URL of the build badge when `badge_enabled` is enabled. | ||
| * `id` - Name (if imported via `name`) or ARN (if created via Terraform or imported via ARN) of the CodeBuild project. | ||
| * `id` - ARN of the CodeBuild project. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the case of this resource type, since id is a duplicate of arn and is simply an implementation detail, it should be removed from the documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your review.
id has been removed as suggested in 6f13b2b
Rollback Plan
If a change needs to be reverted, we will publish an updated version of the library.
Changes to Security Controls
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
Description
This PR fixes the documentation of
aws_codebuild_projectregarding the import identifier.In the current implementation, only the
arncan be used as the import identifier. However, the previous documentation stated thatnamecould be used.nameandarnwere accepted as identifiers during import, since the “Read” function usesfindProjectByNameOrARN.However, when resource identity was introduced, the
arnwas designated as the identifier, and thenamecan no longer be used, as verified in Imports aws_codebuild_project require ARN instead of name #44940.Relations
Closes #44940