From f63b216016d14850686857bbc313406a1a283bf5 Mon Sep 17 00:00:00 2001 From: James Bardin Date: Fri, 28 Jul 2017 15:06:00 -0400 Subject: [PATCH] Update S3 backend docs to reflect new workspaces Explain the path generated for state files when using workspaces. --- website/docs/backends/types/s3.html.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/website/docs/backends/types/s3.html.md b/website/docs/backends/types/s3.html.md index bda66ab92..db8cc790f 100644 --- a/website/docs/backends/types/s3.html.md +++ b/website/docs/backends/types/s3.html.md @@ -12,9 +12,9 @@ description: |- Stores the state as a given key in a given bucket on [Amazon S3](https://aws.amazon.com/s3/). -This backend also supports state locking via -[Dynamo DB](https://aws.amazon.com/dynamodb/). Enable locking by setting the -`dynamodb_table` key to a Dynamo DB table to use for the locks. +This backend also supports state locking and consistency checking via +[Dynamo DB](https://aws.amazon.com/dynamodb/), which can be enabled by setting +the `dynamodb_table` field to an existing DynamoDB table name. ~> **Warning!** It is highly recommended that you enable [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: * `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 bucket. * `endpoint` / `AWS_S3_ENDPOINT` - (Optional) A custom endpoint for the