@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
129 lines • 5.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Enables a Model Garden publisher model for a project so that it can be
* deployed. This calls the synchronous
* `ModelGardenService.EnableModel` method, which checks that the prerequisites
* for the model are met (for example, a completed questionnaire and accepted
* consents, or an active Private Offer) before enabling it.
*
* > **Note:** The underlying API does not provide a way to disable a model
* once it has been enabled, so destroying this resource only removes it from
* Terraform state and does not affect the project's enablement status.
*
* > **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 ModelGardenEnableModel, see:
*
* * [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/projects.publishers.models/enableModel)
* * How-to Guides
* * [Overview of Model Garden](https://cloud.google.com/vertex-ai/generative-ai/docs/model-garden/explore-models)
* * [Use models in Model Garden](https://cloud.google.com/vertex-ai/generative-ai/docs/model-garden/use-models)
*
* ## Example Usage
*
* ### Vertex Ai Model Garden Enable Model Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const enable = new gcp.vertex.AiModelGardenEnableModel("enable", {publisherModelName: "publishers/google/models/paligemma@paligemma-224-float32"});
* ```
*
* ## Import
*
* This resource does not support import.
*/
export declare class AiModelGardenEnableModel extends pulumi.CustomResource {
/**
* Get an existing AiModelGardenEnableModel 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?: AiModelGardenEnableModelState, opts?: pulumi.CustomResourceOptions): AiModelGardenEnableModel;
/**
* Returns true if the given object is an instance of AiModelGardenEnableModel. 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 AiModelGardenEnableModel;
/**
* Output only. The result of the model enablement.
*/
readonly enablementState: 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>;
/**
* Output only. The publisher endpoint that the project is enabled for.
* Format:
* `projects/{project}/locations/{location}/publishers/{publisher}/models/{publisher_model}`.
*/
readonly publisherEndpoint: pulumi.Output<string>;
/**
* The resource name of the Model Garden publisher model to enable.
* Format: `publishers/{publisher}/models/{publisher_model}`, optionally
* with a version suffix, for example
* `publishers/google/models/paligemma@paligemma-224-float32`.
*/
readonly publisherModelName: pulumi.Output<string>;
/**
* Create a AiModelGardenEnableModel 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: AiModelGardenEnableModelArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AiModelGardenEnableModel resources.
*/
export interface AiModelGardenEnableModelState {
/**
* Output only. The result of the model enablement.
*/
enablementState?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Output only. The publisher endpoint that the project is enabled for.
* Format:
* `projects/{project}/locations/{location}/publishers/{publisher}/models/{publisher_model}`.
*/
publisherEndpoint?: pulumi.Input<string | undefined>;
/**
* The resource name of the Model Garden publisher model to enable.
* Format: `publishers/{publisher}/models/{publisher_model}`, optionally
* with a version suffix, for example
* `publishers/google/models/paligemma@paligemma-224-float32`.
*/
publisherModelName?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a AiModelGardenEnableModel resource.
*/
export interface AiModelGardenEnableModelArgs {
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The resource name of the Model Garden publisher model to enable.
* Format: `publishers/{publisher}/models/{publisher_model}`, optionally
* with a version suffix, for example
* `publishers/google/models/paligemma@paligemma-224-float32`.
*/
publisherModelName: pulumi.Input<string>;
}
//# sourceMappingURL=aiModelGardenEnableModel.d.ts.map