com.pulumi.gcp.vertex.kotlin.AiIndexEndpoint.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.vertex.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.vertex.kotlin.outputs.AiIndexEndpointPrivateServiceConnectConfig
import com.pulumi.gcp.vertex.kotlin.outputs.AiIndexEndpointPrivateServiceConnectConfig.Companion.toKotlin
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [AiIndexEndpoint].
*/
@PulumiTagMarker
public class AiIndexEndpointResourceBuilder internal constructor() {
public var name: String? = null
public var args: AiIndexEndpointArgs = AiIndexEndpointArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend AiIndexEndpointArgsBuilder.() -> Unit) {
val builder = AiIndexEndpointArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): AiIndexEndpoint {
val builtJavaResource = com.pulumi.gcp.vertex.AiIndexEndpoint(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return AiIndexEndpoint(builtJavaResource)
}
}
/**
* 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 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}`),
* });
* 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],
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* vertex_network = gcp.compute.Network("vertex_network", name="network-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}"))
* 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])
* ```
* ```csharp
* 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 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}";
* }),
* });
* 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,
* },
* });
* });
* ```
* ```go
* package main
* import (
* "fmt"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/servicenetworking"
* "github.com/pulumi/pulumi-gcp/sdk/v7/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
* }
* project, err := organizations.LookupProject(ctx, nil, 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),
* })
* 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
* }
* _, 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
* }
* return nil
* })
* }
* ```
* ```java
* 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.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.compute.GlobalAddress;
* import com.pulumi.gcp.compute.GlobalAddressArgs;
* import com.pulumi.gcp.servicenetworking.Connection;
* import com.pulumi.gcp.servicenetworking.ConnectionArgs;
* 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());
* 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());
* 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());
* }
* }
* ```
* ```yaml
* 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}
* 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: {}
* ```
*
* ### 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.number)],
* },
* });
* ```
* ```python
* 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=gcp.vertex.AiIndexEndpointPrivateServiceConnectConfigArgs(
* enable_private_service_connect=True,
* project_allowlists=[project.number],
* ))
* ```
* ```csharp
* 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.Number),
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
* "github.com/pulumi/pulumi-gcp/sdk/v7/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, nil, 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.Number),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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.number()))
* .build())
* .build());
* }
* }
* ```
* ```yaml
* 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.number}
* variables:
* project:
* fn::invoke:
* Function: gcp:organizations:getProject
* Arguments: {}
* ```
*
* ### 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,
* });
* ```
* ```python
* 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)
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ## 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}}
* ```
*/
public class AiIndexEndpoint internal constructor(
override val javaResource: com.pulumi.gcp.vertex.AiIndexEndpoint,
) : KotlinCustomResource(javaResource, AiIndexEndpointMapper) {
/**
* The timestamp of when the Index was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
public val createTime: Output
get() = javaResource.createTime().applyValue({ args0 -> args0 })
/**
* The description of the Index.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
* - - -
*/
public val displayName: Output
get() = javaResource.displayName().applyValue({ args0 -> args0 })
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output
© 2015 - 2024 Weber Informatics LLC | Privacy Policy