UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

277 lines • 11.5 kB
import * as pulumi from "@pulumi/pulumi"; /** * The resource for managing GeminiGcpEnablement settings for Admin Control. * * ## Example Usage * * ### Gemini Gemini Gcp Enablement Setting Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.gemini.GeminiGcpEnablementSetting("example", { * geminiGcpEnablementSettingId: "ls1-tf", * location: "global", * labels: { * my_key: "my_value", * }, * enableCustomerDataSharing: true, * webGroundingType: "WEB_GROUNDING_FOR_ENTERPRISE", * }); * ``` * * ## Import * * GeminiGcpEnablementSetting can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/geminiGcpEnablementSettings/{{gemini_gcp_enablement_setting_id}}` * * `{{project}}/{{location}}/{{gemini_gcp_enablement_setting_id}}` * * `{{location}}/{{gemini_gcp_enablement_setting_id}}` * * When using the `pulumi import` command, GeminiGcpEnablementSetting can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:gemini/geminiGcpEnablementSetting:GeminiGcpEnablementSetting default projects/{{project}}/locations/{{location}}/geminiGcpEnablementSettings/{{gemini_gcp_enablement_setting_id}} * $ pulumi import gcp:gemini/geminiGcpEnablementSetting:GeminiGcpEnablementSetting default {{project}}/{{location}}/{{gemini_gcp_enablement_setting_id}} * $ pulumi import gcp:gemini/geminiGcpEnablementSetting:GeminiGcpEnablementSetting default {{location}}/{{gemini_gcp_enablement_setting_id}} * ``` */ export declare class GeminiGcpEnablementSetting extends pulumi.CustomResource { /** * Get an existing GeminiGcpEnablementSetting 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?: GeminiGcpEnablementSettingState, opts?: pulumi.CustomResourceOptions): GeminiGcpEnablementSetting; /** * Returns true if the given object is an instance of GeminiGcpEnablementSetting. 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 GeminiGcpEnablementSetting; /** * Create time stamp. */ readonly createTime: pulumi.Output<string>; /** * 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>; /** * (Optional, Deprecated) * Whether web grounding should be disabled. * * > **Warning:** `disableWebGrounding` is deprecated. Use `webGroundingType` instead. * * @deprecated `disableWebGrounding` is deprecated. Use `webGroundingType` instead. */ readonly disableWebGrounding: pulumi.Output<boolean | 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; }>; /** * Whether customer data sharing should be enabled. */ readonly enableCustomerDataSharing: pulumi.Output<boolean | undefined>; /** * Id of the Gemini Gcp Enablement setting. */ readonly geminiGcpEnablementSettingId: pulumi.Output<string>; /** * Labels as key value pairs. * **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>; /** * 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>; /** * Identifier. Name of the resource. * Format:projects/{project}/locations/{location}/geminiGcpEnablementSettings/{geminiGcpEnablementSetting} */ 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 combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * Update time stamp. */ readonly updateTime: pulumi.Output<string>; /** * Web grounding type. * Possible values: * GROUNDING_WITH_GOOGLE_SEARCH * WEB_GROUNDING_FOR_ENTERPRISE */ readonly webGroundingType: pulumi.Output<string | undefined>; /** * Create a GeminiGcpEnablementSetting 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: GeminiGcpEnablementSettingArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering GeminiGcpEnablementSetting resources. */ export interface GeminiGcpEnablementSettingState { /** * Create time stamp. */ createTime?: pulumi.Input<string | undefined>; /** * 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>; /** * (Optional, Deprecated) * Whether web grounding should be disabled. * * > **Warning:** `disableWebGrounding` is deprecated. Use `webGroundingType` instead. * * @deprecated `disableWebGrounding` is deprecated. Use `webGroundingType` instead. */ disableWebGrounding?: pulumi.Input<boolean | undefined>; /** * 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>; } | undefined>; /** * Whether customer data sharing should be enabled. */ enableCustomerDataSharing?: pulumi.Input<boolean | undefined>; /** * Id of the Gemini Gcp Enablement setting. */ geminiGcpEnablementSettingId?: pulumi.Input<string | undefined>; /** * Labels as key value pairs. * **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>; } | 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. Name of the resource. * Format:projects/{project}/locations/{location}/geminiGcpEnablementSettings/{geminiGcpEnablementSetting} */ 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 combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * Update time stamp. */ updateTime?: pulumi.Input<string | undefined>; /** * Web grounding type. * Possible values: * GROUNDING_WITH_GOOGLE_SEARCH * WEB_GROUNDING_FOR_ENTERPRISE */ webGroundingType?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a GeminiGcpEnablementSetting resource. */ export interface GeminiGcpEnablementSettingArgs { /** * 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>; /** * (Optional, Deprecated) * Whether web grounding should be disabled. * * > **Warning:** `disableWebGrounding` is deprecated. Use `webGroundingType` instead. * * @deprecated `disableWebGrounding` is deprecated. Use `webGroundingType` instead. */ disableWebGrounding?: pulumi.Input<boolean | undefined>; /** * Whether customer data sharing should be enabled. */ enableCustomerDataSharing?: pulumi.Input<boolean | undefined>; /** * Id of the Gemini Gcp Enablement setting. */ geminiGcpEnablementSettingId: pulumi.Input<string>; /** * Labels as key value pairs. * **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>; } | 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>; /** * 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>; /** * Web grounding type. * Possible values: * GROUNDING_WITH_GOOGLE_SEARCH * WEB_GROUNDING_FOR_ENTERPRISE */ webGroundingType?: pulumi.Input<string | undefined>; } //# sourceMappingURL=geminiGcpEnablementSetting.d.ts.map