@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
279 lines (278 loc) • 10.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Feature Metadata information that describes an attribute of an entity type. For example, apple is an entity type, and color is a feature that describes apple.
*
* To get more information about FeaturestoreEntitytypeFeature, see:
*
* * [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores.entityTypes.features)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/vertex-ai/docs)
*
* ## Example Usage
*
* ### Vertex Ai Featurestore Entitytype Feature
*
* ```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,
* },
* });
* const entity = new gcp.vertex.AiFeatureStoreEntityType("entity", {
* name: "terraform",
* labels: {
* foo: "bar",
* },
* featurestore: featurestore.id,
* });
* const feature = new gcp.vertex.AiFeatureStoreEntityTypeFeature("feature", {
* name: "terraform",
* labels: {
* foo: "bar",
* },
* entitytype: entity.id,
* valueType: "INT64_ARRAY",
* });
* ```
* ### Vertex Ai Featurestore Entitytype Feature 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,
* },
* });
* const entity = new gcp.vertex.AiFeatureStoreEntityType("entity", {
* name: "terraform2",
* labels: {
* foo: "bar",
* },
* featurestore: featurestore.id,
* monitoringConfig: {
* snapshotAnalysis: {
* disabled: false,
* monitoringInterval: "86400s",
* },
* categoricalThresholdConfig: {
* value: 0.3,
* },
* numericalThresholdConfig: {
* value: 0.3,
* },
* },
* });
* const feature = new gcp.vertex.AiFeatureStoreEntityTypeFeature("feature", {
* name: "terraform2",
* labels: {
* foo: "bar",
* },
* entitytype: entity.id,
* valueType: "INT64_ARRAY",
* });
* ```
*
* ## Import
*
* FeaturestoreEntitytypeFeature can be imported using any of these accepted formats:
*
* * `{{entitytype}}/features/{{name}}`
*
* When using the `pulumi import` command, FeaturestoreEntitytypeFeature can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:vertex/aiFeatureStoreEntityTypeFeature:AiFeatureStoreEntityTypeFeature default {{entitytype}}/features/{{name}}
* ```
*/
export declare class AiFeatureStoreEntityTypeFeature extends pulumi.CustomResource {
/**
* Get an existing AiFeatureStoreEntityTypeFeature 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?: AiFeatureStoreEntityTypeFeatureState, opts?: pulumi.CustomResourceOptions): AiFeatureStoreEntityTypeFeature;
/**
* Returns true if the given object is an instance of AiFeatureStoreEntityTypeFeature. 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 AiFeatureStoreEntityTypeFeature;
/**
* The timestamp of when the entity type was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
readonly createTime: pulumi.Output<string>;
/**
* Description of the feature.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The name of the Featurestore to use, in the format projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entitytype}.
*
*
* - - -
*/
readonly entitytype: pulumi.Output<string>;
/**
* Used to perform consistent read-modify-write updates.
*/
readonly etag: pulumi.Output<string>;
/**
* A set of key/value label pairs to assign to the feature.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The name of the feature. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
*/
readonly name: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The region of the feature
*/
readonly region: pulumi.Output<string>;
/**
* The timestamp when the entity type was most recently updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Type of Feature value. Immutable. https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores.entityTypes.features#ValueType
*/
readonly valueType: pulumi.Output<string>;
/**
* Create a AiFeatureStoreEntityTypeFeature 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: AiFeatureStoreEntityTypeFeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AiFeatureStoreEntityTypeFeature resources.
*/
export interface AiFeatureStoreEntityTypeFeatureState {
/**
* The timestamp of when the entity type was created in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
createTime?: pulumi.Input<string>;
/**
* Description of the feature.
*/
description?: pulumi.Input<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the Featurestore to use, in the format projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entitytype}.
*
*
* - - -
*/
entitytype?: pulumi.Input<string>;
/**
* Used to perform consistent read-modify-write updates.
*/
etag?: pulumi.Input<string>;
/**
* A set of key/value label pairs to assign to the feature.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the feature. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
*/
name?: pulumi.Input<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The region of the feature
*/
region?: pulumi.Input<string>;
/**
* The timestamp when the entity type was most recently updated in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits.
*/
updateTime?: pulumi.Input<string>;
/**
* Type of Feature value. Immutable. https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores.entityTypes.features#ValueType
*/
valueType?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AiFeatureStoreEntityTypeFeature resource.
*/
export interface AiFeatureStoreEntityTypeFeatureArgs {
/**
* Description of the feature.
*/
description?: pulumi.Input<string>;
/**
* The name of the Featurestore to use, in the format projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entitytype}.
*
*
* - - -
*/
entitytype: pulumi.Input<string>;
/**
* A set of key/value label pairs to assign to the feature.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the feature. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.
*/
name?: pulumi.Input<string>;
/**
* Type of Feature value. Immutable. https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.featurestores.entityTypes.features#ValueType
*/
valueType: pulumi.Input<string>;
}