Skip to content

Commit b88b91c

Browse files
DOCSP-12374 Add documentation on using S3 Bucket Encryption (#92)
* DOCSP-12374 Add documentation on using S3 Bucket Encryption * DOCSP-12374 updates for review * DOCSP-12374 updates for copy review feedback * DOCSP-12374 fixes for feedback DOCSP-12374 fixes for feedback DOCSP-12374 fixes excryption type name DOCSP-12374 fixes excryption type name DOCSP-12374 doc updates DOCSP-12374 doc updates DOCSP-12374 doc updates DOCSP-12374 doc updates
1 parent 25b75a9 commit b88b91c

File tree

2 files changed

+74
-0
lines changed

2 files changed

+74
-0
lines changed

source/config/config-data-lake.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,3 +176,4 @@ For complete documentation on the configuration fields and format, see :ref:`dat
176176
/reference/format/data-lake-configuration
177177
/reference/examples/path-syntax-examples
178178
/supported-unsupported/supported-partition-attributes
179+
/supported-unsupported/encryption
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
.. _s3-adl-encryption-mapping:
2+
3+
===============================
4+
Configuration for S3 Encryption
5+
===============================
6+
7+
.. default-domain:: mongodb
8+
9+
.. meta::
10+
:keywords: |data-lake| encryption
11+
12+
{+adl+} can query and analyze unencrypted data in your |aws| |s3|
13+
buckets without additional configuration. However, to read encrypted
14+
data or write data to your |s3| buckets using :ref:`adl-out-stage`,
15+
{+dl+} might require additional permissions depending on your |s3|
16+
encryption settings.
17+
18+
The following table describes the required configuration for your
19+
{+dl+} to read encrypted data and to use :ref:`adl-out-stage` to
20+
write data to |s3| for each type of |aws| |s3| encryption.
21+
22+
.. list-table::
23+
:header-rows: 1
24+
:widths: 20 80
25+
26+
* - |aws| |s3| Encryption Types
27+
- Required {+dl+} Configuration
28+
29+
* - `AES-256
30+
<https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html>`__
31+
- {+adl+} supports both reads and writes of data encrypted in |s3|
32+
buckets using AES-256 |aws| Managed Keys by default. No additional
33+
configuration is required.
34+
35+
* - `SSE with Amazon S3-Managed
36+
<https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html>`__
37+
- {+adl+} supports both reads and writes of data encrypted in the
38+
|s3| buckets using SSE with Amazon |s3| Managed Keys by default. No
39+
additional configuration is required.
40+
41+
* - `Customer Managed Symmetric Customer Master Keys
42+
<https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html#symmetric-cmks>`__
43+
- {+adl+} can't access data encrypted in the |s3| buckets using SSE
44+
Customer Managed Symmetric Customer Master Keys by default. For
45+
reads and writes, you must add permissions similar to the following
46+
to the policy assigned to your IAM role:
47+
48+
.. code-block:: json
49+
50+
{
51+
"Effect": "Allow",
52+
"Action": [
53+
"kms:GenerateDataKey",
54+
"kms:decrypt"
55+
],
56+
"Resource": [
57+
"arn:aws:kms:<aws-region>:<role-ID>:key/<master-key>"
58+
]
59+
}
60+
61+
To modify the your |aws| IAM role trust policy:
62+
63+
1. Log in to your |aws| Management Console and navigate to the
64+
:guilabel:`Identity and Access Management (IAM)` service
65+
page.
66+
67+
#. Select :guilabel:`Roles` from the left-side navigation and
68+
click on the IAM role to modify.
69+
70+
#. Select the :guilabel:`Trust Relationships` tab.
71+
72+
#. Click the :guilabel:`Edit trust relationship` button and edit
73+
the :guilabel:`Policy Document`.

0 commit comments

Comments
 (0)