ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update S3 backend docs to reflect new workspaces 

Explain the path generated for state files when using workspaces.
This commit is contained in:
James Bardin 2017-07-28 15:06:00 -04:00
parent 870617d22d
commit f63b216016
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
website/docs/backends/types/s3.html.md
View File

@ -12,9 +12,9 @@ description: |-
Stores the state as a given key in a given bucket on Stores the state as a given key in a given bucket on
[Amazon S3](https://aws.amazon.com/s3/). [Amazon S3](https://aws.amazon.com/s3/).
This backend also supports state locking via This backend also supports state locking and consistency checking via
[Dynamo DB](https://aws.amazon.com/dynamodb/). Enable locking by setting the [Dynamo DB](https://aws.amazon.com/dynamodb/), which can be enabled by setting
`dynamodb_table` key to a Dynamo DB table to use for the locks. the `dynamodb_table` field to an existing DynamoDB table name.
~> **Warning!** It is highly recommended that you enable ~> **Warning!** It is highly recommended that you enable
[Bucket Versioning](http://docs.aws.amazon.com/AmazonS3/latest/UG/enable-bucket-versioning.html) [Bucket Versioning](http://docs.aws.amazon.com/AmazonS3/latest/UG/enable-bucket-versioning.html)
@ -78,7 +78,9 @@ data.terraform_remote_state.network:
The following configuration options or environment variables are supported: The following configuration options or environment variables are supported:
* `bucket` - (Required) The name of the S3 bucket. * `bucket` - (Required) The name of the S3 bucket.
* `key` - (Required) The path to the state file inside the bucket. * `key` - (Required) The path to the state file inside the bucket. When using
a non-default [workspace](/docs/state/workspaces.html), the state path will
be `/workspace_key_prefix/workspace_name/key`
* `region` / `AWS_DEFAULT_REGION` - (Optional) The region of the S3 * `region` / `AWS_DEFAULT_REGION` - (Optional) The region of the S3
bucket. bucket.
* `endpoint` / `AWS_S3_ENDPOINT` - (Optional) A custom endpoint for the * `endpoint` / `AWS_S3_ENDPOINT` - (Optional) A custom endpoint for the