mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-01-02 22:00:19 -05:00
Adds the ability to target resources within modules, like: module.mymod.aws_instance.foo And the ability to target all resources inside a module, like: module.mymod Closes #1434
1.6 KiB
1.6 KiB
layout, page_title, sidebar_current, description
| layout | page_title | sidebar_current | description |
|---|---|---|---|
| docs | Internals: Resource Address | docs-internals-resource-addressing | Resource addressing is used to target specific resources in a larger infrastructure. |
Resource Addressing
A Resource Address is a string that references a specific resource in a larger infrastructure. An address is made up of two parts:
[module path][resource spec]
Module path:
A module path addresses a module within the tree of modules. It takes the form:
module.A.module.B.module.C...
Multiple modules in a path indicate nesting. If a module path is specified without a resource spec, the address applies to every resource within the module. If the module path is omitted, this addresses the root module.
Resource spec:
A resource spec addresses a specific resource in the config. It takes the form:
resource_type.resource_name[N]
resource_type- Type of the resource being addressed.resource_name- User-defined name of the resource.[N]- whereNis a0-based index into a resource with multiple instances specified by thecountmeta-parameter. Omitting an index when addressing a resource wherecount > 1means that the address references all instances.
Examples
Given a Terraform config that includes:
resource "aws_instance" "web" {
# ...
count = 4
}
An address like this:
aws_instance.web[3]
Refers to only the last instance in the config, and an address like this:
aws_instance.web
Refers to all four "web" instances.