remote/s3: Add some docs for supported parameters

This commit is contained in:
Radek Simko 2015-09-14 10:36:55 +01:00
parent 3d77d158f7
commit 4f7f20ba23
1 changed files with 7 additions and 0 deletions

View File

@ -57,6 +57,13 @@ The following backends are supported:
in the `access_key`, `secret_key` and `region` variables in the `access_key`, `secret_key` and `region` variables
respectively, but passing credentials this way is not recommended since they respectively, but passing credentials this way is not recommended since they
will be included in cleartext inside the persisted state. will be included in cleartext inside the persisted state.
Other supported parameters include:
* `bucket` - the name of the S3 bucket
* `key` - path where to place/look for state file inside the bucket
* `encrypt` - whether to enable [server side encryption](http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html)
of the state file
* `acl` - [Canned ACL](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
to be applied to the state file.
* HTTP - Stores the state using a simple REST client. State will be fetched * HTTP - Stores the state using a simple REST client. State will be fetched
via GET, updated via POST, and purged with DELETE. Requires the `address` variable. via GET, updated via POST, and purged with DELETE. Requires the `address` variable.