AiFeatureStore class

A collection of DataItems and Annotations on them.

To get more information about Featurestore, see:

Example Usage

Vertex Ai Featurestore

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,
});

import pulumi
import pulumi_gcp as gcp

featurestore = gcp.vertex.AiFeatureStore("featurestore",
    name="terraform",
    labels={
        "foo": "bar",
    },
    region="us-central1",
    online_serving_config={
        "fixed_node_count": 2,
    },
    encryption_spec={
        "kms_key_name": "kms-name",
    },
    force_destroy=True)

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,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_vertex_aifeaturestore" "featurestore" {
  name = "terraform"
  labels = {
    "foo" = "bar"
  }
  region = "us-central1"
  online_serving_config = {
    fixed_node_count = 2
  }
  encryption_spec = {
    kms_key_name = "kms-name"
  }
  force_destroy = true
}

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.ArrayList;
import java.util.Arrays;
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());

    }
}

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

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,
});

import pulumi
import pulumi_gcp as gcp

featurestore = gcp.vertex.AiFeatureStore("featurestore",
    name="terraform2",
    labels={
        "foo": "bar",
    },
    region="us-central1",
    online_serving_config={
        "fixed_node_count": 2,
    },
    encryption_spec={
        "kms_key_name": "kms-name",
    },
    online_storage_ttl_days=30,
    force_destroy=True)

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,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_vertex_aifeaturestore" "featurestore" {
  name = "terraform2"
  labels = {
    "foo" = "bar"
  }
  region = "us-central1"
  online_serving_config = {
    fixed_node_count = 2
  }
  encryption_spec = {
    kms_key_name = "kms-name"
  }
  online_storage_ttl_days = 30
  force_destroy           = true
}

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.ArrayList;
import java.util.Arrays;
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());

    }
}

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

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,
});

import pulumi
import pulumi_gcp as gcp

featurestore = gcp.vertex.AiFeatureStore("featurestore",
    name="terraform3",
    labels={
        "foo": "bar",
    },
    region="us-central1",
    online_serving_config={
        "scaling": {
            "min_node_count": 2,
            "max_node_count": 10,
        },
    },
    encryption_spec={
        "kms_key_name": "kms-name",
    },
    force_destroy=True)

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,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_vertex_aifeaturestore" "featurestore" {
  name = "terraform3"
  labels = {
    "foo" = "bar"
  }
  region = "us-central1"
  online_serving_config = {
    scaling = {
      min_node_count = 2
      max_node_count = 10
    }
  }
  encryption_spec = {
    kms_key_name = "kms-name"
  }
  force_destroy = true
}

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.ArrayList;
import java.util.Arrays;
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());

    }
}

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:

$ pulumi import gcp:vertex/aiFeatureStore:AiFeatureStore default projects/{{project}}/locations/{{region}}/featurestores/{{name}}
$ pulumi import gcp:vertex/aiFeatureStore:AiFeatureStore default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:vertex/aiFeatureStore:AiFeatureStore default {{region}}/{{name}}
$ pulumi import gcp:vertex/aiFeatureStore:AiFeatureStore default {{name}}

Constructors

AiFeatureStore(String name, {AiFeatureStoreArgs? args, CustomResourceOptions? options}): Creates a new AiFeatureStore. name The Pulumi resource name. args Arguments used to configure this AiFeatureStore. The set of arguments for AiFeatureStore. options Resource options controlling this resource's behavior.
AiFeatureStore.reference(String urn): Creates a typed reference to an existing AiFeatureStore resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: The timestamp of when the featurestore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
latefinal
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
effectiveLabels ↔ Output<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.
latefinal
encryptionSpec ↔ Output<AiFeatureStoreEncryptionSpec?>: If set, both of the online and offline data storage will be secured by this key. Structure is documented below.
latefinal
etag ↔ Output<String>: Used to perform consistent read-modify-write updates.
latefinal
forceDestroy ↔ Output<bool?>: If set to true, any EntityTypes and Features for this Featurestore will also be deleted
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
labels ↔ Output<Map<String, String>?>: A set of key/value label pairs to assign to this Featurestore.
latefinal
name ↔ Output<String>: 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.
latefinal
onlineServingConfig ↔ Output<AiFeatureStoreOnlineServingConfig?>: Config for online serving resources. Structure is documented below.
latefinal
onlineStorageTtlDays ↔ Output<int?>: (Optional, Beta) 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
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
pulumiLabels ↔ Output<Map<String, String>>: The combination of labels configured directly on the resource and default labels configured on the provider.
latefinal
region ↔ Output<String>: The region of the dataset. eg us-central1
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>: The timestamp of when the featurestore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AiFeatureStoreState? state, CustomResourceOptions? options}) → AiFeatureStore: Gets an existing AiFeatureStore resource's state with the given name and id.