import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * An endpoint indexes are deployed into. An index endpoint can have multiple deployed indexes. * * To get more information about IndexEndpoint, see: * * * [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.indexEndpoints/) * * ## Example Usage * * ### Vertex Ai Index Endpoint * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const vertexNetwork = new gcp.compute.Network("vertex_network", {name: "network-name"}); * const vertexRange = new gcp.compute.GlobalAddress("vertex_range", { * name: "address-name", * purpose: "VPC_PEERING", * addressType: "INTERNAL", * prefixLength: 24, * network: vertexNetwork.id, * }); * const vertexVpcConnection = new gcp.servicenetworking.Connection("vertex_vpc_connection", { * network: vertexNetwork.id, * service: "servicenetworking.googleapis.com", * reservedPeeringRanges: [vertexRange.name], * }); * const project = gcp.organizations.getProject({}); * const indexEndpoint = new gcp.vertex.AiIndexEndpoint("index_endpoint", { * displayName: "sample-endpoint", * description: "A sample vertex endpoint", * region: "us-central1", * labels: { * "label-one": "value-one", * }, * network: pulumi.all([project, vertexNetwork.name]).apply(([project, name]) => `projects/${project.number}/global/networks/${name}`), * }, { * dependsOn: [vertexVpcConnection], * }); * ``` * ### Vertex Ai Index Endpoint With Psc * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = gcp.organizations.getProject({}); * const indexEndpoint = new gcp.vertex.AiIndexEndpoint("index_endpoint", { * displayName: "sample-endpoint", * description: "A sample vertex endpoint", * region: "us-central1", * labels: { * "label-one": "value-one", * }, * privateServiceConnectConfig: { * enablePrivateServiceConnect: true, * projectAllowlists: [project.then(project => project.name)], * }, * }); * ``` * ### Vertex Ai Index Endpoint With Public Endpoint * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const indexEndpoint = new gcp.vertex.AiIndexEndpoint("index_endpoint", { * displayName: "sample-endpoint", * description: "A sample vertex endpoint with an public endpoint", * region: "us-central1", * labels: { * "label-one": "value-one", * }, * publicEndpointEnabled: true, * }); * ``` * * ## Import * * IndexEndpoint can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{region}}/indexEndpoints/{{name}}` * * * `{{project}}/{{region}}/{{name}}` * * * `{{region}}/{{name}}` * * * `{{name}}` * * When using the `pulumi import` command, IndexEndpoint can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default projects/{{project}}/locations/{{region}}/indexEndpoints/{{name}} * ``` * * ```sh * $ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{project}}/{{region}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{region}}/{{name}} * ``` * * ```sh * $ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{name}} * ``` */ export declare class AiIndexEndpoint extends pulumi.CustomResource { /** * Get an existing AiIndexEndpoint 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, state?: AiIndexEndpointState, opts?: pulumi.CustomResourceOptions): AiIndexEndpoint; /** * Returns true if the given object is an instance of AiIndexEndpoint. 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 AiIndexEndpoint; /** * The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. */ readonly createTime: pulumi.Output; /** * The description of the Index. */ readonly description: pulumi.Output; /** * The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. * * * - - - */ readonly displayName: pulumi.Output; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ readonly effectiveLabels: pulumi.Output<{ [key: string]: string; }>; /** * Used to perform consistent read-modify-write updates. */ readonly etag: pulumi.Output; /** * The labels with user-defined metadata to organize your Indexes. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ readonly labels: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The resource name of the Index. */ readonly name: pulumi.Output; /** * The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the index endpoint should be peered. * Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. * [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. * Where `{project}` is a project number, as in `12345`, and `{network}` is network name. */ readonly network: pulumi.Output; /** * Optional. Configuration for private service connect. `network` and `privateServiceConnectConfig` are mutually exclusive. * Structure is documented below. */ readonly privateServiceConnectConfig: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint. */ readonly publicEndpointDomainName: pulumi.Output; /** * If true, the deployed index will be accessible through public endpoint. */ readonly publicEndpointEnabled: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * The region of the index endpoint. eg us-central1 */ readonly region: pulumi.Output; /** * The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. */ readonly updateTime: pulumi.Output; /** * Create a AiIndexEndpoint 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: AiIndexEndpointArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AiIndexEndpoint resources. */ export interface AiIndexEndpointState { /** * The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. */ createTime?: pulumi.Input; /** * The description of the Index. */ description?: pulumi.Input; /** * The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. * * * - - - */ displayName?: pulumi.Input; /** * All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services. */ effectiveLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * Used to perform consistent read-modify-write updates. */ etag?: pulumi.Input; /** * The labels with user-defined metadata to organize your Indexes. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The resource name of the Index. */ name?: pulumi.Input; /** * The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the index endpoint should be peered. * Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. * [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. * Where `{project}` is a project number, as in `12345`, and `{network}` is network name. */ network?: pulumi.Input; /** * Optional. Configuration for private service connect. `network` and `privateServiceConnectConfig` are mutually exclusive. * Structure is documented below. */ privateServiceConnectConfig?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint. */ publicEndpointDomainName?: pulumi.Input; /** * If true, the deployed index will be accessible through public endpoint. */ publicEndpointEnabled?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The region of the index endpoint. eg us-central1 */ region?: pulumi.Input; /** * The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a AiIndexEndpoint resource. */ export interface AiIndexEndpointArgs { /** * The description of the Index. */ description?: pulumi.Input; /** * The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. * * * - - - */ displayName: pulumi.Input; /** * The labels with user-defined metadata to organize your Indexes. * **Note**: This field is non-authoritative, and will only manage the labels present in your configuration. * Please refer to the field `effectiveLabels` for all of the labels present on the resource. */ labels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * The full name of the Google Compute Engine [network](https://cloud.google.com//compute/docs/networks-and-firewalls#networks) to which the index endpoint should be peered. * Private services access must already be configured for the network. If left unspecified, the index endpoint is not peered with any network. * [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. * Where `{project}` is a project number, as in `12345`, and `{network}` is network name. */ network?: pulumi.Input; /** * Optional. Configuration for private service connect. `network` and `privateServiceConnectConfig` are mutually exclusive. * Structure is documented below. */ privateServiceConnectConfig?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * If true, the deployed index will be accessible through public endpoint. */ publicEndpointEnabled?: pulumi.Input; /** * The region of the index endpoint. eg us-central1 */ region?: pulumi.Input; }