@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
293 lines • 12.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Configuration for Firebase AI Logic.
*
* > **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 Config, see:
*
* * [API documentation](https://firebase.google.com/docs/reference/ai-logic/rest)
* * How-to Guides
* * [Official Documentation](https://firebase.google.com/docs/ai-logic)
*
* > **Note:** All arguments marked as write-only values will not be stored in the state: `generative_language_config.api_key_wo`.
* Read more about Write-only Arguments.
*
* ## Example Usage
*
* ### Firebaseailogic Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as time from "@pulumiverse/time";
*
* const project = new gcp.organizations.Project("project", {
* projectId: "basic",
* name: "Firebase Project",
* orgId: "123456789",
* billingAccount: "000000-0000000-0000000-000000",
* deletionPolicy: "DELETE",
* });
* const _default = new gcp.firebase.Project("default", {project: project.projectId});
* const firebase = new gcp.projects.Service("firebase", {
* project: project.projectId,
* service: "firebase.googleapis.com",
* });
* const ailogic = new gcp.projects.Service("ailogic", {
* project: project.projectId,
* service: "firebasevertexai.googleapis.com",
* });
* // It takes a while for permissions to propagate
* // If your Terraform setup has a retry mechanism, this wait is unnecessary
* const wait30s = new time.Sleep("wait_30s", {createDuration: "30s"}, {
* dependsOn: [
* ailogic,
* firebase,
* ],
* });
* const defaultAiLogicConfig = new gcp.firebase.AiLogicConfig("default", {
* project: _default.project,
* location: "global",
* }, {
* dependsOn: [wait30s],
* });
* ```
* ### Firebaseailogic Config Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as time from "@pulumiverse/time";
*
* const project = new gcp.organizations.Project("project", {
* projectId: "full",
* name: "Firebase Project",
* orgId: "123456789",
* billingAccount: "000000-0000000-0000000-000000",
* deletionPolicy: "DELETE",
* });
* const _default = new gcp.firebase.Project("default", {project: project.projectId});
* const firebase = new gcp.projects.Service("firebase", {
* project: project.projectId,
* service: "firebase.googleapis.com",
* });
* const ailogic = new gcp.projects.Service("ailogic", {
* project: project.projectId,
* service: "firebasevertexai.googleapis.com",
* });
* const gemini = new gcp.projects.ApiKey("gemini", {
* project: project.projectId,
* name: "gemini-api-key",
* displayName: "Gemini Developer API key",
* restrictions: {
* apiTargets: [{
* service: "generativelanguage.googleapis.com",
* }],
* },
* });
* // It takes a while for permissions to propagate
* // If your Terraform setup has a retry mechanism, this wait is unnecessary
* const wait30s = new time.Sleep("wait_30s", {createDuration: "30s"}, {
* dependsOn: [
* ailogic,
* firebase,
* ],
* });
* const defaultAiLogicConfig = new gcp.firebase.AiLogicConfig("default", {
* project: _default.project,
* location: "global",
* generativeLanguageConfig: {
* apiKey: gemini.keyString,
* },
* telemetryConfig: {
* mode: "ALL",
* samplingRate: 1,
* },
* trafficFilter: {
* templateOnly: true,
* },
* }, {
* dependsOn: [wait30s],
* });
* ```
*
* ## Import
*
* Config can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/config`
* * `{{project}}/{{location}}`
* * `{{location}}`
*
* When using the `pulumi import` command, Config can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:firebase/aiLogicConfig:AiLogicConfig default projects/{{project}}/locations/{{location}}/config
* $ pulumi import gcp:firebase/aiLogicConfig:AiLogicConfig default {{project}}/{{location}}
* $ pulumi import gcp:firebase/aiLogicConfig:AiLogicConfig default {{location}}
* ```
*/
export declare class AiLogicConfig extends pulumi.CustomResource {
/**
* Get an existing AiLogicConfig 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?: AiLogicConfigState, opts?: pulumi.CustomResourceOptions): AiLogicConfig;
/**
* Returns true if the given object is an instance of AiLogicConfig. 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 AiLogicConfig;
/**
* 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>;
/**
* Configuration for using the Gemini Developer API via Firebase AI Logic.
* When using the Gemini Developer API via Firebase AI Logic, a separate Gemini
* API key is stored in this configuration *on the server* so that you do
* **not** add your Gemini API key directly into your app's codebase.
* Structure is documented below.
*/
readonly generativeLanguageConfig: pulumi.Output<outputs.firebase.AiLogicConfigGenerativeLanguageConfig | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* Identifier. The resource name of the config.
* Format: projects/{project}/locations/{location}/config
*/
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>;
/**
* Configuration for telemetry.
* Telemetry is the collection of metrics, logs, and traces recorded by the
* Firebase AI Logic backend.
* Structure is documented below.
*/
readonly telemetryConfig: pulumi.Output<outputs.firebase.AiLogicConfigTelemetryConfig | undefined>;
/**
* Configuration for traffic filtering.
* Structure is documented below.
*/
readonly trafficFilter: pulumi.Output<outputs.firebase.AiLogicConfigTrafficFilter | undefined>;
/**
* Create a AiLogicConfig 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?: AiLogicConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AiLogicConfig resources.
*/
export interface AiLogicConfigState {
/**
* 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>;
/**
* Configuration for using the Gemini Developer API via Firebase AI Logic.
* When using the Gemini Developer API via Firebase AI Logic, a separate Gemini
* API key is stored in this configuration *on the server* so that you do
* **not** add your Gemini API key directly into your app's codebase.
* Structure is documented below.
*/
generativeLanguageConfig?: pulumi.Input<inputs.firebase.AiLogicConfigGenerativeLanguageConfig | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* Identifier. The resource name of the config.
* Format: projects/{project}/locations/{location}/config
*/
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>;
/**
* Configuration for telemetry.
* Telemetry is the collection of metrics, logs, and traces recorded by the
* Firebase AI Logic backend.
* Structure is documented below.
*/
telemetryConfig?: pulumi.Input<inputs.firebase.AiLogicConfigTelemetryConfig | undefined>;
/**
* Configuration for traffic filtering.
* Structure is documented below.
*/
trafficFilter?: pulumi.Input<inputs.firebase.AiLogicConfigTrafficFilter | undefined>;
}
/**
* The set of arguments for constructing a AiLogicConfig resource.
*/
export interface AiLogicConfigArgs {
/**
* 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>;
/**
* Configuration for using the Gemini Developer API via Firebase AI Logic.
* When using the Gemini Developer API via Firebase AI Logic, a separate Gemini
* API key is stored in this configuration *on the server* so that you do
* **not** add your Gemini API key directly into your app's codebase.
* Structure is documented below.
*/
generativeLanguageConfig?: pulumi.Input<inputs.firebase.AiLogicConfigGenerativeLanguageConfig | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: 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>;
/**
* Configuration for telemetry.
* Telemetry is the collection of metrics, logs, and traces recorded by the
* Firebase AI Logic backend.
* Structure is documented below.
*/
telemetryConfig?: pulumi.Input<inputs.firebase.AiLogicConfigTelemetryConfig | undefined>;
/**
* Configuration for traffic filtering.
* Structure is documented below.
*/
trafficFilter?: pulumi.Input<inputs.firebase.AiLogicConfigTrafficFilter | undefined>;
}
//# sourceMappingURL=aiLogicConfig.d.ts.map