Provide example for terraform taint documentation (#15873)

* Provide example to taint documentation

Provides an example (with similar formatting as
https://www.terraform.io/docs/commands/state/list.html#example-filtering-by-module)
for tainting resources within a module.

* Add documentation for tainting a single resource
This commit is contained in:
Joe Winter 2017-08-22 14:47:30 -04:00 committed by Clint
parent 1c1bd8161d
commit b6a464c521
1 changed files with 18 additions and 0 deletions

View File

@ -65,3 +65,21 @@ The command-line flags are all optional. The list of available flags are:
* `-state-out=path` - Path to write updated state file. By default, the * `-state-out=path` - Path to write updated state file. By default, the
`-state` path will be used. Ignored when `-state` path will be used. Ignored when
[remote state](/docs/state/remote.html) is used. [remote state](/docs/state/remote.html) is used.
## Example: Tainting a Single Resource
This example will taint a single resource:
```
$ terraform taint aws_security_group.allow_all
The resource aws_security_group.allow_all in the module root has been marked as tainted!
```
## Example: Tainting a Resource within a Module
This example will only taint a resource within a module:
```
$ terraform taint -module=couchbase aws_instance.cb_node.9
The resource aws_instance.couchbase.11 in the module root.couchbase has been marked as tainted!
```