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

d/aws_efs_file_system: Document 'file_system_id' attribute #39751

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

acmcelwee
Copy link

Description

This attribute already exists on the data source, but the documentation was simply missing that attribute.

References

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. service/efs Issues and PRs that pertain to the efs service. needs-triage Waiting for first response or review from a maintainer. labels Oct 16, 2024
@acmcelwee acmcelwee marked this pull request as ready for review October 16, 2024 15:49
@acmcelwee acmcelwee requested a review from a team as a code owner October 16, 2024 15:49
@@ -46,6 +46,7 @@ This data source exports the following attributes in addition to the arguments a
* `availability_zone_id` - The identifier of the Availability Zone in which the file system's One Zone storage classes exist.
* `dns_name` - DNS name for the filesystem per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html).
* `encrypted` - Whether EFS is encrypted.
* `file_system_id` - The ID that identifies the file system (e.g., fs-ccfc0d65).
Copy link
Author

Choose a reason for hiding this comment

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

You know, as I re-read these docs, I see above that it says This data source exports the following attributes in addition to the arguments above:.

Some AWS resources/data-sources fully lay out all attributes in the Attribute Reference section - example. Maybe what would be more useful is a removal of the statement This data source exports the following attributes in addition to the arguments above: and ensure that the Attribute Reference section covers the exhaustive list.

Thoughts?

Copy link
Member

@justinretzolk justinretzolk Oct 18, 2024

Choose a reason for hiding this comment

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

Hey @acmcelwee 👋 Thank you for taking the time to put this PR together! As you've mentioned, it looks like file_system_id is indeed documented in the argument section. The pattern our documentation follows is to split arguments (things that you can supply a value to in your configuration) and attributes (read-only values). This holds true in the aws_autoscaling_group data source that you linked to; you may only supply a value to the name argument, while the rest are read-only attributes.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome @acmcelwee 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTOR guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

@ewbankkit ewbankkit added needs-triage Waiting for first response or review from a maintainer. and removed needs-triage Waiting for first response or review from a maintainer. labels Oct 16, 2024
@justinretzolk justinretzolk added waiting-response Maintainers are waiting on response from community or contributor. and removed needs-triage Waiting for first response or review from a maintainer. labels Oct 18, 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. service/efs Issues and PRs that pertain to the efs service. waiting-response Maintainers are waiting on response from community or contributor.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants