Skip to content

Commit b138f9b

Browse files
alexottnkvuong
andauthored
Document encryption_details block in databricks_external_location resource and data source (#4849)
## Changes <!-- Summary of your changes that are easy to understand --> Should be merged after #4844 ## Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> - [x] relevant change in `docs/` folder - [x] has entry in `NEXT_CHANGELOG.md` file --------- Co-authored-by: vuong-nguyen <[email protected]>
1 parent 74ee227 commit b138f9b

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

NEXT_CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
* Update documentation for single-node clusters in `databricks_cluster` resource ([#4817](https://github.com/databricks/terraform-provider-databricks/pull/4817)).
2525
* Update GCP example for `databricks_external_location` resource ([#4826](https://github.com/databricks/terraform-provider-databricks/pull/4826))
2626
* Fix formatting for HTTP connection example in `databricks_connection` resource ([#4826](https://github.com/databricks/terraform-provider-databricks/pull/4826))
27+
* Document `encryption_details` block in `databricks_external_location` resource and data source ([#4849](https://github.com/databricks/terraform-provider-databricks/pull/4849))
2728
* Update Databricks SQL objects documentation ([#4840](https://github.com/databricks/terraform-provider-databricks/pull/4840))
2829
* Improve documentation for `databricks_git_credential` resource ([#4837](https://github.com/databricks/terraform-provider-databricks/pull/4837))
2930
* Rename DLT references to Lakeflow Declarative pipelines ([#4842](https://github.com/databricks/terraform-provider-databricks/pull/4842))

docs/data-sources/external_location.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,10 @@ This data source exports the following attributes:
4343
* `updated_at` - Time at which this catalog was last modified, in epoch milliseconds.
4444
* `updated_by` - Username of user who last modified catalog.
4545
* `access_point` - The ARN of the s3 access point to use with the external location (AWS).
46-
* `encryption_details` - The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
46+
* `encryption_details` - A block describing encryption options that apply to clients connecting to cloud storage. Consisting of the following attributes:
47+
* `sse_encryption_details` - a block describing server-Side Encryption properties for clients communicating with AWS S3. Consists of the following attributes:
48+
* `algorithm` - Encryption algorithm value. Sets the value of the `x-amz-server-side-encryption` header in S3 request.
49+
* `aws_kms_key_arn` - ARN of the SSE-KMS key used with the S3 location, when `algorithm = "SSE-KMS"`.
4750

4851
## Related Resources
4952

docs/resources/external_location.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,16 @@ The following arguments are required:
138138
- `force_destroy` - (Optional) Destroy external location regardless of its dependents.
139139
- `force_update` - (Optional) Update external location regardless of its dependents.
140140
- `access_point` - (Optional) The ARN of the s3 access point to use with the external location (AWS).
141-
- `encryption_details` - (Optional) The options for Server-Side Encryption to be used by each Databricks s3 client when connecting to S3 cloud storage (AWS).
142141
- `isolation_mode` - (Optional) Whether the external location is accessible from all workspaces or a specific set of workspaces. Can be `ISOLATION_MODE_ISOLATED` or `ISOLATION_MODE_OPEN`. Setting the external location to `ISOLATION_MODE_ISOLATED` will automatically allow access from the current workspace.
143142

143+
### encryption_details block
144+
145+
A block describing encryption options that apply to clients connecting to cloud storage. Consisting of the following attributes
146+
147+
- `sse_encryption_details` - a block describing server-Side Encryption properties for clients communicating with AWS S3. Consists of the following attributes:
148+
- `algorithm` - Encryption algorithm value. Sets the value of the `x-amz-server-side-encryption` header in S3 request.
149+
- `aws_kms_key_arn` - Optional ARN of the SSE-KMS key used with the S3 location, when `algorithm = "SSE-KMS"`. Sets the value of the `x-amz-server-side-encryption-aws-kms-key-id` header.
150+
144151
### file_event_queue block
145152

146153
The `file_event_queue` block supports the following:
@@ -160,7 +167,6 @@ The `file_event_queue` block supports the following:
160167
- `provided_sqs` - (Optional) Configuration for provided Amazon SQS queue.
161168
- `queue_url` - (Required) The URL of the SQS queue.
162169

163-
164170
## Attribute Reference
165171

166172
In addition to all arguments above, the following attributes are exported:

0 commit comments

Comments
 (0)