Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. vertex
  5. AiMetadataStore
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.vertex.AiMetadataStore

Explore with Pulumi AI

gcp logo
Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
pulumi/pulumi-gcp

    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")

    package main

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

    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 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.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 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

    Create AiMetadataStore Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AiMetadataStore(name: string, args?: AiMetadataStoreArgs, opts?: CustomResourceOptions);
    @overload
def AiMetadataStore(resource_name: str,
                    args: Optional[AiMetadataStoreArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def AiMetadataStore(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    description: Optional[str] = None,
                    encryption_spec: Optional[AiMetadataStoreEncryptionSpecArgs] = None,
                    name: Optional[str] = None,
                    project: Optional[str] = None,
                    region: Optional[str] = None)
    func NewAiMetadataStore(ctx *Context, name string, args *AiMetadataStoreArgs, opts ...ResourceOption) (*AiMetadataStore, error)
    public AiMetadataStore(string name, AiMetadataStoreArgs? args = null, CustomResourceOptions? opts = null)
    public AiMetadataStore(String name, AiMetadataStoreArgs args)
public AiMetadataStore(String name, AiMetadataStoreArgs args, CustomResourceOptions options)

    type: gcp:vertex:AiMetadataStore
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AiMetadataStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AiMetadataStoreArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AiMetadataStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AiMetadataStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AiMetadataStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var aiMetadataStoreResource = new Gcp.Vertex.AiMetadataStore("aiMetadataStoreResource", new()
{
    Description = "string",
    EncryptionSpec = new Gcp.Vertex.Inputs.AiMetadataStoreEncryptionSpecArgs
    {
        KmsKeyName = "string",
    },
    Name = "string",
    Project = "string",
    Region = "string",
});

    example, err := vertex.NewAiMetadataStore(ctx, "aiMetadataStoreResource", &vertex.AiMetadataStoreArgs{
	Description: pulumi.String("string"),
	EncryptionSpec: &vertex.AiMetadataStoreEncryptionSpecArgs{
		KmsKeyName: pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
	Region:  pulumi.String("string"),
})

    var aiMetadataStoreResource = new AiMetadataStore("aiMetadataStoreResource", AiMetadataStoreArgs.builder()
    .description("string")
    .encryptionSpec(AiMetadataStoreEncryptionSpecArgs.builder()
        .kmsKeyName("string")
        .build())
    .name("string")
    .project("string")
    .region("string")
    .build());

    ai_metadata_store_resource = gcp.vertex.AiMetadataStore("aiMetadataStoreResource",
    description="string",
    encryption_spec={
        "kms_key_name": "string",
    },
    name="string",
    project="string",
    region="string")

    const aiMetadataStoreResource = new gcp.vertex.AiMetadataStore("aiMetadataStoreResource", {
    description: "string",
    encryptionSpec: {
        kmsKeyName: "string",
    },
    name: "string",
    project: "string",
    region: "string",
});

    type: gcp:vertex:AiMetadataStore
properties:
    description: string
    encryptionSpec:
        kmsKeyName: string
    name: string
    project: string
    region: string

    AiMetadataStore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AiMetadataStore resource accepts the following input properties:

    Description string
    Description of the MetadataStore.
    EncryptionSpec 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.
    Name 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    The region of the Metadata Store. eg us-central1
    Description string
    Description of the MetadataStore.
    EncryptionSpec AiMetadataStoreEncryptionSpecArgs
    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.
    Name 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    The region of the Metadata Store. eg us-central1
    description String
    Description of the MetadataStore.
    encryptionSpec 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.
    name 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    The region of the Metadata Store. eg us-central1
    description string
    Description of the MetadataStore.
    encryptionSpec 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.
    name 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    The region of the Metadata Store. eg us-central1
    description str
    Description of the MetadataStore.
    encryption_spec AiMetadataStoreEncryptionSpecArgs
    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.
    name str
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    The region of the Metadata Store. eg us-central1
    description String
    Description of the MetadataStore.
    encryptionSpec Property Map
    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.
    name 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    The region of the Metadata Store. eg us-central1

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AiMetadataStore resource produces the following output properties:

    CreateTime string
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    Id string
    The provider-assigned unique ID for this managed resource.
    States List<AiMetadataStoreState>
    State information of the MetadataStore. Structure is documented below.
    UpdateTime string
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    CreateTime string
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    Id string
    The provider-assigned unique ID for this managed resource.
    States []AiMetadataStoreStateType
    State information of the MetadataStore. Structure is documented below.
    UpdateTime string
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    id String
    The provider-assigned unique ID for this managed resource.
    states List<AiMetadataStoreState>
    State information of the MetadataStore. Structure is documented below.
    updateTime String
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime string
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    id string
    The provider-assigned unique ID for this managed resource.
    states AiMetadataStoreState[]
    State information of the MetadataStore. Structure is documented below.
    updateTime string
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    create_time str
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    id str
    The provider-assigned unique ID for this managed resource.
    states Sequence[AiMetadataStoreState]
    State information of the MetadataStore. Structure is documented below.
    update_time str
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    id String
    The provider-assigned unique ID for this managed resource.
    states List<Property Map>
    State information of the MetadataStore. Structure is documented below.
    updateTime String
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

    Look up Existing AiMetadataStore Resource

    Get an existing AiMetadataStore resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AiMetadataStoreState, opts?: CustomResourceOptions): AiMetadataStore
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        encryption_spec: Optional[AiMetadataStoreEncryptionSpecArgs] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        region: Optional[str] = None,
        states: Optional[Sequence[AiMetadataStoreStateArgs]] = None,
        update_time: Optional[str] = None) -> AiMetadataStore
    func GetAiMetadataStore(ctx *Context, name string, id IDInput, state *AiMetadataStoreState, opts ...ResourceOption) (*AiMetadataStore, error)
    public static AiMetadataStore Get(string name, Input<string> id, AiMetadataStoreState? state, CustomResourceOptions? opts = null)
    public static AiMetadataStore get(String name, Output<String> id, AiMetadataStoreState state, CustomResourceOptions options)
    resources:  _:    type: gcp:vertex:AiMetadataStore    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreateTime string
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    Description string
    Description of the MetadataStore.
    EncryptionSpec 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.
    Name 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    The region of the Metadata Store. eg us-central1
    States List<AiMetadataStoreState>
    State information of the MetadataStore. Structure is documented below.
    UpdateTime string
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    CreateTime string
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    Description string
    Description of the MetadataStore.
    EncryptionSpec AiMetadataStoreEncryptionSpecArgs
    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.
    Name 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Region string
    The region of the Metadata Store. eg us-central1
    States []AiMetadataStoreStateTypeArgs
    State information of the MetadataStore. Structure is documented below.
    UpdateTime string
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    description String
    Description of the MetadataStore.
    encryptionSpec 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.
    name 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    The region of the Metadata Store. eg us-central1
    states List<AiMetadataStoreState>
    State information of the MetadataStore. Structure is documented below.
    updateTime String
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime string
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    description string
    Description of the MetadataStore.
    encryptionSpec 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.
    name 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region string
    The region of the Metadata Store. eg us-central1
    states AiMetadataStoreState[]
    State information of the MetadataStore. Structure is documented below.
    updateTime string
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    create_time str
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    description str
    Description of the MetadataStore.
    encryption_spec AiMetadataStoreEncryptionSpecArgs
    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.
    name str
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region str
    The region of the Metadata Store. eg us-central1
    states Sequence[AiMetadataStoreStateArgs]
    State information of the MetadataStore. Structure is documented below.
    update_time str
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    createTime String
    The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
    description String
    Description of the MetadataStore.
    encryptionSpec Property Map
    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.
    name 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    region String
    The region of the Metadata Store. eg us-central1
    states List<Property Map>
    State information of the MetadataStore. Structure is documented below.
    updateTime String
    The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.

    Supporting Types

    AiMetadataStoreEncryptionSpec, AiMetadataStoreEncryptionSpecArgs

    KmsKeyName string
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    KmsKeyName string
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kmsKeyName String
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kmsKeyName string
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kms_key_name str
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.
    kmsKeyName String
    Required. The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the resource is created.

    AiMetadataStoreState, AiMetadataStoreStateArgs

    DiskUtilizationBytes string
    (Output) The disk utilization of the MetadataStore in bytes.
    DiskUtilizationBytes string
    (Output) The disk utilization of the MetadataStore in bytes.
    diskUtilizationBytes String
    (Output) The disk utilization of the MetadataStore in bytes.
    diskUtilizationBytes string
    (Output) The disk utilization of the MetadataStore in bytes.
    disk_utilization_bytes str
    (Output) The disk utilization of the MetadataStore in bytes.
    diskUtilizationBytes String
    (Output) The disk utilization of the MetadataStore in bytes.

    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}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi
    pulumi/pulumi-gcp