pulumi-gcp-kotlin/com.pulumi.gcp.vertex.kotlin/AiIndexEndpointArgs

AiIndexEndpointArgs

data class AiIndexEndpointArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val network: Output<String>? = null, val project: Output<String>? = null, val publicEndpointEnabled: Output<Boolean>? = null, val region: Output<String>? = null) : ConvertibleToJava<AiIndexEndpointArgs>

An endpoint indexes are deployed into. An index endpoint can have multiple deployed indexes. To get more information about IndexEndpoint, see:

API documentation

Example Usage

Vertex Ai Index Endpoint

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetNetworkArgs;
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) {
        final var vertexNetwork = ComputeFunctions.getNetwork(GetNetworkArgs.builder()
            .name("network-name")
            .build());
        var vertexRange = new GlobalAddress("vertexRange", GlobalAddressArgs.builder()
            .purpose("VPC_PEERING")
            .addressType("INTERNAL")
            .prefixLength(24)
            .network(vertexNetwork.applyValue(getNetworkResult -> getNetworkResult.id()))
            .build());
        var vertexVpcConnection = new Connection("vertexVpcConnection", ConnectionArgs.builder()
            .network(vertexNetwork.applyValue(getNetworkResult -> getNetworkResult.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(String.format("projects/%s/global/networks/%s", project.applyValue(getProjectResult -> getProjectResult.number()),vertexNetwork.applyValue(getNetworkResult -> getNetworkResult.name())))
            .build(), CustomResourceOptions.builder()
                .dependsOn(vertexVpcConnection)
                .build());
    }
}

Vertex Ai Index Endpoint With Public Endpoint

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()
            .description("A sample vertex endpoint with an public endpoint")
            .displayName("sample-endpoint")
            .labels(Map.of("label-one", "value-one"))
            .publicEndpointEnabled(true)
            .region("us-central1")
            .build());
    }
}

Import

IndexEndpoint can be imported using any of these accepted formats

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

$ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{project}}/{{region}}/{{name}}

$ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{region}}/{{name}}

$ pulumi import gcp:vertex/aiIndexEndpoint:AiIndexEndpoint default {{name}}

Constructors

AiIndexEndpointArgs

fun AiIndexEndpointArgs(description: Output<String>? = null, displayName: Output<String>? = null, labels: Output<Map<String, String>>? = null, network: Output<String>? = null, project: Output<String>? = null, publicEndpointEnabled: Output<Boolean>? = null, region: Output<String>? = null)

Functions

toJava

open override fun toJava(): AiIndexEndpointArgs

Properties

description

val description: Output<String>? = null

The description of the Index.

displayName

val displayName: Output<String>? = null

The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

labels

val labels: Output<Map<String, String>>? = null

The labels with user-defined metadata to organize your Indexes.

network

val network: Output<String>? = null

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.

project

val project: Output<String>? = null

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

publicEndpointEnabled

val publicEndpointEnabled: Output<Boolean>? = null

If true, the deployed index will be accessible through public endpoint.

region

val region: Output<String>? = null

The region of the index endpoint. eg us-central1