Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. vertex
  5. AiIndexEndpoint
Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.vertex.AiIndexEndpoint

Explore with Pulumi AI

Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp

An endpoint indexes are deployed into. An index endpoint can have multiple deployed indexes.

To get more information about IndexEndpoint, see:

Example Usage

Vertex Ai Index Endpoint

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],
});
Copy
import pulumi
import pulumi_gcp as gcp

vertex_network = gcp.compute.Network("vertex_network", name="network-name")
vertex_range = gcp.compute.GlobalAddress("vertex_range",
    name="address-name",
    purpose="VPC_PEERING",
    address_type="INTERNAL",
    prefix_length=24,
    network=vertex_network.id)
vertex_vpc_connection = gcp.servicenetworking.Connection("vertex_vpc_connection",
    network=vertex_network.id,
    service="servicenetworking.googleapis.com",
    reserved_peering_ranges=[vertex_range.name])
project = gcp.organizations.get_project()
index_endpoint = gcp.vertex.AiIndexEndpoint("index_endpoint",
    display_name="sample-endpoint",
    description="A sample vertex endpoint",
    region="us-central1",
    labels={
        "label-one": "value-one",
    },
    network=vertex_network.name.apply(lambda name: f"projects/{project.number}/global/networks/{name}"),
    opts = pulumi.ResourceOptions(depends_on=[vertex_vpc_connection]))
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/servicenetworking"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/vertex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		vertexNetwork, err := compute.NewNetwork(ctx, "vertex_network", &compute.NetworkArgs{
			Name: pulumi.String("network-name"),
		})
		if err != nil {
			return err
		}
		vertexRange, err := compute.NewGlobalAddress(ctx, "vertex_range", &compute.GlobalAddressArgs{
			Name:         pulumi.String("address-name"),
			Purpose:      pulumi.String("VPC_PEERING"),
			AddressType:  pulumi.String("INTERNAL"),
			PrefixLength: pulumi.Int(24),
			Network:      vertexNetwork.ID(),
		})
		if err != nil {
			return err
		}
		vertexVpcConnection, err := servicenetworking.NewConnection(ctx, "vertex_vpc_connection", &servicenetworking.ConnectionArgs{
			Network: vertexNetwork.ID(),
			Service: pulumi.String("servicenetworking.googleapis.com"),
			ReservedPeeringRanges: pulumi.StringArray{
				vertexRange.Name,
			},
		})
		if err != nil {
			return err
		}
		project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = vertex.NewAiIndexEndpoint(ctx, "index_endpoint", &vertex.AiIndexEndpointArgs{
			DisplayName: pulumi.String("sample-endpoint"),
			Description: pulumi.String("A sample vertex endpoint"),
			Region:      pulumi.String("us-central1"),
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
			Network: vertexNetwork.Name.ApplyT(func(name string) (string, error) {
				return fmt.Sprintf("projects/%v/global/networks/%v", project.Number, name), nil
			}).(pulumi.StringOutput),
		}, pulumi.DependsOn([]pulumi.Resource{
			vertexVpcConnection,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var vertexNetwork = new Gcp.Compute.Network("vertex_network", new()
    {
        Name = "network-name",
    });

    var vertexRange = new Gcp.Compute.GlobalAddress("vertex_range", new()
    {
        Name = "address-name",
        Purpose = "VPC_PEERING",
        AddressType = "INTERNAL",
        PrefixLength = 24,
        Network = vertexNetwork.Id,
    });

    var vertexVpcConnection = new Gcp.ServiceNetworking.Connection("vertex_vpc_connection", new()
    {
        Network = vertexNetwork.Id,
        Service = "servicenetworking.googleapis.com",
        ReservedPeeringRanges = new[]
        {
            vertexRange.Name,
        },
    });

    var project = Gcp.Organizations.GetProject.Invoke();

    var indexEndpoint = new Gcp.Vertex.AiIndexEndpoint("index_endpoint", new()
    {
        DisplayName = "sample-endpoint",
        Description = "A sample vertex endpoint",
        Region = "us-central1",
        Labels = 
        {
            { "label-one", "value-one" },
        },
        Network = Output.Tuple(project, vertexNetwork.Name).Apply(values =>
        {
            var project = values.Item1;
            var name = values.Item2;
            return $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/global/networks/{name}";
        }),
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            vertexVpcConnection,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.vertex.AiIndexEndpoint;
import com.pulumi.gcp.vertex.AiIndexEndpointArgs;
import com.pulumi.resources.CustomResourceOptions;
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 vertexNetwork = new Network("vertexNetwork", NetworkArgs.builder()
            .name("network-name")
            .build());

        var vertexRange = new GlobalAddress("vertexRange", GlobalAddressArgs.builder()
            .name("address-name")
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(24)
            .network(vertexNetwork.id())
            .build());

        var vertexVpcConnection = new Connection("vertexVpcConnection", ConnectionArgs.builder()
            .network(vertexNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(vertexRange.name())
            .build());

        final var project = OrganizationsFunctions.getProject();

        var indexEndpoint = new AiIndexEndpoint("indexEndpoint", AiIndexEndpointArgs.builder()
            .displayName("sample-endpoint")
            .description("A sample vertex endpoint")
            .region("us-central1")
            .labels(Map.of("label-one", "value-one"))
            .network(vertexNetwork.name().applyValue(name -> String.format("projects/%s/global/networks/%s", project.applyValue(getProjectResult -> getProjectResult.number()),name)))
            .build(), CustomResourceOptions.builder()
                .dependsOn(vertexVpcConnection)
                .build());

    }
}
Copy
resources:
  indexEndpoint:
    type: gcp:vertex:AiIndexEndpoint
    name: index_endpoint
    properties:
      displayName: sample-endpoint
      description: A sample vertex endpoint
      region: us-central1
      labels:
        label-one: value-one
      network: projects/${project.number}/global/networks/${vertexNetwork.name}
    options:
      dependsOn:
        - ${vertexVpcConnection}
  vertexVpcConnection:
    type: gcp:servicenetworking:Connection
    name: vertex_vpc_connection
    properties:
      network: ${vertexNetwork.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${vertexRange.name}
  vertexRange:
    type: gcp:compute:GlobalAddress
    name: vertex_range
    properties:
      name: address-name
      purpose: VPC_PEERING
      addressType: INTERNAL
      prefixLength: 24
      network: ${vertexNetwork.id}
  vertexNetwork:
    type: gcp:compute:Network
    name: vertex_network
    properties:
      name: network-name
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}
Copy

Vertex Ai Index Endpoint With Psc

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)],
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.get_project()
index_endpoint = gcp.vertex.AiIndexEndpoint("index_endpoint",
    display_name="sample-endpoint",
    description="A sample vertex endpoint",
    region="us-central1",
    labels={
        "label-one": "value-one",
    },
    private_service_connect_config={
        "enable_private_service_connect": True,
        "project_allowlists": [project.name],
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/vertex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = vertex.NewAiIndexEndpoint(ctx, "index_endpoint", &vertex.AiIndexEndpointArgs{
			DisplayName: pulumi.String("sample-endpoint"),
			Description: pulumi.String("A sample vertex endpoint"),
			Region:      pulumi.String("us-central1"),
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
			PrivateServiceConnectConfig: &vertex.AiIndexEndpointPrivateServiceConnectConfigArgs{
				EnablePrivateServiceConnect: pulumi.Bool(true),
				ProjectAllowlists: pulumi.StringArray{
					pulumi.String(project.Name),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var project = Gcp.Organizations.GetProject.Invoke();

    var indexEndpoint = new Gcp.Vertex.AiIndexEndpoint("index_endpoint", new()
    {
        DisplayName = "sample-endpoint",
        Description = "A sample vertex endpoint",
        Region = "us-central1",
        Labels = 
        {
            { "label-one", "value-one" },
        },
        PrivateServiceConnectConfig = new Gcp.Vertex.Inputs.AiIndexEndpointPrivateServiceConnectConfigArgs
        {
            EnablePrivateServiceConnect = true,
            ProjectAllowlists = new[]
            {
                project.Apply(getProjectResult => getProjectResult.Name),
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.vertex.AiIndexEndpoint;
import com.pulumi.gcp.vertex.AiIndexEndpointArgs;
import com.pulumi.gcp.vertex.inputs.AiIndexEndpointPrivateServiceConnectConfigArgs;
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) {
        final var project = OrganizationsFunctions.getProject();

        var indexEndpoint = new AiIndexEndpoint("indexEndpoint", AiIndexEndpointArgs.builder()
            .displayName("sample-endpoint")
            .description("A sample vertex endpoint")
            .region("us-central1")
            .labels(Map.of("label-one", "value-one"))
            .privateServiceConnectConfig(AiIndexEndpointPrivateServiceConnectConfigArgs.builder()
                .enablePrivateServiceConnect(true)
                .projectAllowlists(project.applyValue(getProjectResult -> getProjectResult.name()))
                .build())
            .build());

    }
}
Copy
resources:
  indexEndpoint:
    type: gcp:vertex:AiIndexEndpoint
    name: index_endpoint
    properties:
      displayName: sample-endpoint
      description: A sample vertex endpoint
      region: us-central1
      labels:
        label-one: value-one
      privateServiceConnectConfig:
        enablePrivateServiceConnect: true
        projectAllowlists:
          - ${project.name}
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}
Copy

Vertex Ai Index Endpoint With Public Endpoint

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,
});
Copy
import pulumi
import pulumi_gcp as gcp

index_endpoint = gcp.vertex.AiIndexEndpoint("index_endpoint",
    display_name="sample-endpoint",
    description="A sample vertex endpoint with an public endpoint",
    region="us-central1",
    labels={
        "label-one": "value-one",
    },
    public_endpoint_enabled=True)
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/vertex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vertex.NewAiIndexEndpoint(ctx, "index_endpoint", &vertex.AiIndexEndpointArgs{
			DisplayName: pulumi.String("sample-endpoint"),
			Description: pulumi.String("A sample vertex endpoint with an public endpoint"),
			Region:      pulumi.String("us-central1"),
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
			PublicEndpointEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var indexEndpoint = new Gcp.Vertex.AiIndexEndpoint("index_endpoint", new()
    {
        DisplayName = "sample-endpoint",
        Description = "A sample vertex endpoint with an public endpoint",
        Region = "us-central1",
        Labels = 
        {
            { "label-one", "value-one" },
        },
        PublicEndpointEnabled = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vertex.AiIndexEndpoint;
import com.pulumi.gcp.vertex.AiIndexEndpointArgs;
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 indexEndpoint = new AiIndexEndpoint("indexEndpoint", AiIndexEndpointArgs.builder()
            .displayName("sample-endpoint")
            .description("A sample vertex endpoint with an public endpoint")
            .region("us-central1")
            .labels(Map.of("label-one", "value-one"))
            .publicEndpointEnabled(true)
            .build());

    }
}
Copy
resources:
  indexEndpoint:
    type: gcp:vertex:AiIndexEndpoint
    name: index_endpoint
    properties:
      displayName: sample-endpoint
      description: A sample vertex endpoint with an public endpoint
      region: us-central1
      labels:
        label-one: value-one
      publicEndpointEnabled: true
Copy

Create AiIndexEndpoint Resource

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

Constructor syntax

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

@overload
def AiIndexEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    display_name: Optional[str] = None,
                    description: Optional[str] = None,
                    labels: Optional[Mapping[str, str]] = None,
                    network: Optional[str] = None,
                    private_service_connect_config: Optional[AiIndexEndpointPrivateServiceConnectConfigArgs] = None,
                    project: Optional[str] = None,
                    public_endpoint_enabled: Optional[bool] = None,
                    region: Optional[str] = None)
func NewAiIndexEndpoint(ctx *Context, name string, args AiIndexEndpointArgs, opts ...ResourceOption) (*AiIndexEndpoint, error)
public AiIndexEndpoint(string name, AiIndexEndpointArgs args, CustomResourceOptions? opts = null)
public AiIndexEndpoint(String name, AiIndexEndpointArgs args)
public AiIndexEndpoint(String name, AiIndexEndpointArgs args, CustomResourceOptions options)

type: gcp:vertex:AiIndexEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var aiIndexEndpointResource = new Gcp.Vertex.AiIndexEndpoint("aiIndexEndpointResource", new()
{
    DisplayName = "string",
    Description = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Network = "string",
    PrivateServiceConnectConfig = new Gcp.Vertex.Inputs.AiIndexEndpointPrivateServiceConnectConfigArgs
    {
        EnablePrivateServiceConnect = false,
        ProjectAllowlists = new[]
        {
            "string",
        },
    },
    Project = "string",
    PublicEndpointEnabled = false,
    Region = "string",
});
Copy
example, err := vertex.NewAiIndexEndpoint(ctx, "aiIndexEndpointResource", &vertex.AiIndexEndpointArgs{
	DisplayName: pulumi.String("string"),
	Description: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Network: pulumi.String("string"),
	PrivateServiceConnectConfig: &vertex.AiIndexEndpointPrivateServiceConnectConfigArgs{
		EnablePrivateServiceConnect: pulumi.Bool(false),
		ProjectAllowlists: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Project:               pulumi.String("string"),
	PublicEndpointEnabled: pulumi.Bool(false),
	Region:                pulumi.String("string"),
})
Copy
var aiIndexEndpointResource = new AiIndexEndpoint("aiIndexEndpointResource", AiIndexEndpointArgs.builder()
    .displayName("string")
    .description("string")
    .labels(Map.of("string", "string"))
    .network("string")
    .privateServiceConnectConfig(AiIndexEndpointPrivateServiceConnectConfigArgs.builder()
        .enablePrivateServiceConnect(false)
        .projectAllowlists("string")
        .build())
    .project("string")
    .publicEndpointEnabled(false)
    .region("string")
    .build());
Copy
ai_index_endpoint_resource = gcp.vertex.AiIndexEndpoint("aiIndexEndpointResource",
    display_name="string",
    description="string",
    labels={
        "string": "string",
    },
    network="string",
    private_service_connect_config={
        "enable_private_service_connect": False,
        "project_allowlists": ["string"],
    },
    project="string",
    public_endpoint_enabled=False,
    region="string")
Copy
const aiIndexEndpointResource = new gcp.vertex.AiIndexEndpoint("aiIndexEndpointResource", {
    displayName: "string",
    description: "string",
    labels: {
        string: "string",
    },
    network: "string",
    privateServiceConnectConfig: {
        enablePrivateServiceConnect: false,
        projectAllowlists: ["string"],
    },
    project: "string",
    publicEndpointEnabled: false,
    region: "string",
});
Copy
type: gcp:vertex:AiIndexEndpoint
properties:
    description: string
    displayName: string
    labels:
        string: string
    network: string
    privateServiceConnectConfig:
        enablePrivateServiceConnect: false
        projectAllowlists:
            - string
    project: string
    publicEndpointEnabled: false
    region: string
Copy

AiIndexEndpoint Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AiIndexEndpoint resource accepts the following input properties:

DisplayName This property is required. string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Description string
The description of the Index.
Labels Dictionary<string, string>
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 effective_labels for all of the labels present on the resource.
Network Changes to this property will trigger replacement. string
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
PrivateServiceConnectConfig Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfig
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PublicEndpointEnabled Changes to this property will trigger replacement. bool
If true, the deployed index will be accessible through public endpoint.
Region Changes to this property will trigger replacement. string
The region of the index endpoint. eg us-central1
DisplayName This property is required. string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Description string
The description of the Index.
Labels map[string]string
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 effective_labels for all of the labels present on the resource.
Network Changes to this property will trigger replacement. string
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
PrivateServiceConnectConfig Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfigArgs
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PublicEndpointEnabled Changes to this property will trigger replacement. bool
If true, the deployed index will be accessible through public endpoint.
Region Changes to this property will trigger replacement. string
The region of the index endpoint. eg us-central1
displayName This property is required. String
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

description String
The description of the Index.
labels Map<String,String>
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 effective_labels for all of the labels present on the resource.
network Changes to this property will trigger replacement. String
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
privateServiceConnectConfig Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfig
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
publicEndpointEnabled Changes to this property will trigger replacement. Boolean
If true, the deployed index will be accessible through public endpoint.
region Changes to this property will trigger replacement. String
The region of the index endpoint. eg us-central1
displayName This property is required. string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

description string
The description of the Index.
labels {[key: string]: string}
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 effective_labels for all of the labels present on the resource.
network Changes to this property will trigger replacement. string
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
privateServiceConnectConfig Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfig
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
publicEndpointEnabled Changes to this property will trigger replacement. boolean
If true, the deployed index will be accessible through public endpoint.
region Changes to this property will trigger replacement. string
The region of the index endpoint. eg us-central1
display_name This property is required. str
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

description str
The description of the Index.
labels Mapping[str, str]
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 effective_labels for all of the labels present on the resource.
network Changes to this property will trigger replacement. str
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
private_service_connect_config Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfigArgs
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
public_endpoint_enabled Changes to this property will trigger replacement. bool
If true, the deployed index will be accessible through public endpoint.
region Changes to this property will trigger replacement. str
The region of the index endpoint. eg us-central1
displayName This property is required. String
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

description String
The description of the Index.
labels Map<String>
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 effective_labels for all of the labels present on the resource.
network Changes to this property will trigger replacement. String
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
privateServiceConnectConfig Changes to this property will trigger replacement. Property Map
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
publicEndpointEnabled Changes to this property will trigger replacement. Boolean
If true, the deployed index will be accessible through public endpoint.
region Changes to this property will trigger replacement. String
The region of the index endpoint. eg us-central1

Outputs

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

CreateTime string
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Etag string
Used to perform consistent read-modify-write updates.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name of the Index.
PublicEndpointDomainName string
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
UpdateTime string
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
CreateTime string
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Etag string
Used to perform consistent read-modify-write updates.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name of the Index.
PublicEndpointDomainName string
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
UpdateTime string
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
createTime String
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
etag String
Used to perform consistent read-modify-write updates.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name of the Index.
publicEndpointDomainName String
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
updateTime String
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
createTime string
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
etag string
Used to perform consistent read-modify-write updates.
id string
The provider-assigned unique ID for this managed resource.
name string
The resource name of the Index.
publicEndpointDomainName string
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
updateTime string
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
create_time str
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
etag str
Used to perform consistent read-modify-write updates.
id str
The provider-assigned unique ID for this managed resource.
name str
The resource name of the Index.
public_endpoint_domain_name str
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
update_time str
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
createTime String
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
etag String
Used to perform consistent read-modify-write updates.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name of the Index.
publicEndpointDomainName String
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
updateTime String
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

Look up Existing AiIndexEndpoint Resource

Get an existing AiIndexEndpoint 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?: AiIndexEndpointState, opts?: CustomResourceOptions): AiIndexEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        etag: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        network: Optional[str] = None,
        private_service_connect_config: Optional[AiIndexEndpointPrivateServiceConnectConfigArgs] = None,
        project: Optional[str] = None,
        public_endpoint_domain_name: Optional[str] = None,
        public_endpoint_enabled: Optional[bool] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        region: Optional[str] = None,
        update_time: Optional[str] = None) -> AiIndexEndpoint
func GetAiIndexEndpoint(ctx *Context, name string, id IDInput, state *AiIndexEndpointState, opts ...ResourceOption) (*AiIndexEndpoint, error)
public static AiIndexEndpoint Get(string name, Input<string> id, AiIndexEndpointState? state, CustomResourceOptions? opts = null)
public static AiIndexEndpoint get(String name, Output<String> id, AiIndexEndpointState state, CustomResourceOptions options)
resources:  _:    type: gcp:vertex:AiIndexEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreateTime string
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
Description string
The description of the Index.
DisplayName string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Etag string
Used to perform consistent read-modify-write updates.
Labels Dictionary<string, string>
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 effective_labels for all of the labels present on the resource.
Name string
The resource name of the Index.
Network Changes to this property will trigger replacement. string
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
PrivateServiceConnectConfig Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfig
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PublicEndpointDomainName string
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
PublicEndpointEnabled Changes to this property will trigger replacement. bool
If true, the deployed index will be accessible through public endpoint.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
Region Changes to this property will trigger replacement. string
The region of the index endpoint. eg us-central1
UpdateTime string
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
CreateTime string
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
Description string
The description of the Index.
DisplayName string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Etag string
Used to perform consistent read-modify-write updates.
Labels map[string]string
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 effective_labels for all of the labels present on the resource.
Name string
The resource name of the Index.
Network Changes to this property will trigger replacement. string
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
PrivateServiceConnectConfig Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfigArgs
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
PublicEndpointDomainName string
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
PublicEndpointEnabled Changes to this property will trigger replacement. bool
If true, the deployed index will be accessible through public endpoint.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
Region Changes to this property will trigger replacement. string
The region of the index endpoint. eg us-central1
UpdateTime string
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
createTime String
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
description String
The description of the Index.
displayName String
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
etag String
Used to perform consistent read-modify-write updates.
labels Map<String,String>
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 effective_labels for all of the labels present on the resource.
name String
The resource name of the Index.
network Changes to this property will trigger replacement. String
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
privateServiceConnectConfig Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfig
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
publicEndpointDomainName String
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
publicEndpointEnabled Changes to this property will trigger replacement. Boolean
If true, the deployed index will be accessible through public endpoint.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
region Changes to this property will trigger replacement. String
The region of the index endpoint. eg us-central1
updateTime String
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
createTime string
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
description string
The description of the Index.
displayName string
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
etag string
Used to perform consistent read-modify-write updates.
labels {[key: string]: string}
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 effective_labels for all of the labels present on the resource.
name string
The resource name of the Index.
network Changes to this property will trigger replacement. string
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
privateServiceConnectConfig Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfig
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
publicEndpointDomainName string
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
publicEndpointEnabled Changes to this property will trigger replacement. boolean
If true, the deployed index will be accessible through public endpoint.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
region Changes to this property will trigger replacement. string
The region of the index endpoint. eg us-central1
updateTime string
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
create_time str
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
description str
The description of the Index.
display_name str
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
etag str
Used to perform consistent read-modify-write updates.
labels Mapping[str, str]
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 effective_labels for all of the labels present on the resource.
name str
The resource name of the Index.
network Changes to this property will trigger replacement. str
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
private_service_connect_config Changes to this property will trigger replacement. AiIndexEndpointPrivateServiceConnectConfigArgs
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
public_endpoint_domain_name str
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
public_endpoint_enabled Changes to this property will trigger replacement. bool
If true, the deployed index will be accessible through public endpoint.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
region Changes to this property will trigger replacement. str
The region of the index endpoint. eg us-central1
update_time str
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
createTime String
The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
description String
The description of the Index.
displayName String
The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
etag String
Used to perform consistent read-modify-write updates.
labels Map<String>
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 effective_labels for all of the labels present on the resource.
name String
The resource name of the Index.
network Changes to this property will trigger replacement. String
The full name of the Google Compute Engine network 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: projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is network name.
privateServiceConnectConfig Changes to this property will trigger replacement. Property Map
Optional. Configuration for private service connect. network and privateServiceConnectConfig are mutually exclusive. Structure is documented below.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
publicEndpointDomainName String
If publicEndpointEnabled is true, this field will be populated with the domain name to use for this index endpoint.
publicEndpointEnabled Changes to this property will trigger replacement. Boolean
If true, the deployed index will be accessible through public endpoint.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
region Changes to this property will trigger replacement. String
The region of the index endpoint. eg us-central1
updateTime String
The timestamp of when the Index was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

Supporting Types

AiIndexEndpointPrivateServiceConnectConfig
, AiIndexEndpointPrivateServiceConnectConfigArgs

EnablePrivateServiceConnect
This property is required.
Changes to this property will trigger replacement.
bool
If set to true, the IndexEndpoint is created without private service access.
ProjectAllowlists Changes to this property will trigger replacement. List<string>
A list of Projects from which the forwarding rule will target the service attachment.
EnablePrivateServiceConnect
This property is required.
Changes to this property will trigger replacement.
bool
If set to true, the IndexEndpoint is created without private service access.
ProjectAllowlists Changes to this property will trigger replacement. []string
A list of Projects from which the forwarding rule will target the service attachment.
enablePrivateServiceConnect
This property is required.
Changes to this property will trigger replacement.
Boolean
If set to true, the IndexEndpoint is created without private service access.
projectAllowlists Changes to this property will trigger replacement. List<String>
A list of Projects from which the forwarding rule will target the service attachment.
enablePrivateServiceConnect
This property is required.
Changes to this property will trigger replacement.
boolean
If set to true, the IndexEndpoint is created without private service access.
projectAllowlists Changes to this property will trigger replacement. string[]
A list of Projects from which the forwarding rule will target the service attachment.
enable_private_service_connect
This property is required.
Changes to this property will trigger replacement.
bool
If set to true, the IndexEndpoint is created without private service access.
project_allowlists Changes to this property will trigger replacement. Sequence[str]
A list of Projects from which the forwarding rule will target the service attachment.
enablePrivateServiceConnect
This property is required.
Changes to this property will trigger replacement.
Boolean
If set to true, the IndexEndpoint is created without private service access.
projectAllowlists Changes to this property will trigger replacement. List<String>
A list of Projects from which the forwarding rule will target the service attachment.

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:

$ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default projects/{{project}}/locations/{{region}}/indexEndpoints/{{name}}
Copy
$ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{project}}/{{region}}/{{name}}
Copy
$ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{region}}/{{name}}
Copy
$ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{name}}
Copy

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

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp