AiMetadataStore class

Instance of a metadata store. Contains a set of metadata that can be queried.

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

To get more information about MetadataStore, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Vertex Ai Metadata Store

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const store = new gcp.vertex.AiMetadataStore("store", {
    name: "test-store",
    description: "Store to test the terraform module",
    region: "us-central1",
});

import pulumi
import pulumi_gcp as gcp

store = gcp.vertex.AiMetadataStore("store",
    name="test-store",
    description="Store to test the terraform module",
    region="us-central1")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var store = new Gcp.Vertex.AiMetadataStore("store", new()
    {
        Name = "test-store",
        Description = "Store to test the terraform module",
        Region = "us-central1",
    });

});

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.NewAiMetadataStore(ctx, "store", &vertex.AiMetadataStoreArgs{
			Name:        pulumi.String("test-store"),
			Description: pulumi.String("Store to test the terraform module"),
			Region:      pulumi.String("us-central1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_vertex_aimetadatastore" "store" {
  name        = "test-store"
  description = "Store to test the terraform module"
  region      = "us-central1"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.vertex.AiMetadataStore;
import com.pulumi.gcp.vertex.AiMetadataStoreArgs;
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 store = new AiMetadataStore("store", AiMetadataStoreArgs.builder()
            .name("test-store")
            .description("Store to test the terraform module")
            .region("us-central1")
            .build());

    }
}

resources:
  store:
    type: gcp:vertex:AiMetadataStore
    properties:
      name: test-store
      description: Store to test the terraform module
      region: us-central1

Import

MetadataStore can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{region}}/metadataStores/{{name}}
• {{project}}/{{region}}/{{name}}
• {{region}}/{{name}}
• {{name}}

When using the pulumi import command, MetadataStore can be imported using one of the formats above. For example:

$ pulumi import gcp:vertex/aiMetadataStore:AiMetadataStore default projects/{{project}}/locations/{{region}}/metadataStores/{{name}}
$ pulumi import gcp:vertex/aiMetadataStore:AiMetadataStore default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:vertex/aiMetadataStore:AiMetadataStore default {{region}}/{{name}}
$ pulumi import gcp:vertex/aiMetadataStore:AiMetadataStore default {{name}}

Constructors

AiMetadataStore(String name, {AiMetadataStoreArgs? args, CustomResourceOptions? options})

Creates a new AiMetadataStore. name The Pulumi resource name. args Arguments used to configure this AiMetadataStore. The set of arguments for AiMetadataStore. options Resource options controlling this resource's behavior.

AiMetadataStore.reference(String urn)

Creates a typed reference to an existing AiMetadataStore resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

late, final

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.

late, final

description ↔ Output<String?>

Description of the MetadataStore.

late, final

encryptionSpec ↔ Output<AiMetadataStoreEncryptionSpec?>

Customer-managed encryption key spec for a MetadataStore. If set, this MetadataStore and all sub-resources of this MetadataStore will be secured by this key. Structure is documented below.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The name of the MetadataStore. This value may be up to 60 characters, and valid characters are a-z0-9_. The first character cannot be a number.

late, final

project ↔ Output<String>

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

late, final

region ↔ Output<String>

The region of the Metadata Store. eg us-central1

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

states ↔ Output<List<AiMetadataStoreState>>

State information of the MetadataStore. Structure is documented below.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

late, final

urn ↔ Output<String>

late, final, inherited

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, {AiMetadataStoreVertexState? state, CustomResourceOptions? options}) → AiMetadataStore

Gets an existing AiMetadataStore resource's state with the given name and id.