Databricks SDK for JavaScript
    Preparing search index...

    Interface VpcEndpoint

    interface VpcEndpoint {
        accountId?: string;
        awsAccountId?: string;
        awsEndpointServiceId?: string;
        awsVpcEndpointId?: string;
        region?: string;
        state?: string;
        useCase?: VpcEndpointUseCase;
        vpcEndpointId?: string;
        vpcEndpointInfo?: {
            $case: "gcpVpcEndpointInfo";
            gcpVpcEndpointInfo: GcpVpcEndpointInfo;
        };
        vpcEndpointName?: string;
    }
    Index

    Properties

    accountId? awsAccountId? awsEndpointServiceId? awsVpcEndpointId? region? state? useCase? vpcEndpointId? vpcEndpointInfo? vpcEndpointName?

    Properties

    accountId?: string

    The account ID that hosts the VPC endpoint configuration.

    awsAccountId?: string

    The AWS Account in which the VPC endpoint object exists.

    awsEndpointServiceId?: string

    The ID of the 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.

    awsVpcEndpointId?: string

    The ID of the VPC endpoint object in AWS.

    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.

    useCase?: VpcEndpointUseCase

    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 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 workspace for the back-end secure cluster connectivity relay, the value is DATAPLANE_RELAY_ACCESS.

    vpcEndpointId?: string

    Databricks VPC endpoint ID. This is the -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.

    vpcEndpointInfo?: {
        $case: "gcpVpcEndpointInfo";
        gcpVpcEndpointInfo: GcpVpcEndpointInfo;
    }

    Type Declaration

    • $case: "gcpVpcEndpointInfo"
    • gcpVpcEndpointInfo: GcpVpcEndpointInfo

      The cloud info of this vpc endpoint. Info for a GCP vpc endpoint.

    vpcEndpointName?: string

    The human-readable name of the storage configuration.

    Settings

    Member Visibility

    On This Page

    Properties