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.
This commit is contained in:
parent
6b700ff1fb
commit
eba5093115
|
@ -93,9 +93,10 @@ The following configuration options or environment variables are supported:
|
||||||
* `secret_key` / `AWS_SECRET_ACCESS_KEY` - (Optional) AWS secret access key.
|
* `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
|
* `kms_key_id` - (Optional) The ARN of a KMS Key to use for encrypting
|
||||||
the state.
|
the state.
|
||||||
* `lock_table` - (Optional) The name of a DynamoDB table to use for state
|
* `lock_table` - (Optional, Deprecated) Use `dynamodb_table` instead.
|
||||||
locking. The table must have a primary key named LockID. If not present,
|
* `dynamodb_table` - (Optional) The name of a DynamoDB table to use for state
|
||||||
locking will be disabled.
|
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
|
* `profile` - (Optional) This is the AWS profile name as set in the
|
||||||
shared credentials file.
|
shared credentials file.
|
||||||
* `shared_credentials_file` - (Optional) This is the path to the
|
* `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.
|
`~/.aws/credentials` will be used.
|
||||||
* `token` - (Optional) Use this to set an MFA token. It can also be
|
* `token` - (Optional) Use this to set an MFA token. It can also be
|
||||||
sourced from the `AWS_SESSION_TOKEN` environment variable.
|
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.
|
||||||
|
|
Loading…
Reference in New Issue