You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Doc] Clarify and add more examples to databricks_mws_network_connectivity_config and databricks_mws_ncc_private_endpoint_rule documentation (#4847)
## Changes
Clarify and add more examples to
`databricks_mws_network_connectivity_config` and
`databricks_mws_ncc_private_endpoint_rule` documentation
## 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
* Improve documentation for `databricks_git_credential` resource ([#4837](https://github.com/databricks/terraform-provider-databricks/pull/4837))
29
29
* Rename DLT references to Lakeflow Declarative pipelines ([#4842](https://github.com/databricks/terraform-provider-databricks/pull/4842))
30
+
* Clarify and add more examples to `databricks_mws_network_connectivity_config` and `databricks_mws_ncc_private_endpoint_rule` documentation ([#4847](https://github.com/databricks/terraform-provider-databricks/pull/4847))
@@ -63,23 +72,27 @@ The following arguments are available:
63
72
64
73
*`network_connectivity_config_id` - Canonical unique identifier of Network Connectivity Config in Databricks Account. Change forces creation of a new resource.
65
74
*`resource_id` - (Azure only) The Azure resource ID of the target resource. Change forces creation of a new resource.
66
-
*`group_id` - (Azure only) The sub-resource type (group ID) of the target resource. Must be one of supported resource types (i.e., `blob`, `dfs`, `sqlServer` , etc. Consult the [Azure documentation](https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview#private-link-resource) for full list of supported resources). Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for `blob` and one for `dfs`. Change forces creation of a new resource.
67
-
*`domain_names` - (AWS only) Only used by private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service. List of target AWS resource FQDNs accessible via the VPC endpoint service. Conflicts with `resource_names`.
75
+
*`group_id` - (Azure only) Not used by customer-managed private endpoint services. The sub-resource type (group ID) of the target resource. Must be one of supported resource types (i.e., `blob`, `dfs`, `sqlServer` , etc. Consult the [Azure documentation](https://learn.microsoft.com/en-us/azure/private-link/private-endpoint-overview#private-link-resource) for full list of supported resources). Note that to connect to workspace root storage (root DBFS), you need two endpoints, one for `blob` and one for `dfs`. Change forces creation of a new resource. Conflicts with `domain_names`.
76
+
*`domain_names`
77
+
* On Azure: List of domain names of target private link service. Only used by private endpoints to customer-managed private endpoint services. Conflicts with `group_id`.
78
+
* On AWS: List of target resource FQDNs accessible via the VPC endpoint service. Only used by private endpoints towards a VPC endpoint service behind a customer-managed VPC endpoint service. Conflicts with `resource_names`.
68
79
*`endpoint_service` - (AWS only) Example `com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123`. The full target AWS endpoint service name that connects to the destination resources of the private endpoint.
69
80
*`resource_names` - (AWS only) Only used by private endpoints towards AWS S3 service. List of globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. Conflict with `domain_names`.
81
+
*`enabled` - (AWS only) Activation status. Only used by private endpoints towards an AWS S3 service. Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources. Can only be updated after a private endpoint rule towards an AWS S3 service is successfully created.
70
82
71
83
## Attribute Reference
72
84
73
85
In addition to all arguments above, the following attributes are exported:
74
86
75
87
*`rule_id`- the ID of a private endpoint rule.
76
88
*`endpoint_name` - The name of the Azure private endpoint resource, e.g. "databricks-088781b3-77fa-4132-b429-1af0d91bc593-pe-3cb31234"
77
-
*`connection_state` - The current status of this private endpoint. The private endpoint rules are effective only if the connection state is ESTABLISHED. Remember that you must approve new endpoints on your resources in the Azure portal before they take effect.
89
+
*`connection_state` - The current status of this private endpoint. The private endpoint rules are effective only if the connection state is `ESTABLISHED`. Remember that you must approve new endpoints on your resources in the Azure portal before they take effect.
78
90
The possible values are:
79
91
*`PENDING`: The endpoint has been created and pending approval.
80
92
*`ESTABLISHED`: The endpoint has been approved and is ready to be used in your serverless compute resources.
81
93
*`REJECTED`: Connection was rejected by the private link resource owner.
82
94
*`DISCONNECTED`: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.
95
+
*`EXPIRED`: If the endpoint was created but not approved in 14 days, it will be EXPIRED.
83
96
*`deactivated` - Whether this private endpoint is deactivated.
84
97
*`deactivated_at` - Time in epoch milliseconds when this object was deactivated.
85
98
*`creation_time` - Time in epoch milliseconds when this object was created.
*`name` - Name of Network Connectivity Config in Databricks Account. Change forces creation of a new resource.
33
+
*`name` - Name of the network connectivity configuration. The name can contain alphanumeric characters, hyphens, and underscores. The length must be between 3 and 30 characters. The name must match the regular expression `^[0-9a-zA-Z-_]{3,30}$`. Change forces creation of a new resource.
34
34
*`region` - Region of the Network Connectivity Config. NCCs can only be referenced by your workspaces in the same region. Change forces creation of a new resource.
35
35
36
36
## Attribute Reference
@@ -39,7 +39,7 @@ In addition to all arguments above, the following attributes are exported:
39
39
40
40
*`id` - combination of `account_id` and `network_connectivity_config_id` separated by `/` character
41
41
*`network_connectivity_config_id` - Canonical unique identifier of Network Connectivity Config in Databricks Account
42
-
*`egress_conf` - block containing information about network connectivity rules that apply to network traffic from your serverless compute resources. Consists of the following fields:
42
+
*`egress_config` - block containing information about network connectivity rules that apply to network traffic from your serverless compute resources. Consists of the following fields:
43
43
*`default_rules` - block describing network connectivity rules that are applied by default without resource specific configurations. Consists of the following fields:
44
44
*`aws_stable_ip_rule` (AWS only) - block with information about stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to allow traffic from your Databricks workspace. Consists of the following fields:
45
45
*`cidr_blocks` - list of IP CIDR blocks.
@@ -49,7 +49,9 @@ In addition to all arguments above, the following attributes are exported:
49
49
*`target_services` - the Azure services to which this service endpoint rule applies to.
50
50
*`target_rules` - block describing network connectivity rules that configured for each destinations. These rules override default rules. Consists of the following fields:
51
51
*`azure_private_endpoint_rules` (Azure only) - list containing information about configure Azure Private Endpoints.
52
-
52
+
*`aws_private_endpoint_rules` (AWS only) - list containing information about configure AWS Private Endpoints.
53
+
*`creation_time` - time in epoch milliseconds when this object was created.
54
+
*`updated_time` - time in epoch milliseconds when this object was updated.
0 commit comments