Skip to content

Commit

Permalink
Add documentation for remote s3 sse_kms_key_id parameter (#1280)
Browse files Browse the repository at this point in the history
* Documenting sse_kms_key_id remote S3 parameter.

* Grammatical tweak.

* dvc remote modify: minor term fix

Co-authored-by: Ivan Shcheklein <[email protected]>
  • Loading branch information
jackwellsxyz and shcheklein authored May 11, 2020
1 parent 7c24b31 commit a2711eb
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,15 @@ these settings, you could use the following options:
$ dvc remote modify myremote sse AES256
```

- `sse_kms_key_id` - SSE-KMS key to use to encrypt data uploaded to S3, normally
specified when the `sse` parameter is set to `aws:kms`. This parameter will be
passed directly to AWS's S3 functions, so DVC supports any value that AWS
supports, including both KMS key ids and aliases.

```dvc
$ dvc remote modify myremote sse_kms_key_id alias/testkey
```

- `acl` - set object level access control list (ACL) such as `private`,
`public-read`, etc. By default, no ACL is specified.

Expand Down

0 comments on commit a2711eb

Please sign in to comment.