vpc_endpoints

Creates, updates, deletes, gets or lists a vpc_endpoints resource.

Overview

Name	vpc_endpoints
Type	Resource
Id	databricks_account.provisioning.vpc_endpoints

Fields

The following fields are returned by SELECT queries:

vpc_endpoints_get

Name	Datatype	Description
account_id	string	The Databricks account ID that hosts the VPC endpoint configuration. TODO - This may signal an OpenAPI diff; it does not show up in the generated spec
aws_account_id	string	The AWS Account in which the VPC endpoint object exists.
aws_endpoint_service_id	string	The ID of the Databricks [endpoint service] that this VPC endpoint is connected to. For a list of endpoint service IDs for each supported AWS region, see the [Databricks PrivateLink documentation]. [Databricks PrivateLink documentation]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html [endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-service.html
aws_vpc_endpoint_id	string	The ID of the VPC endpoint object in AWS.
vpc_endpoint_id	string	Databricks VPC endpoint ID. This is the Databricks-specific name of the VPC endpoint. Do not confuse this with the `aws_vpc_endpoint_id`, which is the ID within AWS of the VPC endpoint.
vpc_endpoint_name	string	The human-readable name of the storage configuration.
▶gcp_vpc_endpoint_info	object	The cloud info of this vpc endpoint. Info for a GCP vpc endpoint.
region	string	The AWS region in which this VPC endpoint object exists.
state	string	The current state (such as `available` or `rejected`) of the VPC endpoint. Derived from AWS. For the full set of values, see [AWS DescribeVpcEndpoint documentation]. [AWS DescribeVpcEndpoint documentation]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html
use_case	string	This enumeration represents the type of Databricks VPC endpoint service that was used when creating this VPC endpoint. If the VPC endpoint connects to the Databricks control plane for either the front-end connection or the back-end REST API connection, the value is GENERAL_ACCESS. If the VPC endpoint connects to the Databricks workspace for the back-end secure cluster connectivity relay, the value is DATAPLANE_RELAY_ACCESS. (DATAPLANE_RELAY_ACCESS, GENERAL_ACCESS, WORKSPACE_ACCESS)

vpc_endpoints_list

Name	Datatype	Description
account_id	string	The Databricks account ID that hosts the VPC endpoint configuration. TODO - This may signal an OpenAPI diff; it does not show up in the generated spec
aws_account_id	string	The AWS Account in which the VPC endpoint object exists.
aws_endpoint_service_id	string	The ID of the Databricks [endpoint service] that this VPC endpoint is connected to. For a list of endpoint service IDs for each supported AWS region, see the [Databricks PrivateLink documentation]. [Databricks PrivateLink documentation]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html [endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/endpoint-service.html
aws_vpc_endpoint_id	string	The ID of the VPC endpoint object in AWS.
vpc_endpoint_id	string	Databricks VPC endpoint ID. This is the Databricks-specific name of the VPC endpoint. Do not confuse this with the `aws_vpc_endpoint_id`, which is the ID within AWS of the VPC endpoint.
vpc_endpoint_name	string	The human-readable name of the storage configuration.
▶gcp_vpc_endpoint_info	object	The cloud info of this vpc endpoint. Info for a GCP vpc endpoint.
region	string	The AWS region in which this VPC endpoint object exists.
state	string	The current state (such as `available` or `rejected`) of the VPC endpoint. Derived from AWS. For the full set of values, see [AWS DescribeVpcEndpoint documentation]. [AWS DescribeVpcEndpoint documentation]: https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html
use_case	string	This enumeration represents the type of Databricks VPC endpoint service that was used when creating this VPC endpoint. If the VPC endpoint connects to the Databricks control plane for either the front-end connection or the back-end REST API connection, the value is GENERAL_ACCESS. If the VPC endpoint connects to the Databricks workspace for the back-end secure cluster connectivity relay, the value is DATAPLANE_RELAY_ACCESS. (DATAPLANE_RELAY_ACCESS, GENERAL_ACCESS, WORKSPACE_ACCESS)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
vpc_endpoints_get	select	account_id, vpc_endpoint_id		Gets a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to communicate
vpc_endpoints_list	select	account_id		Lists Databricks VPC endpoint configurations for an account.
vpc_endpoints_create	insert	account_id		Creates a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to
vpc_endpoints_delete	delete	account_id, vpc_endpoint_id		Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC endpoint configuration that

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string
vpc_endpoint_id	string

SELECT examples

vpc_endpoints_get

Gets a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to communicate

SELECT
account_id,
aws_account_id,
aws_endpoint_service_id,
aws_vpc_endpoint_id,
vpc_endpoint_id,
vpc_endpoint_name,
gcp_vpc_endpoint_info,
region,
state,
use_case
FROM databricks_account.provisioning.vpc_endpoints
WHERE account_id = '{{ account_id }}' -- required
AND vpc_endpoint_id = '{{ vpc_endpoint_id }}' -- required
;

vpc_endpoints_list

Lists Databricks VPC endpoint configurations for an account.

SELECT
account_id,
aws_account_id,
aws_endpoint_service_id,
aws_vpc_endpoint_id,
vpc_endpoint_id,
vpc_endpoint_name,
gcp_vpc_endpoint_info,
region,
state,
use_case
FROM databricks_account.provisioning.vpc_endpoints
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

vpc_endpoints_create

Creates a VPC endpoint configuration, which represents a [VPC endpoint] object in AWS used to

INSERT INTO databricks_account.provisioning.vpc_endpoints (
aws_vpc_endpoint_id,
gcp_vpc_endpoint_info,
region,
vpc_endpoint_name,
account_id
)
SELECT 
'{{ aws_vpc_endpoint_id }}',
'{{ gcp_vpc_endpoint_info }}',
'{{ region }}',
'{{ vpc_endpoint_name }}',
'{{ account_id }}'
RETURNING
account_id,
aws_account_id,
aws_endpoint_service_id,
aws_vpc_endpoint_id,
vpc_endpoint_id,
vpc_endpoint_name,
gcp_vpc_endpoint_info,
region,
state,
use_case
;

Manifest

# Description fields are for documentation purposes
- name: vpc_endpoints
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the vpc_endpoints resource.
  - name: aws_vpc_endpoint_id
    value: "{{ aws_vpc_endpoint_id }}"
    description: |
      The ID of the VPC endpoint object in AWS.
  - name: gcp_vpc_endpoint_info
    description: |
      The cloud info of this vpc endpoint.
    value:
      project_id: "{{ project_id }}"
      psc_endpoint_name: "{{ psc_endpoint_name }}"
      endpoint_region: "{{ endpoint_region }}"
      psc_connection_id: "{{ psc_connection_id }}"
      service_attachment_id: "{{ service_attachment_id }}"
  - name: region
    value: "{{ region }}"
    description: |
      The region in which this VPC endpoint object exists.
  - name: vpc_endpoint_name
    value: "{{ vpc_endpoint_name }}"
    description: |
      The human-readable name of the storage configuration.

DELETE examples

vpc_endpoints_delete

Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC endpoint configuration that

DELETE FROM databricks_account.provisioning.vpc_endpoints
WHERE account_id = '{{ account_id }}' --required
AND vpc_endpoint_id = '{{ vpc_endpoint_id }}' --required
;