Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref: code blocks around remote modify sse, etc. #3533

Merged
merged 10 commits into from
Jul 12, 2022
Merged

ref: code blocks around remote modify sse, etc. #3533

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
32b0e72
ref: codeblocks
jorgeorpinel May 9, 2022
35ff05e
Update content/docs/command-reference/remote/modify.md
jorgeorpinel May 9, 2022
95756b7
Update content/docs/command-reference/remote/modify.md
jorgeorpinel May 11, 2022
8dfeb4c
Merge branch 'master' into jorgeorpinel-patch-2
jorgeorpinel May 11, 2022
7e338d8
ref: link `sse_kms_key_id` remote config param
jorgeorpinel May 11, 2022
65b0cb5
Update content/docs/command-reference/remote/modify.md
jorgeorpinel May 12, 2022
b32f82a
Update content/docs/command-reference/remote/modify.md
jorgeorpinel May 12, 2022
670c667
Restyled by prettier (#3547)
restyled-io[bot] May 12, 2022
3875ac1
ref: remote modify sse aws:kms doesn't require explicit key
jorgeorpinel May 23, 2022
977a976
Restyled by prettier (#3581)
restyled-io[bot] May 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions content/docs/command-reference/remote/modify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,17 +246,17 @@ methods that are performed by DVC (`list_objects_v2` or `list_objects`,
$ dvc remote modify myremote listobjects true
```

- `sse` - server-side encryption algorithm to use (e.g. AES256, aws:kms). By
- `sse` - server-side encryption algorithm to use: `AES256` or `aws:kms`. By
default, no encryption is used.
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved

```dvc
$ dvc remote modify myremote sse AES256
```

- `sse_kms_key_id` - identifier of the key to encrypt data uploaded when using
SSE-KMS. Required when the `sse` parameter (above) is set to `aws:kms`. This
parameter will be passed directly to AWS S3 functions, so DVC supports any
value that S3 supports, including both key ids and aliases.
[SSE-KMS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingKMSEncryption.html)
(see `sse`). This parameter will be passed directly to AWS S3, so DVC supports
any value that S3 supports, including both key IDs and aliases.

```dvc
$ dvc remote modify --local myremote sse_kms_key_id 'key-alias'
Expand Down