@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
168 lines • 6.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A resource that manages the lock state of a PromptTemplate.
* When this resource is created, the template is locked.
* When this resource is deleted, the template is unlocked.
*
* > **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.
*
* ## Example Usage
*
* ### Firebaseailogic Prompt Template Lock Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const basic = new gcp.firebase.AiLogicPromptTemplate("basic", {
* location: "global",
* templateId: "lock-template",
* templateString: `---
* model: googleai/gemini-1.5-flash
* ---
* Hello World
* `,
* });
* const basicLock = new gcp.firebase.AiLogicPromptTemplateLock("basic_lock", {
* location: basic.location,
* templateId: basic.templateId,
* });
* ```
*
* ## Import
*
* PromptTemplateLock can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/templates/{{template_id}}`
* * `{{project}}/{{location}}/{{template_id}}`
* * `{{location}}/{{template_id}}`
*
* When using the `pulumi import` command, PromptTemplateLock can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:firebase/aiLogicPromptTemplateLock:AiLogicPromptTemplateLock default projects/{{project}}/locations/{{location}}/templates/{{template_id}}
* $ pulumi import gcp:firebase/aiLogicPromptTemplateLock:AiLogicPromptTemplateLock default {{project}}/{{location}}/{{template_id}}
* $ pulumi import gcp:firebase/aiLogicPromptTemplateLock:AiLogicPromptTemplateLock default {{location}}/{{template_id}}
* ```
*/
export declare class AiLogicPromptTemplateLock extends pulumi.CustomResource {
/**
* Get an existing AiLogicPromptTemplateLock 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?: AiLogicPromptTemplateLockState, opts?: pulumi.CustomResourceOptions): AiLogicPromptTemplateLock;
/**
* Returns true if the given object is an instance of AiLogicPromptTemplateLock. 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 AiLogicPromptTemplateLock;
/**
* 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.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The location of the prompt template.
*/
readonly location: pulumi.Output<string>;
/**
* Indicates if the prompt template is currently locked.
* This is verified against the server-side PromptTemplate resource.
*/
readonly locked: pulumi.Output<boolean>;
/**
* The resource name of the prompt template.
*/
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 ID of the prompt template.
*/
readonly templateId: pulumi.Output<string>;
/**
* Create a AiLogicPromptTemplateLock 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: AiLogicPromptTemplateLockArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AiLogicPromptTemplateLock resources.
*/
export interface AiLogicPromptTemplateLockState {
/**
* 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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The location of the prompt template.
*/
location?: pulumi.Input<string | undefined>;
/**
* Indicates if the prompt template is currently locked.
* This is verified against the server-side PromptTemplate resource.
*/
locked?: pulumi.Input<boolean | undefined>;
/**
* The resource name of the prompt template.
*/
name?: 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>;
/**
* The ID of the prompt template.
*/
templateId?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a AiLogicPromptTemplateLock resource.
*/
export interface AiLogicPromptTemplateLockArgs {
/**
* 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.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The location of the prompt template.
*/
location: 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 | undefined>;
/**
* The ID of the prompt template.
*/
templateId: pulumi.Input<string>;
}
//# sourceMappingURL=aiLogicPromptTemplateLock.d.ts.map