From eba5093115e1626bd1ca122cf354205b12a3cccb Mon Sep 17 00:00:00 2001 From: James Bardin Date: Tue, 30 May 2017 18:11:38 -0400 Subject: [PATCH] Update S3 backend docs Add dynamodb_table and deprecation notice on lock_table. Add missing parameters for the S3 backends: assume_role_policy, external_id, and session_name. --- website/source/docs/backends/types/s3.html.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/website/source/docs/backends/types/s3.html.md b/website/source/docs/backends/types/s3.html.md index ae6a386cd..51419cd77 100644 --- a/website/source/docs/backends/types/s3.html.md +++ b/website/source/docs/backends/types/s3.html.md @@ -93,9 +93,10 @@ The following configuration options or environment variables are supported: * `secret_key` / `AWS_SECRET_ACCESS_KEY` - (Optional) AWS secret access key. * `kms_key_id` - (Optional) The ARN of a KMS Key to use for encrypting the state. - * `lock_table` - (Optional) The name of a DynamoDB table to use for state - locking. The table must have a primary key named LockID. If not present, - locking will be disabled. + * `lock_table` - (Optional, Deprecated) Use `dynamodb_table` instead. + * `dynamodb_table` - (Optional) The name of a DynamoDB table to use for state + locking and consistency. The table must have a primary key named LockID. If + not present, locking will be disabled. * `profile` - (Optional) This is the AWS profile name as set in the shared credentials file. * `shared_credentials_file` - (Optional) This is the path to the @@ -103,4 +104,7 @@ The following configuration options or environment variables are supported: `~/.aws/credentials` will be used. * `token` - (Optional) Use this to set an MFA token. It can also be sourced from the `AWS_SESSION_TOKEN` environment variable. - * `role_arn` - (Optional) The role to be assumed + * `role_arn` - (Optional) The role to be assumed. + * `assume_role_policy` - (Optional) The permissions applied when assuming a role. + * `external_id` - (Optional) The external ID to use when assuming the role. + * `session_name` - (Optional) The session name to use when assuming the role.