@pulumi/databricks/vectorSearchEndpoint.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * > This resource can only be used on a Unity Catalog-enabled workspace!
 *
 * This resource allows you to create [Mosaic AI Vector Search Endpoint](https://docs.databricks.com/en/generative-ai/vector-search.html) in Databricks.  Mosaic AI 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 Mosaic AI Vector Search Endpoint is used to create and access vector search indexes.
 *
 * ## Example Usage
 *
 * ```typescript
 * 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
 *
 * The resource can be imported using the name of the Mosaic AI Vector Search Endpoint
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/vectorSearchEndpoint:VectorSearchEndpoint this <endpoint-name>
 * ```
 */
export declare class VectorSearchEndpoint extends pulumi.CustomResource {
    /**
     * Get an existing VectorSearchEndpoint resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VectorSearchEndpointState, opts?: pulumi.CustomResourceOptions): VectorSearchEndpoint;
    /**
     * Returns true if the given object is an instance of VectorSearchEndpoint.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is VectorSearchEndpoint;
    /**
     * Timestamp of endpoint creation (milliseconds).
     */
    readonly creationTimestamp: pulumi.Output<number>;
    /**
     * Creator of the endpoint.
     */
    readonly creator: pulumi.Output<string>;
    /**
     * Unique internal identifier of the endpoint (UUID).
     */
    readonly endpointId: pulumi.Output<string>;
    /**
     * Object describing the current status of the endpoint consisting of the following fields:
     */
    readonly endpointStatuses: pulumi.Output<outputs.VectorSearchEndpointEndpointStatus[]>;
    /**
     * Type of Mosaic AI Vector Search Endpoint.  Currently only accepting single value: `STANDARD` (See [documentation](https://docs.databricks.com/api/workspace/vectorsearchendpoints/createendpoint) for the list of currently supported values).
     */
    readonly endpointType: pulumi.Output<string>;
    /**
     * Timestamp of the last update to the endpoint (milliseconds).
     */
    readonly lastUpdatedTimestamp: pulumi.Output<number>;
    /**
     * User who last updated the endpoint.
     */
    readonly lastUpdatedUser: pulumi.Output<string>;
    /**
     * Name of the Mosaic AI Vector Search Endpoint to create.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Number of indexes on the endpoint.
     */
    readonly numIndexes: pulumi.Output<number>;
    /**
     * Create a VectorSearchEndpoint resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: VectorSearchEndpointArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering VectorSearchEndpoint resources.
 */
export interface VectorSearchEndpointState {
    /**
     * Timestamp of endpoint creation (milliseconds).
     */
    creationTimestamp?: pulumi.Input<number>;
    /**
     * Creator of the endpoint.
     */
    creator?: pulumi.Input<string>;
    /**
     * Unique internal identifier of the endpoint (UUID).
     */
    endpointId?: pulumi.Input<string>;
    /**
     * Object describing the current status of the endpoint consisting of the following fields:
     */
    endpointStatuses?: pulumi.Input<pulumi.Input<inputs.VectorSearchEndpointEndpointStatus>[]>;
    /**
     * Type of Mosaic AI Vector Search Endpoint.  Currently only accepting single value: `STANDARD` (See [documentation](https://docs.databricks.com/api/workspace/vectorsearchendpoints/createendpoint) for the list of currently supported values).
     */
    endpointType?: pulumi.Input<string>;
    /**
     * Timestamp of the last update to the endpoint (milliseconds).
     */
    lastUpdatedTimestamp?: pulumi.Input<number>;
    /**
     * User who last updated the endpoint.
     */
    lastUpdatedUser?: pulumi.Input<string>;
    /**
     * Name of the Mosaic AI Vector Search Endpoint to create.
     */
    name?: pulumi.Input<string>;
    /**
     * Number of indexes on the endpoint.
     */
    numIndexes?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a VectorSearchEndpoint resource.
 */
export interface VectorSearchEndpointArgs {
    /**
     * Type of Mosaic AI Vector Search Endpoint.  Currently only accepting single value: `STANDARD` (See [documentation](https://docs.databricks.com/api/workspace/vectorsearchendpoints/createendpoint) for the list of currently supported values).
     */
    endpointType: pulumi.Input<string>;
    /**
     * Name of the Mosaic AI Vector Search Endpoint to create.
     */
    name?: pulumi.Input<string>;
}