Docs Packages
  1. Packages
  2. Databricks
  3. API Docs
  4. VectorSearchEndpoint
Databricks v1.38.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-databricks

databricks.VectorSearchEndpoint

Explore with Pulumi AI

databricks logo
Databricks v1.38.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-databricks

    Note This resource could be only used on Unity Catalog-enabled workspace!

    This resource allows you to create Vector Search Endpoint in Databricks. Vector Search is a serverless similarity search engine that allows you to store a vector representation of your data, including metadata, in a vector database. The Vector Search Endpoint is used to create and access vector search indexes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const _this = new databricks.VectorSearchEndpoint("this", {
    name: "vector-search-test",
    endpointType: "STANDARD",
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.VectorSearchEndpoint("this",
    name="vector-search-test",
    endpoint_type="STANDARD")

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewVectorSearchEndpoint(ctx, "this", &databricks.VectorSearchEndpointArgs{
			Name:         pulumi.String("vector-search-test"),
			EndpointType: pulumi.String("STANDARD"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var @this = new Databricks.VectorSearchEndpoint("this", new()
    {
        Name = "vector-search-test",
        EndpointType = "STANDARD",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.VectorSearchEndpoint;
import com.pulumi.databricks.VectorSearchEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new VectorSearchEndpoint("this", VectorSearchEndpointArgs.builder()        
            .name("vector-search-test")
            .endpointType("STANDARD")
            .build());

    }
}

    resources:
  this:
    type: databricks:VectorSearchEndpoint
    properties:
      name: vector-search-test
      endpointType: STANDARD

    Create VectorSearchEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VectorSearchEndpoint(name: string, args: VectorSearchEndpointArgs, opts?: CustomResourceOptions);
    @overload
def VectorSearchEndpoint(resource_name: str,
                         args: VectorSearchEndpointArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def VectorSearchEndpoint(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         endpoint_type: Optional[str] = None,
                         name: Optional[str] = None)
    func NewVectorSearchEndpoint(ctx *Context, name string, args VectorSearchEndpointArgs, opts ...ResourceOption) (*VectorSearchEndpoint, error)
    public VectorSearchEndpoint(string name, VectorSearchEndpointArgs args, CustomResourceOptions? opts = null)
    public VectorSearchEndpoint(String name, VectorSearchEndpointArgs args)
public VectorSearchEndpoint(String name, VectorSearchEndpointArgs args, CustomResourceOptions options)

    type: databricks:VectorSearchEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VectorSearchEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VectorSearchEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VectorSearchEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VectorSearchEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VectorSearchEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var vectorSearchEndpointResource = new Databricks.VectorSearchEndpoint("vectorSearchEndpointResource", new()
{
    EndpointType = "string",
    Name = "string",
});

    example, err := databricks.NewVectorSearchEndpoint(ctx, "vectorSearchEndpointResource", &databricks.VectorSearchEndpointArgs{
	EndpointType: pulumi.String("string"),
	Name:         pulumi.String("string"),
})

    var vectorSearchEndpointResource = new VectorSearchEndpoint("vectorSearchEndpointResource", VectorSearchEndpointArgs.builder()        
    .endpointType("string")
    .name("string")
    .build());

    vector_search_endpoint_resource = databricks.VectorSearchEndpoint("vectorSearchEndpointResource",
    endpoint_type="string",
    name="string")

    const vectorSearchEndpointResource = new databricks.VectorSearchEndpoint("vectorSearchEndpointResource", {
    endpointType: "string",
    name: "string",
});

    type: databricks:VectorSearchEndpoint
properties:
    endpointType: string
    name: string

    VectorSearchEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The VectorSearchEndpoint resource accepts the following input properties:

    EndpointType string
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    Name string
    Name of the Vector Search Endpoint to create.
    EndpointType string
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    Name string
    Name of the Vector Search Endpoint to create.
    endpointType String
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    name String
    Name of the Vector Search Endpoint to create.
    endpointType string
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    name string
    Name of the Vector Search Endpoint to create.
    endpoint_type str
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    name str
    Name of the Vector Search Endpoint to create.
    endpointType String
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    name String
    Name of the Vector Search Endpoint to create.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VectorSearchEndpoint resource produces the following output properties:

    CreationTimestamp int
    Timestamp of endpoint creation (milliseconds).
    Creator string
    Creator of the endpoint.
    EndpointId string
    Unique internal identifier of the endpoint (UUID).
    EndpointStatuses List<VectorSearchEndpointEndpointStatus>
    Object describing the current status of the endpoint consisting of the following fields:
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTimestamp int
    Timestamp of the last update to the endpoint (milliseconds).
    LastUpdatedUser string
    User who last updated the endpoint.
    NumIndexes int
    Number of indexes on the endpoint.
    CreationTimestamp int
    Timestamp of endpoint creation (milliseconds).
    Creator string
    Creator of the endpoint.
    EndpointId string
    Unique internal identifier of the endpoint (UUID).
    EndpointStatuses []VectorSearchEndpointEndpointStatus
    Object describing the current status of the endpoint consisting of the following fields:
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTimestamp int
    Timestamp of the last update to the endpoint (milliseconds).
    LastUpdatedUser string
    User who last updated the endpoint.
    NumIndexes int
    Number of indexes on the endpoint.
    creationTimestamp Integer
    Timestamp of endpoint creation (milliseconds).
    creator String
    Creator of the endpoint.
    endpointId String
    Unique internal identifier of the endpoint (UUID).
    endpointStatuses List<VectorSearchEndpointEndpointStatus>
    Object describing the current status of the endpoint consisting of the following fields:
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTimestamp Integer
    Timestamp of the last update to the endpoint (milliseconds).
    lastUpdatedUser String
    User who last updated the endpoint.
    numIndexes Integer
    Number of indexes on the endpoint.
    creationTimestamp number
    Timestamp of endpoint creation (milliseconds).
    creator string
    Creator of the endpoint.
    endpointId string
    Unique internal identifier of the endpoint (UUID).
    endpointStatuses VectorSearchEndpointEndpointStatus[]
    Object describing the current status of the endpoint consisting of the following fields:
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTimestamp number
    Timestamp of the last update to the endpoint (milliseconds).
    lastUpdatedUser string
    User who last updated the endpoint.
    numIndexes number
    Number of indexes on the endpoint.
    creation_timestamp int
    Timestamp of endpoint creation (milliseconds).
    creator str
    Creator of the endpoint.
    endpoint_id str
    Unique internal identifier of the endpoint (UUID).
    endpoint_statuses Sequence[VectorSearchEndpointEndpointStatus]
    Object describing the current status of the endpoint consisting of the following fields:
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_timestamp int
    Timestamp of the last update to the endpoint (milliseconds).
    last_updated_user str
    User who last updated the endpoint.
    num_indexes int
    Number of indexes on the endpoint.
    creationTimestamp Number
    Timestamp of endpoint creation (milliseconds).
    creator String
    Creator of the endpoint.
    endpointId String
    Unique internal identifier of the endpoint (UUID).
    endpointStatuses List<Property Map>
    Object describing the current status of the endpoint consisting of the following fields:
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTimestamp Number
    Timestamp of the last update to the endpoint (milliseconds).
    lastUpdatedUser String
    User who last updated the endpoint.
    numIndexes Number
    Number of indexes on the endpoint.

    Look up Existing VectorSearchEndpoint Resource

    Get an existing VectorSearchEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VectorSearchEndpointState, opts?: CustomResourceOptions): VectorSearchEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_timestamp: Optional[int] = None,
        creator: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        endpoint_statuses: Optional[Sequence[VectorSearchEndpointEndpointStatusArgs]] = None,
        endpoint_type: Optional[str] = None,
        last_updated_timestamp: Optional[int] = None,
        last_updated_user: Optional[str] = None,
        name: Optional[str] = None,
        num_indexes: Optional[int] = None) -> VectorSearchEndpoint
    func GetVectorSearchEndpoint(ctx *Context, name string, id IDInput, state *VectorSearchEndpointState, opts ...ResourceOption) (*VectorSearchEndpoint, error)
    public static VectorSearchEndpoint Get(string name, Input<string> id, VectorSearchEndpointState? state, CustomResourceOptions? opts = null)
    public static VectorSearchEndpoint get(String name, Output<String> id, VectorSearchEndpointState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreationTimestamp int
    Timestamp of endpoint creation (milliseconds).
    Creator string
    Creator of the endpoint.
    EndpointId string
    Unique internal identifier of the endpoint (UUID).
    EndpointStatuses List<VectorSearchEndpointEndpointStatus>
    Object describing the current status of the endpoint consisting of the following fields:
    EndpointType string
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    LastUpdatedTimestamp int
    Timestamp of the last update to the endpoint (milliseconds).
    LastUpdatedUser string
    User who last updated the endpoint.
    Name string
    Name of the Vector Search Endpoint to create.
    NumIndexes int
    Number of indexes on the endpoint.
    CreationTimestamp int
    Timestamp of endpoint creation (milliseconds).
    Creator string
    Creator of the endpoint.
    EndpointId string
    Unique internal identifier of the endpoint (UUID).
    EndpointStatuses []VectorSearchEndpointEndpointStatusArgs
    Object describing the current status of the endpoint consisting of the following fields:
    EndpointType string
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    LastUpdatedTimestamp int
    Timestamp of the last update to the endpoint (milliseconds).
    LastUpdatedUser string
    User who last updated the endpoint.
    Name string
    Name of the Vector Search Endpoint to create.
    NumIndexes int
    Number of indexes on the endpoint.
    creationTimestamp Integer
    Timestamp of endpoint creation (milliseconds).
    creator String
    Creator of the endpoint.
    endpointId String
    Unique internal identifier of the endpoint (UUID).
    endpointStatuses List<VectorSearchEndpointEndpointStatus>
    Object describing the current status of the endpoint consisting of the following fields:
    endpointType String
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    lastUpdatedTimestamp Integer
    Timestamp of the last update to the endpoint (milliseconds).
    lastUpdatedUser String
    User who last updated the endpoint.
    name String
    Name of the Vector Search Endpoint to create.
    numIndexes Integer
    Number of indexes on the endpoint.
    creationTimestamp number
    Timestamp of endpoint creation (milliseconds).
    creator string
    Creator of the endpoint.
    endpointId string
    Unique internal identifier of the endpoint (UUID).
    endpointStatuses VectorSearchEndpointEndpointStatus[]
    Object describing the current status of the endpoint consisting of the following fields:
    endpointType string
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    lastUpdatedTimestamp number
    Timestamp of the last update to the endpoint (milliseconds).
    lastUpdatedUser string
    User who last updated the endpoint.
    name string
    Name of the Vector Search Endpoint to create.
    numIndexes number
    Number of indexes on the endpoint.
    creation_timestamp int
    Timestamp of endpoint creation (milliseconds).
    creator str
    Creator of the endpoint.
    endpoint_id str
    Unique internal identifier of the endpoint (UUID).
    endpoint_statuses Sequence[VectorSearchEndpointEndpointStatusArgs]
    Object describing the current status of the endpoint consisting of the following fields:
    endpoint_type str
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    last_updated_timestamp int
    Timestamp of the last update to the endpoint (milliseconds).
    last_updated_user str
    User who last updated the endpoint.
    name str
    Name of the Vector Search Endpoint to create.
    num_indexes int
    Number of indexes on the endpoint.
    creationTimestamp Number
    Timestamp of endpoint creation (milliseconds).
    creator String
    Creator of the endpoint.
    endpointId String
    Unique internal identifier of the endpoint (UUID).
    endpointStatuses List<Property Map>
    Object describing the current status of the endpoint consisting of the following fields:
    endpointType String
    Type of Vector Search Endpoint. Currently only accepting single value: STANDARD (See documentation for the list of currently supported values).
    lastUpdatedTimestamp Number
    Timestamp of the last update to the endpoint (milliseconds).
    lastUpdatedUser String
    User who last updated the endpoint.
    name String
    Name of the Vector Search Endpoint to create.
    numIndexes Number
    Number of indexes on the endpoint.

    Supporting Types

    VectorSearchEndpointEndpointStatus, VectorSearchEndpointEndpointStatusArgs

    Message string
    Additional status message.
    State string
    Current state of the endpoint. Currently following values are supported: PROVISIONING, ONLINE, and OFFLINE.
    Message string
    Additional status message.
    State string
    Current state of the endpoint. Currently following values are supported: PROVISIONING, ONLINE, and OFFLINE.
    message String
    Additional status message.
    state String
    Current state of the endpoint. Currently following values are supported: PROVISIONING, ONLINE, and OFFLINE.
    message string
    Additional status message.
    state string
    Current state of the endpoint. Currently following values are supported: PROVISIONING, ONLINE, and OFFLINE.
    message str
    Additional status message.
    state str
    Current state of the endpoint. Currently following values are supported: PROVISIONING, ONLINE, and OFFLINE.
    message String
    Additional status message.
    state String
    Current state of the endpoint. Currently following values are supported: PROVISIONING, ONLINE, and OFFLINE.

    Import

    The resource can be imported using the name of the Vector Search Endpoint

    bash

    $ pulumi import databricks:index/vectorSearchEndpoint:VectorSearchEndpoint this <endpoint-name>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.38.0 published on Monday, Apr 29, 2024 by Pulumi
    pulumi/pulumi-databricks