com.pulumi.gcp.vertex.kotlin.AiFeatureStore.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.AiFeatureStoreEncryptionSpec
import com.pulumi.gcp.vertex.kotlin.outputs.AiFeatureStoreOnlineServingConfig
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.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
import com.pulumi.gcp.vertex.kotlin.outputs.AiFeatureStoreEncryptionSpec.Companion.toKotlin as aiFeatureStoreEncryptionSpecToKotlin
import com.pulumi.gcp.vertex.kotlin.outputs.AiFeatureStoreOnlineServingConfig.Companion.toKotlin as aiFeatureStoreOnlineServingConfigToKotlin
/**
* Builder for [AiFeatureStore].
*/
@PulumiTagMarker
public class AiFeatureStoreResourceBuilder internal constructor() {
public var name: String? = null
public var args: AiFeatureStoreArgs = AiFeatureStoreArgs()
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 AiFeatureStoreArgsBuilder.() -> Unit) {
val builder = AiFeatureStoreArgsBuilder()
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(): AiFeatureStore {
val builtJavaResource = com.pulumi.gcp.vertex.AiFeatureStore(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return AiFeatureStore(builtJavaResource)
}
}
/**
* A collection of DataItems and Annotations on them.
* To get more information about Featurestore, see:
* * [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/vertex-ai/docs)
* ## Example Usage
* ### Vertex Ai Featurestore
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const featurestore = new gcp.vertex.AiFeatureStore("featurestore", {
* name: "terraform",
* labels: {
* foo: "bar",
* },
* region: "us-central1",
* onlineServingConfig: {
* fixedNodeCount: 2,
* },
* encryptionSpec: {
* kmsKeyName: "kms-name",
* },
* forceDestroy: true,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* featurestore = gcp.vertex.AiFeatureStore("featurestore",
* name="terraform",
* labels={
* "foo": "bar",
* },
* region="us-central1",
* online_serving_config=gcp.vertex.AiFeatureStoreOnlineServingConfigArgs(
* fixed_node_count=2,
* ),
* encryption_spec=gcp.vertex.AiFeatureStoreEncryptionSpecArgs(
* kms_key_name="kms-name",
* ),
* force_destroy=True)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var featurestore = new Gcp.Vertex.AiFeatureStore("featurestore", new()
* {
* Name = "terraform",
* Labels =
* {
* { "foo", "bar" },
* },
* Region = "us-central1",
* OnlineServingConfig = new Gcp.Vertex.Inputs.AiFeatureStoreOnlineServingConfigArgs
* {
* FixedNodeCount = 2,
* },
* EncryptionSpec = new Gcp.Vertex.Inputs.AiFeatureStoreEncryptionSpecArgs
* {
* KmsKeyName = "kms-name",
* },
* ForceDestroy = 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.NewAiFeatureStore(ctx, "featurestore", &vertex.AiFeatureStoreArgs{
* Name: pulumi.String("terraform"),
* Labels: pulumi.StringMap{
* "foo": pulumi.String("bar"),
* },
* Region: pulumi.String("us-central1"),
* OnlineServingConfig: &vertex.AiFeatureStoreOnlineServingConfigArgs{
* FixedNodeCount: pulumi.Int(2),
* },
* EncryptionSpec: &vertex.AiFeatureStoreEncryptionSpecArgs{
* KmsKeyName: pulumi.String("kms-name"),
* },
* ForceDestroy: 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.AiFeatureStore;
* import com.pulumi.gcp.vertex.AiFeatureStoreArgs;
* import com.pulumi.gcp.vertex.inputs.AiFeatureStoreOnlineServingConfigArgs;
* import com.pulumi.gcp.vertex.inputs.AiFeatureStoreEncryptionSpecArgs;
* 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 featurestore = new AiFeatureStore("featurestore", AiFeatureStoreArgs.builder()
* .name("terraform")
* .labels(Map.of("foo", "bar"))
* .region("us-central1")
* .onlineServingConfig(AiFeatureStoreOnlineServingConfigArgs.builder()
* .fixedNodeCount(2)
* .build())
* .encryptionSpec(AiFeatureStoreEncryptionSpecArgs.builder()
* .kmsKeyName("kms-name")
* .build())
* .forceDestroy(true)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* featurestore:
* type: gcp:vertex:AiFeatureStore
* properties:
* name: terraform
* labels:
* foo: bar
* region: us-central1
* onlineServingConfig:
* fixedNodeCount: 2
* encryptionSpec:
* kmsKeyName: kms-name
* forceDestroy: true
* ```
*
* ### Vertex Ai Featurestore With Beta Fields
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const featurestore = new gcp.vertex.AiFeatureStore("featurestore", {
* name: "terraform2",
* labels: {
* foo: "bar",
* },
* region: "us-central1",
* onlineServingConfig: {
* fixedNodeCount: 2,
* },
* encryptionSpec: {
* kmsKeyName: "kms-name",
* },
* onlineStorageTtlDays: 30,
* forceDestroy: true,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* featurestore = gcp.vertex.AiFeatureStore("featurestore",
* name="terraform2",
* labels={
* "foo": "bar",
* },
* region="us-central1",
* online_serving_config=gcp.vertex.AiFeatureStoreOnlineServingConfigArgs(
* fixed_node_count=2,
* ),
* encryption_spec=gcp.vertex.AiFeatureStoreEncryptionSpecArgs(
* kms_key_name="kms-name",
* ),
* online_storage_ttl_days=30,
* force_destroy=True)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var featurestore = new Gcp.Vertex.AiFeatureStore("featurestore", new()
* {
* Name = "terraform2",
* Labels =
* {
* { "foo", "bar" },
* },
* Region = "us-central1",
* OnlineServingConfig = new Gcp.Vertex.Inputs.AiFeatureStoreOnlineServingConfigArgs
* {
* FixedNodeCount = 2,
* },
* EncryptionSpec = new Gcp.Vertex.Inputs.AiFeatureStoreEncryptionSpecArgs
* {
* KmsKeyName = "kms-name",
* },
* OnlineStorageTtlDays = 30,
* ForceDestroy = 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.NewAiFeatureStore(ctx, "featurestore", &vertex.AiFeatureStoreArgs{
* Name: pulumi.String("terraform2"),
* Labels: pulumi.StringMap{
* "foo": pulumi.String("bar"),
* },
* Region: pulumi.String("us-central1"),
* OnlineServingConfig: &vertex.AiFeatureStoreOnlineServingConfigArgs{
* FixedNodeCount: pulumi.Int(2),
* },
* EncryptionSpec: &vertex.AiFeatureStoreEncryptionSpecArgs{
* KmsKeyName: pulumi.String("kms-name"),
* },
* OnlineStorageTtlDays: pulumi.Int(30),
* ForceDestroy: 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.AiFeatureStore;
* import com.pulumi.gcp.vertex.AiFeatureStoreArgs;
* import com.pulumi.gcp.vertex.inputs.AiFeatureStoreOnlineServingConfigArgs;
* import com.pulumi.gcp.vertex.inputs.AiFeatureStoreEncryptionSpecArgs;
* 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 featurestore = new AiFeatureStore("featurestore", AiFeatureStoreArgs.builder()
* .name("terraform2")
* .labels(Map.of("foo", "bar"))
* .region("us-central1")
* .onlineServingConfig(AiFeatureStoreOnlineServingConfigArgs.builder()
* .fixedNodeCount(2)
* .build())
* .encryptionSpec(AiFeatureStoreEncryptionSpecArgs.builder()
* .kmsKeyName("kms-name")
* .build())
* .onlineStorageTtlDays(30)
* .forceDestroy(true)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* featurestore:
* type: gcp:vertex:AiFeatureStore
* properties:
* name: terraform2
* labels:
* foo: bar
* region: us-central1
* onlineServingConfig:
* fixedNodeCount: 2
* encryptionSpec:
* kmsKeyName: kms-name
* onlineStorageTtlDays: 30
* forceDestroy: true
* ```
*
* ### Vertex Ai Featurestore Scaling
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const featurestore = new gcp.vertex.AiFeatureStore("featurestore", {
* name: "terraform3",
* labels: {
* foo: "bar",
* },
* region: "us-central1",
* onlineServingConfig: {
* scaling: {
* minNodeCount: 2,
* maxNodeCount: 10,
* },
* },
* encryptionSpec: {
* kmsKeyName: "kms-name",
* },
* forceDestroy: true,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* featurestore = gcp.vertex.AiFeatureStore("featurestore",
* name="terraform3",
* labels={
* "foo": "bar",
* },
* region="us-central1",
* online_serving_config=gcp.vertex.AiFeatureStoreOnlineServingConfigArgs(
* scaling=gcp.vertex.AiFeatureStoreOnlineServingConfigScalingArgs(
* min_node_count=2,
* max_node_count=10,
* ),
* ),
* encryption_spec=gcp.vertex.AiFeatureStoreEncryptionSpecArgs(
* kms_key_name="kms-name",
* ),
* force_destroy=True)
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Gcp = Pulumi.Gcp;
* return await Deployment.RunAsync(() =>
* {
* var featurestore = new Gcp.Vertex.AiFeatureStore("featurestore", new()
* {
* Name = "terraform3",
* Labels =
* {
* { "foo", "bar" },
* },
* Region = "us-central1",
* OnlineServingConfig = new Gcp.Vertex.Inputs.AiFeatureStoreOnlineServingConfigArgs
* {
* Scaling = new Gcp.Vertex.Inputs.AiFeatureStoreOnlineServingConfigScalingArgs
* {
* MinNodeCount = 2,
* MaxNodeCount = 10,
* },
* },
* EncryptionSpec = new Gcp.Vertex.Inputs.AiFeatureStoreEncryptionSpecArgs
* {
* KmsKeyName = "kms-name",
* },
* ForceDestroy = 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.NewAiFeatureStore(ctx, "featurestore", &vertex.AiFeatureStoreArgs{
* Name: pulumi.String("terraform3"),
* Labels: pulumi.StringMap{
* "foo": pulumi.String("bar"),
* },
* Region: pulumi.String("us-central1"),
* OnlineServingConfig: &vertex.AiFeatureStoreOnlineServingConfigArgs{
* Scaling: &vertex.AiFeatureStoreOnlineServingConfigScalingArgs{
* MinNodeCount: pulumi.Int(2),
* MaxNodeCount: pulumi.Int(10),
* },
* },
* EncryptionSpec: &vertex.AiFeatureStoreEncryptionSpecArgs{
* KmsKeyName: pulumi.String("kms-name"),
* },
* ForceDestroy: 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.AiFeatureStore;
* import com.pulumi.gcp.vertex.AiFeatureStoreArgs;
* import com.pulumi.gcp.vertex.inputs.AiFeatureStoreOnlineServingConfigArgs;
* import com.pulumi.gcp.vertex.inputs.AiFeatureStoreOnlineServingConfigScalingArgs;
* import com.pulumi.gcp.vertex.inputs.AiFeatureStoreEncryptionSpecArgs;
* 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 featurestore = new AiFeatureStore("featurestore", AiFeatureStoreArgs.builder()
* .name("terraform3")
* .labels(Map.of("foo", "bar"))
* .region("us-central1")
* .onlineServingConfig(AiFeatureStoreOnlineServingConfigArgs.builder()
* .scaling(AiFeatureStoreOnlineServingConfigScalingArgs.builder()
* .minNodeCount(2)
* .maxNodeCount(10)
* .build())
* .build())
* .encryptionSpec(AiFeatureStoreEncryptionSpecArgs.builder()
* .kmsKeyName("kms-name")
* .build())
* .forceDestroy(true)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* featurestore:
* type: gcp:vertex:AiFeatureStore
* properties:
* name: terraform3
* labels:
* foo: bar
* region: us-central1
* onlineServingConfig:
* scaling:
* minNodeCount: 2
* maxNodeCount: 10
* encryptionSpec:
* kmsKeyName: kms-name
* forceDestroy: true
* ```
*
* ## Import
* Featurestore can be imported using any of these accepted formats:
* * `projects/{{project}}/locations/{{region}}/featurestores/{{name}}`
* * `{{project}}/{{region}}/{{name}}`
* * `{{region}}/{{name}}`
* * `{{name}}`
* When using the `pulumi import` command, Featurestore can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:vertex/aiFeatureStore:AiFeatureStore default projects/{{project}}/locations/{{region}}/featurestores/{{name}}
* ```
* ```sh
* $ pulumi import gcp:vertex/aiFeatureStore:AiFeatureStore default {{project}}/{{region}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:vertex/aiFeatureStore:AiFeatureStore default {{region}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:vertex/aiFeatureStore:AiFeatureStore default {{name}}
* ```
*/
public class AiFeatureStore internal constructor(
override val javaResource: com.pulumi.gcp.vertex.AiFeatureStore,
) : KotlinCustomResource(javaResource, AiFeatureStoreMapper) {
/**
* The timestamp of when the featurestore 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 })
/**
* 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>
get() = javaResource.effectiveLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* If set, both of the online and offline data storage will be secured by this key.
* Structure is documented below.
*/
public val encryptionSpec: Output?
get() = javaResource.encryptionSpec().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> aiFeatureStoreEncryptionSpecToKotlin(args0) })
}).orElse(null)
})
/**
* Used to perform consistent read-modify-write updates.
*/
public val etag: Output
get() = javaResource.etag().applyValue({ args0 -> args0 })
/**
* If set to true, any EntityTypes and Features for this Featurestore will also be deleted
*/
public val forceDestroy: Output?
get() = javaResource.forceDestroy().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A set of key/value label pairs to assign to this Featurestore.
* **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.
*/
public val labels: Output>?
get() = javaResource.labels().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The name of the Featurestore. This value may be up to 60 characters, and valid characters are [a-z0-9_]. The first character cannot be a number.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Config for online serving resources.
* Structure is documented below.
*/
public val onlineServingConfig: Output?
get() = javaResource.onlineServingConfig().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> aiFeatureStoreOnlineServingConfigToKotlin(args0) })
}).orElse(null)
})
/**
* TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than onlineStorageTtlDays since the feature generation time. Note that onlineStorageTtlDays should be less than or equal to offlineStorageTtlDays for each EntityType under a featurestore. If not set, default to 4000 days
*/
public val onlineStorageTtlDays: Output?
get() = javaResource.onlineStorageTtlDays().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
public val project: Output
get() = javaResource.project().applyValue({ args0 -> args0 })
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
public val pulumiLabels: Output>
get() = javaResource.pulumiLabels().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The region of the dataset. eg us-central1
*/
public val region: Output
get() = javaResource.region().applyValue({ args0 -> args0 })
/**
* The timestamp of when the featurestore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
public val updateTime: Output
get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}
public object AiFeatureStoreMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.vertex.AiFeatureStore::class == javaResource::class
override fun map(javaResource: Resource): AiFeatureStore = AiFeatureStore(
javaResource as
com.pulumi.gcp.vertex.AiFeatureStore,
)
}
/**
* @see [AiFeatureStore].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [AiFeatureStore].
*/
public suspend fun aiFeatureStore(
name: String,
block: suspend AiFeatureStoreResourceBuilder.() -> Unit,
): AiFeatureStore {
val builder = AiFeatureStoreResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [AiFeatureStore].
* @param name The _unique_ name of the resulting resource.
*/
public fun aiFeatureStore(name: String): AiFeatureStore {
val builder = AiFeatureStoreResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy