Skip to content

Commit fc595ac

Browse files
committed
Added AWS PrivateLink related resource documentation
1 parent 4283e73 commit fc595ac

File tree

3 files changed

+96
-1
lines changed

3 files changed

+96
-1
lines changed

docs/resources/mws_networks.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,14 @@ resource "databricks_mws_networks" "this" {
6464

6565
## Argument Reference
6666

67-
The following arguments are required:
67+
The following arguments are available:
6868

6969
* `account_id` - Account Id that could be found in the bottom left corner of [Accounts Console](https://accounts.cloud.databricks.com/)
7070
* `network_name` - name under which this network is regisstered
7171
* `vpc_id` - [aws_vpc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc) id
7272
* `subnet_ids` - ids of [aws_subnet](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/subnet)
7373
* `security_group_ids` - ids of [aws_security_group](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group)
74+
* `vpc_endpoints` (Optional) - mapping of [databricks_mws_vpc_endpoint](mws_vpc_endpoint.md) for PrivateLink connections
7475

7576
## Attribute Reference
7677

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
subcategory: "AWS"
3+
---
4+
# databricks_mws_private_access_settings Resource
5+
6+
-> **Public Preview** This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html). Contact your Databricks representative to request access.
7+
8+
-> **Note** This resource has an evolving API, which will change in the upcoming versions of the provider in order to simplify user experience.
9+
10+
## Example Usage
11+
12+
```hcl
13+
resource "databricks_mws_private_access_settings" "pas" {
14+
account_id = var.databricks_account_id
15+
private_access_settings_name = "Private Access Settings for ${aws_vpc.main.id}"
16+
region = local.region
17+
}
18+
```
19+
20+
## Argument Reference
21+
22+
The following arguments are available:
23+
24+
* `account_id` - Account Id that could be found in the bottom left corner of [Accounts Console](https://accounts.cloud.databricks.com/)
25+
* `private_access_settings_name` - Name of Private Access Settings in Databricks Account
26+
* `public_access_enabled` (Boolean, Optional, `false` by default) - If `true`, the [databricks_mws_workspaces](mws_workspaces.md) can be accessed over the [databricks_mws_vpc_endpoint](mws_vpc_endpoint.md) as well as over the public network. In such a case, you could also configure an [databricks_ip_access_list](ip_access_list.md) for the workspace, to restrict the source networks that could be used to access it over the public network. If `false` (default), the workspace can be accessed only over VPC endpoints, and not over the public network.
27+
* `region` - Region of AWS VPC
28+
29+
## Attribute Reference
30+
31+
In addition to all arguments above, the following attributes are exported:
32+
33+
* `private_access_settings_id` - Canonical unique identifier of Private Access Settings in Databricks Account
34+
* `status` - Status of Private Access Settings

docs/resources/mws_vpc_endpoint.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
subcategory: "AWS"
3+
---
4+
# databricks_mws_vpc_endpoint Resource
5+
6+
-> **Public Preview** This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html). Contact your Databricks representative to request access.
7+
8+
Connects [aws_vpc_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint) with [databricks_mws_networks](mws_networks.md) through PrivateLink.
9+
10+
## Example Usage
11+
12+
-> **Note** This resource has an evolving API, which will change in the upcoming versions of the provider in order to simplify user experience.
13+
14+
```hcl
15+
resource "aws_vpc_endpoint" "relay" {
16+
service_name = local.private_link.relay_endpoint
17+
vpc_id = aws_vpc.main.id
18+
vpc_endpoint_type = "Interface"
19+
security_group_ids = [aws_security_group.this.id]
20+
subnet_ids = [aws_subnet.databricks_endpoints.id]
21+
tags = {
22+
"Name" = "${var.workspace_name}-databricks-relay"
23+
}
24+
}
25+
26+
resource "databricks_mws_vpc_endpoint" "relay" {
27+
account_id = var.databricks_account_id
28+
aws_vpc_endpoint_id = aws_vpc_endpoint.relay.id
29+
vpc_endpoint_name = "VPC Relay for ${aws_vpc.main.id}"
30+
region = local.region
31+
}
32+
33+
resource "databricks_mws_networks" "this" {
34+
# ...
35+
36+
vpc_endpoints {
37+
dataplane_relay = [databricks_mws_vpc_endpoint.relay.vpc_endpoint_id]
38+
39+
# rest_api VPC endpoint is created in a similar way
40+
rest_api = [databricks_mws_vpc_endpoint.rest.vpc_endpoint_id]
41+
}
42+
}
43+
```
44+
45+
## Argument Reference
46+
47+
The following arguments are required:
48+
49+
* `account_id` - Account Id that could be found in the bottom left corner of [Accounts Console](https://accounts.cloud.databricks.com/)
50+
* `aws_vpc_endpoint_id` - ID of configured [aws_vpc_endpoint](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_endpoint)
51+
* `vpc_endpoint_name` - Name of VPC Endpoint in Databricks Account
52+
* `aws_endpoint_service_id` - ID of Databricks VPC endpoint service to connect to. Please contact your Databricks representative to request mapping
53+
* `region` - Region of AWS VPC
54+
55+
## Attribute Reference
56+
57+
In addition to all arguments above, the following attributes are exported:
58+
59+
* `vpc_endpoint_id` - Canonical unique identifier of VPC Endpoint in Databricks Account
60+
* `state` - State of VPC Endpoint

0 commit comments

Comments
 (0)