a.vpc_endpoints: VPC Endpoint Configurations

class databricks.sdk.service.provisioning.VpcEndpointsAPI

These APIs manage VPC endpoint configurations for this account.

create([, aws_vpc_endpoint_id: Optional[str], gcp_vpc_endpoint_info: Optional[GcpVpcEndpointInfo], region: Optional[str], vpc_endpoint_name: Optional[str]]) → VpcEndpoint

Usage:

import os
import time

from databricks.sdk import AccountClient

a = AccountClient()

created = a.vpc_endpoints.create(
    aws_vpc_endpoint_id=os.environ["TEST_RELAY_VPC_ENDPOINT"],
    region=os.environ["AWS_REGION"],
    vpc_endpoint_name=f"sdk-{time.time_ns()}",
)

# cleanup
a.vpc_endpoints.delete(vpc_endpoint_id=created.vpc_endpoint_id)

Creates a VPC endpoint configuration, which represents a VPC endpoint object in AWS used to communicate privately with Databricks over AWS PrivateLink.

After you create the VPC endpoint configuration, the Databricks endpoint service automatically accepts the VPC endpoint.

Before configuring PrivateLink, read the Databricks article about PrivateLink.

Parameters:

• aws_vpc_endpoint_id – str (optional) The ID of the VPC endpoint object in AWS.

• gcp_vpc_endpoint_info – GcpVpcEndpointInfo (optional) The cloud info of this vpc endpoint.

• region – str (optional) The region in which this VPC endpoint object exists.

• vpc_endpoint_name – str (optional) The human-readable name of the storage configuration.

Returns:

VpcEndpoint

delete(vpc_endpoint_id: str) → VpcEndpoint

Deletes a Databricks VPC endpoint configuration. You cannot delete a VPC endpoint configuration that is associated with any workspace.

Parameters:

vpc_endpoint_id – str

Returns:

VpcEndpoint

get(vpc_endpoint_id: str) → VpcEndpoint

Usage:

import os
import time

from databricks.sdk import AccountClient

a = AccountClient()

created = a.vpc_endpoints.create(
    aws_vpc_endpoint_id=os.environ["TEST_RELAY_VPC_ENDPOINT"],
    region=os.environ["AWS_REGION"],
    vpc_endpoint_name=f"sdk-{time.time_ns()}",
)

by_id = a.vpc_endpoints.get(vpc_endpoint_id=created.vpc_endpoint_id)

# cleanup
a.vpc_endpoints.delete(vpc_endpoint_id=created.vpc_endpoint_id)

Gets a VPC endpoint configuration, which represents a VPC endpoint object in AWS used to communicate privately with Databricks over AWS PrivateLink.

Parameters:

vpc_endpoint_id – str Databricks VPC endpoint ID.

Returns:

VpcEndpoint

list() → Iterator[VpcEndpoint]

Usage:

from databricks.sdk import AccountClient

a = AccountClient()

all = a.vpc_endpoints.list()

Lists Databricks VPC endpoint configurations for an account.

Returns:

Iterator over VpcEndpoint