Skip to content
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

Deprecates some id attributes on Framework resources #40626

Merged
merged 12 commits into from
Dec 19, 2024
Merged

Conversation

gdavison
Copy link
Contributor

Description

Starts the process of deprecating unneeded id attributes in resource types implemented using Terraform Framework.

Note that regardless of the actual DeprecationMessage on the attribute, Terraform will display, e.g.

│ Warning: Deprecated attribute

│ on main.tf line 431, in resource "aws_s3_bucket_policy" "test":
│ 431: bucket = aws_s3_directory_bucket.test.id

│ The attribute "id" is deprecated. Refer to the provider documentation for details.

Adds

  • framework.IDAttributeDeprecatedWithAlternate when there is an alternate attribute to use
  • framework.IDAttributeDeprecatedNoReplacement when these is no replacement attribute

Deprecates id from

  • aws_s3_directory_bucket
  • aws_route53_cidr_location
  • aws_api_gateway_domain_name_access_association

@gdavison gdavison requested a review from a team as a code owner December 18, 2024 20:30
Copy link

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • 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.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added documentation Introduces or discusses updates to documentation. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. service/s3 Issues and PRs that pertain to the s3 service. service/route53 Issues and PRs that pertain to the route53 service. service/apigateway Issues and PRs that pertain to the apigateway service. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. labels Dec 18, 2024
Copy link
Contributor

@johnsonaj johnsonaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@gdavison gdavison merged commit 2ff7928 into main Dec 19, 2024
42 checks passed
@gdavison gdavison deleted the td-deprecated-id branch December 19, 2024 23:59
@github-actions github-actions bot added this to the v5.83.0 milestone Dec 20, 2024
terraform-aws-provider bot pushed a commit that referenced this pull request Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Introduces or discusses updates to documentation. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. service/apigateway Issues and PRs that pertain to the apigateway service. service/route53 Issues and PRs that pertain to the route53 service. service/s3 Issues and PRs that pertain to the s3 service. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants