docs/commands: Show count and for_each resource address examples for commands

Verified on Mac OS 10.14.6 and Windows 10.
This commit is contained in:
Brian Flad 2019-08-02 19:36:24 -04:00
parent 3cda2bd7a5
commit 48624255ce
No known key found for this signature in database
GPG Key ID: EC6252B42B012823
4 changed files with 169 additions and 24 deletions

View File

@ -110,18 +110,50 @@ specifying `-config=""` (empty string). This is useful in situations where
you want to manually configure the provider because your configuration you want to manually configure the provider because your configuration
may not be valid. may not be valid.
## Example: AWS Instance ## Example: Import into Resource
This example will import an AWS instance: This example will import an AWS instance into the `aws_instance` resource named `foo`:
```shell ```shell
$ terraform import aws_instance.foo i-abcd1234 $ terraform import aws_instance.foo i-abcd1234
``` ```
## Example: Import to Module ## Example: Import into Module
The example below will import an AWS instance into a module: The example below will import an AWS instance into the `aws_instance` resource named `bar` into a module named `foo`:
```shell ```shell
$ terraform import module.foo.aws_instance.bar i-abcd1234 $ terraform import module.foo.aws_instance.bar i-abcd1234
``` ```
## Example: Import into Resource using count
The example below will import an AWS instance into the first instance of the `aws_instance` resource named `baz` using
[`count`](/docs/configuration/resources.html#count-multiple-resource-instances-by-count):
```shell
$ terraform import 'aws_instance.baz[0]' i-abcd1234
```
## Example: Import into Resource using for_each
The example below will import an AWS instance into the `"example"` instance of the `aws_instance` resource named `baz` using
[`for_each`](/docs/configuration/resources.html#for_each-multiple-resource-instances-defined-by-a-map-or-set-of-strings):
Linux, Mac OS, and UNIX:
```shell
$ terraform import 'aws_instance.baz["example"]' i-abcd1234
```
PowerShell:
```shell
$ terraform import 'aws_instance.baz[\"example\"]' i-abcd1234
```
Windows `cmd.exe`:
```shell
$ terraform import aws_instance.baz[\"example\"] i-abcd1234
```

View File

@ -59,36 +59,69 @@ The command-line flags are all optional. The list of available flags are:
## Example: Rename a Resource ## Example: Rename a Resource
The example below renames a single resource: The example below renames the `packet_device` resource named `worker` to `helper`:
``` ```shell
$ terraform state mv aws_instance.foo aws_instance.bar $ terraform state mv 'packet_device.worker' 'packet_device.helper'
``` ```
## Example: Move a Resource Into a Module ## Example: Move a Resource Into a Module
The example below moves a resource into a module. The module will be The example below moves the `packet_device` resource named `worker` into a module
created if it doesn't exist. named `app`. The module will be created if it doesn't exist.
``` ```shell
$ terraform state mv aws_instance.foo module.web $ terraform state mv 'packet_device.worker' 'module.app'
``` ```
## Example: Move a Module Into a Module ## Example: Move a Module Into a Module
The example below moves a module into another module. The example below moves the module named `app` under the module named `parent`.
``` ```shell
$ terraform state mv module.foo module.parent.module.foo $ terraform state mv 'module.app' 'module.parent.module.app'
``` ```
## Example: Move a Module to Another State ## Example: Move a Module to Another State
The example below moves a module into another state file. This removes The example below moves the module named `app` into another state file. This removes
the module from the original state file and adds it to the destination. the module from the original state file and adds it to the destination.
The source and destination are the same meaning we're keeping the same name. The source and destination are the same meaning we're keeping the same name.
```shell
$ terraform state mv -state-out=other.tfstate 'module.app' 'module.app'
``` ```
$ terraform state mv -state-out=other.tfstate \
module.web module.web ## Example: Move a Resource using count
The example below moves the first instance of a `packet_device` resource named `worker` using
[`count`](/docs/configuration/resources.html#count-multiple-resource-instances-by-count) to
the first instance of a resource named `helper` also using `count`:
```shell
$ terraform state mv 'packet_device.worker[0]' 'packet_device.helper[0]'
```
## Example: Move a Resource using for_each
The example below moves the `"example123"` instance of a `packet_device` resource named `worker` using
[`for_each`](/docs/configuration/resources.html#for_each-multiple-resource-instances-defined-by-a-map-or-set-of-strings)
to the `"example456"` instance of a resource named `helper` also using `for_each`:
Linux, Mac OS, and UNIX:
```shell
$ terraform state mv 'packet_device.worker["example123"]' 'packet_device.helper["example456"]'
```
PowerShell:
```shell
$ terraform state mv 'packet_device.worker[\"example123\"]' 'packet_device.helper[\"example456\"]'
```
Windows `cmd.exe`:
```shell
$ terraform state mv packet_device.worker[\"example123\"] packet_device.helper[\"example456\"]
``` ```

View File

@ -53,16 +53,56 @@ The command-line flags are all optional. The list of available flags are:
## Example: Remove a Resource ## Example: Remove a Resource
The example below removes a single resource in a module: The example below removes the `packet_device` resource named `worker`:
``` ```shell
$ terraform state rm module.foo.packet_device.worker[0] $ terraform state rm 'packet_device.worker'
``` ```
## Example: Remove a Module ## Example: Remove a Module
The example below removes an entire module: The example below removes the entire module named `foo`:
```shell
$ terraform state rm 'module.foo'
``` ```
$ terraform state rm module.foo
## Example: Remove a Module Resource
The example below removes the `packet_device` resource named `worker` inside a module named `foo`:
```shell
$ terraform state rm 'module.foo.packet_device.worker'
```
## Example: Remove a Resource using count
The example below removes the first instance of a `packet_device` resource named `worker` using
[`count`](/docs/configuration/resources.html#count-multiple-resource-instances-by-count):
```shell
$ terraform state rm 'packet_device.worker[0]'
```
## Example: Remove a Resource using for_each
The example below removes the `"example"` instance of a `packet_device` resource named `worker` using
[`for_each`](/docs/configuration/resources.html#for_each-multiple-resource-instances-defined-by-a-map-or-set-of-strings):
Linux, Mac OS, and UNIX:
```shell
$ terraform state rm 'packet_device.worker["example"]'
```
PowerShell:
```shell
$ terraform state rm 'packet_device.worker[\"example\"]'
```
Windows `cmd.exe`:
```shell
$ terraform state rm packet_device.worker[\"example\"]
``` ```

View File

@ -34,10 +34,10 @@ The command-line flags are all optional. The list of available flags are:
## Example: Show a Resource ## Example: Show a Resource
The example below shows a resource: The example below shows a `packet_device` resource named `worker`:
``` ```
$ terraform state show module.foo.packet_device.worker[0] $ terraform state show 'packet_device.worker'
id = 6015bg2b-b8c4-4925-aad2-f0671d5d3b13 id = 6015bg2b-b8c4-4925-aad2-f0671d5d3b13
billing_cycle = hourly billing_cycle = hourly
created = 2015-12-17T00:06:56Z created = 2015-12-17T00:06:56Z
@ -46,3 +46,43 @@ hostname = prod-xyz01
locked = false locked = false
... ...
``` ```
## Example: Show a Module Resource
The example below shows a `packet_device` resource named `worker` inside a module named `foo`:
```shell
$ terraform state show 'module.foo.packet_device.worker'
```
## Example: Show a Resource using count
The example below shows the first instance of a `packet_device` resource named `worker` using
[`count`](/docs/configuration/resources.html#count-multiple-resource-instances-by-count):
```shell
$ terraform state show 'packet_device.worker[0]'
```
## Example: Show a Resource using for_each
The example below shows the `"example"` instance of a `packet_device` resource named `worker` using
[`for_each`](/docs/configuration/resources.html#for_each-multiple-resource-instances-defined-by-a-map-or-set-of-strings):
Linux, Mac OS, and UNIX:
```shell
$ terraform state show 'packet_device.worker["example"]'
```
PowerShell:
```shell
$ terraform state show 'packet_device.worker[\"example\"]'
```
Windows `cmd.exe`:
```shell
$ terraform state show packet_device.worker[\"example\"]
```