a.vpc_endpoints: VPC Endpoint Configurations

class databricks.sdk.service.provisioning.VpcEndpointsAPI

These APIs manage VPC endpoint configurations for this account.

create(vpc_endpoint_name: str [, aws_vpc_endpoint_id: Optional[str], gcp_vpc_endpoint_info: Optional[GcpVpcEndpointInfo], region: 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)

Create VPC endpoint configuration.

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].

[AWS PrivateLink]: https://aws.amazon.com/privatelink [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html [VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html [endpoint service]: https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html

Parameters:

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

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

• gcp_vpc_endpoint_info – GcpVpcEndpointInfo (optional) The Google Cloud specific information for this Private Service Connect endpoint.

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

Returns:

VpcEndpoint

delete(vpc_endpoint_id: str)

Delete VPC endpoint configuration.

Deletes a VPC endpoint configuration, which represents an [AWS VPC endpoint] that can communicate privately with Databricks over [AWS PrivateLink].

Before configuring PrivateLink, read the [Databricks article about PrivateLink].

[AWS PrivateLink]: https://aws.amazon.com/privatelink [AWS VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html [Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html

Parameters:

vpc_endpoint_id – str Databricks VPC endpoint ID.

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)

Get a VPC endpoint configuration.

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

[AWS PrivateLink]: https://aws.amazon.com/privatelink [VPC endpoint]: https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html

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()

Get all VPC endpoint configurations.

Gets a list of all VPC endpoints for an account, specified by ID.

Before configuring PrivateLink, read the [Databricks article about PrivateLink].

[Databricks article about PrivateLink]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/privatelink.html

Returns:

Iterator over VpcEndpoint