@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
242 lines • 9.66 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Template = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* A `Template` is a resource of Model Armor that lets you configure how Model Armor screens prompts and responses.
* It functions as sets of customized filters and thresholds for different safety and security confidence levels, allowing control over what content is flagged.
*
* ## Example Usage
*
* ### Modelarmor Template Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const template_basic = new gcp.modelarmor.Template("template-basic", {
* location: "us-central1",
* templateId: "modelarmor1",
* filterConfig: {},
* templateMetadata: {},
* });
* ```
* ### Modelarmor Template Filter Config
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const template_filter_config = new gcp.modelarmor.Template("template-filter-config", {
* location: "us-central1",
* templateId: "modelarmor2",
* filterConfig: {
* raiSettings: {
* raiFilters: [{
* filterType: "HATE_SPEECH",
* confidenceLevel: "HIGH",
* }],
* },
* sdpSettings: {
* basicConfig: {
* filterEnforcement: "ENABLED",
* },
* },
* piAndJailbreakFilterSettings: {
* filterEnforcement: "ENABLED",
* confidenceLevel: "MEDIUM_AND_ABOVE",
* },
* maliciousUriFilterSettings: {
* filterEnforcement: "ENABLED",
* },
* },
* templateMetadata: {
* multiLanguageDetection: {
* enableMultiLanguageDetection: false,
* },
* },
* });
* ```
* ### Modelarmor Template Template Metadata
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const template_template_metadata = new gcp.modelarmor.Template("template-template-metadata", {
* location: "us-central1",
* templateId: "modelarmor3",
* filterConfig: {
* raiSettings: {
* raiFilters: [{
* filterType: "HARASSMENT",
* confidenceLevel: "MEDIUM_AND_ABOVE",
* }],
* },
* },
* templateMetadata: {
* customLlmResponseSafetyErrorMessage: "This is a custom error message for LLM response",
* logSanitizeOperations: false,
* logTemplateOperations: true,
* multiLanguageDetection: {
* enableMultiLanguageDetection: true,
* },
* ignorePartialInvocationFailures: false,
* customPromptSafetyErrorCode: 400,
* customPromptSafetyErrorMessage: "This is a custom error message for prompt",
* customLlmResponseSafetyErrorCode: 401,
* enforcementType: "INSPECT_ONLY",
* },
* });
* ```
* ### Modelarmor Template Label
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const template_label_advanced_config = new gcp.modelarmor.Template("template-label-advanced-config", {
* location: "us-central1",
* templateId: "modelarmor4",
* labels: {
* "test-label": "template-test-label",
* },
* filterConfig: {
* raiSettings: {
* raiFilters: [{
* filterType: "DANGEROUS",
* confidenceLevel: "MEDIUM_AND_ABOVE",
* }],
* },
* sdpSettings: {
* advancedConfig: {
* inspectTemplate: "projects/llm-firewall-demo/locations/us-central1/inspectTemplates/t3",
* deidentifyTemplate: "projects/llm-firewall-demo/locations/us-central1/deidentifyTemplates/t2",
* },
* },
* },
* templateMetadata: {
* multiLanguageDetection: {
* enableMultiLanguageDetection: false,
* },
* },
* });
* ```
*
* ## Import
*
* Template 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, Template can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:modelarmor/template:Template default projects/{{project}}/locations/{{location}}/templates/{{template_id}}
* $ pulumi import gcp:modelarmor/template:Template default {{project}}/{{location}}/{{template_id}}
* $ pulumi import gcp:modelarmor/template:Template default {{location}}/{{template_id}}
* ```
*/
class Template extends pulumi.CustomResource {
/**
* Get an existing Template 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, id, state, opts) {
return new Template(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:modelarmor/template:Template';
/**
* Returns true if the given object is an instance of Template. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Template.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["deletionPolicy"] = state?.deletionPolicy;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["filterConfig"] = state?.filterConfig;
resourceInputs["labels"] = state?.labels;
resourceInputs["location"] = state?.location;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["templateId"] = state?.templateId;
resourceInputs["templateMetadata"] = state?.templateMetadata;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.filterConfig === undefined && !opts.urn) {
throw new Error("Missing required property 'filterConfig'");
}
if (args?.location === undefined && !opts.urn) {
throw new Error("Missing required property 'location'");
}
if (args?.templateId === undefined && !opts.urn) {
throw new Error("Missing required property 'templateId'");
}
resourceInputs["deletionPolicy"] = args?.deletionPolicy;
resourceInputs["filterConfig"] = args?.filterConfig;
resourceInputs["labels"] = args?.labels;
resourceInputs["location"] = args?.location;
resourceInputs["project"] = args?.project;
resourceInputs["templateId"] = args?.templateId;
resourceInputs["templateMetadata"] = args?.templateMetadata;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(Template.__pulumiType, name, resourceInputs, opts);
}
}
exports.Template = Template;
//# sourceMappingURL=template.js.map