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.

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

s3fs: Added documentation for SSE-C support #3498

Merged
merged 7 commits into from
Jun 22, 2022
17 changes: 17 additions & 0 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,23 @@ methods that are performed by DVC (`list_objects_v2` or `list_objects`,
$ dvc remote modify --local myremote sse_kms_key_id 'key-alias'
```

- `sse_customer_key` - key to encrypt data uploaded when using customer-provided
encryption keys
([SSE-C](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html)).
instead of `sse`. The value should be a base64-encoded 256 bit key.

```dvc
$ dvc remote modify --local myremote sse_customer_key 'mysecret'
```

- `sse_customer_algorithm` - server-side encryption algorithm to use with
`sse_customer_key`. This parameter will be passed directly to AWS S3, so DVC
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
supports any value that S3 supports. `AES256` by default.

```dvc
$ dvc remote modify myremote sse_customer_algorithm 'AES256'
```

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

Expand Down