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

fix lb output descriptions #309

Closed
wants to merge 2 commits into from
Closed

fix lb output descriptions #309

wants to merge 2 commits into from

Conversation

ibrahiem9
Copy link

@ibrahiem9 ibrahiem9 commented Oct 11, 2023

Description

This PR changes the output descriptions for lb_arn and lb_id so that they are clearly explained, instead of being duplicates of each other.

Motivation and Context

This change clarifies the description of the outputs so that it is less confusing.

Breaking Changes

No breaking changes.

How Has This Been Tested?

  • I have updated at least one of the examples/* to demonstrate and validate my change(s)
  • I have tested and validated these changes using one or more of the provided examples/* projects
  • I have executed pre-commit run -a on my pull request

Copy link
Member

@bryantbiggs bryantbiggs left a comment

Choose a reason for hiding this comment

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

This is currently following what the provider docs show (albeit slightly different wording) https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb#attribute-reference

@ibrahiem9
Copy link
Author

This is currently following what the provider docs show (albeit slightly different wording) https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb#attribute-reference

I see. That's a bit confusing to me--why they would choose the same description for 2 different values. Unless they mean id and arn are the same thing.

I'll close this since you're just following the official docs.

@ibrahiem9 ibrahiem9 closed this Oct 11, 2023
@bryantbiggs
Copy link
Member

id is on every resource because its the unique ID in the Terraform state map. Its commonly duplicated with other outputs such as name or arn if there are no other candidates for a unique identifier

Copy link

I'm going to lock this pull request 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 related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants