@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
185 lines (184 loc) • 7.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Instance of a metadata store. Contains a set of metadata that can be queried.
*
* To get more information about MetadataStore, see:
*
* * [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.metadataStores)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/vertex-ai/docs)
*
* ## Example Usage
*
* ### Vertex Ai Metadata Store
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ pulumi import gcp:vertex/aiMetadataStore:AiMetadataStore default projects/{{project}}/locations/{{region}}/metadataStores/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:vertex/aiMetadataStore:AiMetadataStore default {{project}}/{{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:vertex/aiMetadataStore:AiMetadataStore default {{region}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:vertex/aiMetadataStore:AiMetadataStore default {{name}}
* ```
*/
export declare class AiMetadataStore extends pulumi.CustomResource {
/**
* Get an existing AiMetadataStore resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AiMetadataStoreState, opts?: pulumi.CustomResourceOptions): AiMetadataStore;
/**
* Returns true if the given object is an instance of AiMetadataStore. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AiMetadataStore;
/**
* The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
readonly createTime: pulumi.Output<string>;
/**
* Description of the MetadataStore.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly encryptionSpec: pulumi.Output<outputs.vertex.AiMetadataStoreEncryptionSpec | undefined>;
/**
* 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.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The region of the Metadata Store. eg us-central1
*/
readonly region: pulumi.Output<string>;
/**
* State information of the MetadataStore.
* Structure is documented below.
*/
readonly states: pulumi.Output<outputs.vertex.AiMetadataStoreState[]>;
/**
* The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a AiMetadataStore resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: AiMetadataStoreArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AiMetadataStore resources.
*/
export interface AiMetadataStoreState {
/**
* The timestamp of when the MetadataStore was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
createTime?: pulumi.Input<string>;
/**
* Description of the MetadataStore.
*/
description?: pulumi.Input<string>;
/**
* 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.
*/
encryptionSpec?: pulumi.Input<inputs.vertex.AiMetadataStoreEncryptionSpec>;
/**
* 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.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The region of the Metadata Store. eg us-central1
*/
region?: pulumi.Input<string>;
/**
* State information of the MetadataStore.
* Structure is documented below.
*/
states?: pulumi.Input<pulumi.Input<inputs.vertex.AiMetadataStoreState>[]>;
/**
* The timestamp of when the MetadataStore was last updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AiMetadataStore resource.
*/
export interface AiMetadataStoreArgs {
/**
* Description of the MetadataStore.
*/
description?: pulumi.Input<string>;
/**
* 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.
*/
encryptionSpec?: pulumi.Input<inputs.vertex.AiMetadataStoreEncryptionSpec>;
/**
* 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.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The region of the Metadata Store. eg us-central1
*/
region?: pulumi.Input<string>;
}