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

Documentation improvement- "Resource" block syntax #32438

Open
adi-garg opened this issue Dec 26, 2022 · 3 comments
Open

Documentation improvement- "Resource" block syntax #32438

adi-garg opened this issue Dec 26, 2022 · 3 comments
Labels
documentation new new issue not yet triaged

Comments

@adi-garg
Copy link

Terraform Version

Terraform v1.3.6
on windows_amd64
+ provider registry.terraform.io/hashicorp/aws v4.42.0

Affected Pages

https://developer.hashicorp.com/terraform/language/resources/syntax#resource-syntax

What is the docs issue?

1.Need showing how to reference the sample block
2.Need clarification on local resource name within Terraform vs actual resource name in the Cloud

Proposal

The resource type and name together serve as an identifier for a given resource and so must be unique within a module.

It may help to clarify this using same example:
The above resource may be referenced using aws_instance.web

Further it may help clarify about naming:
In the example above,web is NOT the actual infrastructure ec2/VM name. Actual name used for the cloud resource is defined inside the resource block.This is done usually using tags in AWS and using a dedicated name argument in Azure.

References

No response

@adi-garg adi-garg added documentation new new issue not yet triaged labels Dec 26, 2022
@crw
Copy link
Collaborator

crw commented Jan 6, 2023

Thanks for this request! I will pass this along to the docs team.

@TonyBhargav
Copy link

hi @crw , I would like to work on this documentation as a part of academic course work ,It would be a great opportunity for me to learn about the project architecture and design as well. Could you please assign it to me

@crw
Copy link
Collaborator

crw commented Jan 25, 2023

@TonyBhargav you are welcome to contribute to the documentation. We do not assign issues to community members, please open a PR with your suggested changes. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation new new issue not yet triaged
Projects
None yet
Development

No branches or pull requests

3 participants