@byteplus/pulumi-bytepluscc 0.0.50 → 0.0.52

package/waf/systemBot.d.ts

@@ -0,0 +1,172 @@
+import * as pulumi from "@pulumi/pulumi";
+/**
+ * Volcengine WAF system Bot rule configuration. System Bot rules are built-in bot detection rules in WAF, categorized by BotType. Each category contains several independently configurable sub-rules (SubRule), each uniquely identified by a RuleTag. Use UpdateSystemBotConfig to set the action and switch for a sub-rule (RuleTag) under a specified domain (Host) (Enable=1 means enabled and considered created, Enable=0 means disabled and considered deleted), and use ListSystemBotConfig to query the current configuration of each sub-rule. Resource granularity is 'domain name + sub-rule tag'.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
+ *
+ * const example = new bytepluscc.waf.SystemBot("example", {
+ *     host: "www.testwaf.com",
+ *     ruleTag: "J000000000025",
+ *     botType: "search_engine_bot",
+ *     action: "js",
+ *     projectName: "default",
+ *     verificationExemptionTime: 300,
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * ```sh
+ * $ pulumi import bytepluscc:waf/systemBot:SystemBot example "host|rule_tag"
+ * ```
+ */
+export declare class SystemBot extends pulumi.CustomResource {
+    /**
+     * Get an existing SystemBot 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?: SystemBotState, opts?: pulumi.CustomResourceOptions): SystemBot;
+    /**
+     * Returns true if the given object is an instance of SystemBot.  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 SystemBot;
+    /**
+     * Action taken when this sub-rule is triggered. Values: observe, block, etc.
+     */
+    readonly action: pulumi.Output<string>;
+    /**
+     * Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
+     */
+    readonly botType: pulumi.Output<string>;
+    /**
+     * Description of the sub-rule.
+     */
+    readonly description: pulumi.Output<string>;
+    /**
+     * Sub-rule switch. Values:
+     *
+     *     - 1: Enabled (fixed as 1 when created)
+     *     - 0: Disabled (fixed as 0 when deleted)
+     */
+    readonly enable: pulumi.Output<number>;
+    /**
+     * Domain name to be protected by the system Bot rule.
+     */
+    readonly host: pulumi.Output<string>;
+    /**
+     * Whether this sub-rule supports IP-based matching.
+     */
+    readonly ipMatch: pulumi.Output<boolean>;
+    /**
+     * Sub-rule name.
+     */
+    readonly name: pulumi.Output<string>;
+    /**
+     * Project name to which the resource belongs.
+     */
+    readonly projectName: pulumi.Output<string>;
+    /**
+     * Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
+     */
+    readonly ruleTag: pulumi.Output<string>;
+    /**
+     * Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
+     */
+    readonly verificationExemptionTime: pulumi.Output<number>;
+    /**
+     * Create a SystemBot 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: SystemBotArgs, opts?: pulumi.CustomResourceOptions);
+}
+/**
+ * Input properties used for looking up and filtering SystemBot resources.
+ */
+export interface SystemBotState {
+    /**
+     * Action taken when this sub-rule is triggered. Values: observe, block, etc.
+     */
+    action?: pulumi.Input<string | undefined>;
+    /**
+     * Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
+     */
+    botType?: pulumi.Input<string | undefined>;
+    /**
+     * Description of the sub-rule.
+     */
+    description?: pulumi.Input<string | undefined>;
+    /**
+     * Sub-rule switch. Values:
+     *
+     *     - 1: Enabled (fixed as 1 when created)
+     *     - 0: Disabled (fixed as 0 when deleted)
+     */
+    enable?: pulumi.Input<number | undefined>;
+    /**
+     * Domain name to be protected by the system Bot rule.
+     */
+    host?: pulumi.Input<string | undefined>;
+    /**
+     * Whether this sub-rule supports IP-based matching.
+     */
+    ipMatch?: pulumi.Input<boolean | undefined>;
+    /**
+     * Sub-rule name.
+     */
+    name?: pulumi.Input<string | undefined>;
+    /**
+     * Project name to which the resource belongs.
+     */
+    projectName?: pulumi.Input<string | undefined>;
+    /**
+     * Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
+     */
+    ruleTag?: pulumi.Input<string | undefined>;
+    /**
+     * Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
+     */
+    verificationExemptionTime?: pulumi.Input<number | undefined>;
+}
+/**
+ * The set of arguments for constructing a SystemBot resource.
+ */
+export interface SystemBotArgs {
+    /**
+     * Action taken when this sub-rule is triggered. Values: observe, block, etc.
+     */
+    action?: pulumi.Input<string | undefined>;
+    /**
+     * Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
+     */
+    botType?: pulumi.Input<string | undefined>;
+    /**
+     * Domain name to be protected by the system Bot rule.
+     */
+    host: pulumi.Input<string>;
+    /**
+     * Project name to which the resource belongs.
+     */
+    projectName?: pulumi.Input<string | undefined>;
+    /**
+     * Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
+     */
+    ruleTag: pulumi.Input<string>;
+    /**
+     * Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
+     */
+    verificationExemptionTime?: pulumi.Input<number | undefined>;
+}
+//# sourceMappingURL=systemBot.d.ts.map

package/waf/systemBot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"systemBot.d.ts","sourceRoot":"","sources":["../../waf/systemBot.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,MAAM,MAAM,gBAAgB,CAAC;AAGzC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,SAAU,SAAQ,MAAM,CAAC,cAAc;IAChD;;;;;;;;OAQG;WACW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,cAAc,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,qBAAqB,GAAG,SAAS;IAOpI;;;OAGG;WACW,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,SAAS;IAOpD;;OAEG;IACH,SAAwB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtD;;OAEG;IACH,SAAwB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACvD;;OAEG;IACH,SAAgC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACnE;;;;;OAKG;IACH,SAAgC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9D;;OAEG;IACH,SAAwB,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACpD;;OAEG;IACH,SAAgC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAChE;;OAEG;IACH,SAAgC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5D;;OAEG;IACH,SAAwB,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC3D;;OAEG;IACH,SAAwB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACvD;;OAEG;IACH,SAAwB,yBAAyB,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAEzE;;;;;;OAMG;gBACS,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,qBAAqB;CAsCrF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC/C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACxC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC;IAC5C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IACxC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC3C;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAChE;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC1C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC3C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC/C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAChE"}

package/waf/systemBot.js

@@ -0,0 +1,121 @@
+"use strict";
+// *** 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.SystemBot = void 0;
+const pulumi = __importStar(require("@pulumi/pulumi"));
+const utilities = __importStar(require("../utilities"));
+/**
+ * Volcengine WAF system Bot rule configuration. System Bot rules are built-in bot detection rules in WAF, categorized by BotType. Each category contains several independently configurable sub-rules (SubRule), each uniquely identified by a RuleTag. Use UpdateSystemBotConfig to set the action and switch for a sub-rule (RuleTag) under a specified domain (Host) (Enable=1 means enabled and considered created, Enable=0 means disabled and considered deleted), and use ListSystemBotConfig to query the current configuration of each sub-rule. Resource granularity is 'domain name + sub-rule tag'.
+ *
+ * ## Example Usage
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as bytepluscc from "@byteplus/pulumi-bytepluscc";
+ *
+ * const example = new bytepluscc.waf.SystemBot("example", {
+ *     host: "www.testwaf.com",
+ *     ruleTag: "J000000000025",
+ *     botType: "search_engine_bot",
+ *     action: "js",
+ *     projectName: "default",
+ *     verificationExemptionTime: 300,
+ * });
+ * ```
+ *
+ * ## Import
+ *
+ * ```sh
+ * $ pulumi import bytepluscc:waf/systemBot:SystemBot example "host|rule_tag"
+ * ```
+ */
+class SystemBot extends pulumi.CustomResource {
+    /**
+     * Get an existing SystemBot 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 SystemBot(name, state, { ...opts, id: id });
+    }
+    /** @internal */
+    static __pulumiType = 'bytepluscc:waf/systemBot:SystemBot';
+    /**
+     * Returns true if the given object is an instance of SystemBot.  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'] === SystemBot.__pulumiType;
+    }
+    constructor(name, argsOrState, opts) {
+        let resourceInputs = {};
+        opts = opts || {};
+        if (opts.id) {
+            const state = argsOrState;
+            resourceInputs["action"] = state?.action;
+            resourceInputs["botType"] = state?.botType;
+            resourceInputs["description"] = state?.description;
+            resourceInputs["enable"] = state?.enable;
+            resourceInputs["host"] = state?.host;
+            resourceInputs["ipMatch"] = state?.ipMatch;
+            resourceInputs["name"] = state?.name;
+            resourceInputs["projectName"] = state?.projectName;
+            resourceInputs["ruleTag"] = state?.ruleTag;
+            resourceInputs["verificationExemptionTime"] = state?.verificationExemptionTime;
+        }
+        else {
+            const args = argsOrState;
+            if (args?.host === undefined && !opts.urn) {
+                throw new Error("Missing required property 'host'");
+            }
+            if (args?.ruleTag === undefined && !opts.urn) {
+                throw new Error("Missing required property 'ruleTag'");
+            }
+            resourceInputs["action"] = args?.action;
+            resourceInputs["botType"] = args?.botType;
+            resourceInputs["host"] = args?.host;
+            resourceInputs["projectName"] = args?.projectName;
+            resourceInputs["ruleTag"] = args?.ruleTag;
+            resourceInputs["verificationExemptionTime"] = args?.verificationExemptionTime;
+            resourceInputs["description"] = undefined /*out*/;
+            resourceInputs["enable"] = undefined /*out*/;
+            resourceInputs["ipMatch"] = undefined /*out*/;
+            resourceInputs["name"] = undefined /*out*/;
+        }
+        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
+        super(SystemBot.__pulumiType, name, resourceInputs, opts);
+    }
+}
+exports.SystemBot = SystemBot;
+//# sourceMappingURL=systemBot.js.map

package/waf/systemBot.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"systemBot.js","sourceRoot":"","sources":["../../waf/systemBot.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEjF,uDAAyC;AACzC,wDAA0C;AAE1C;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAa,SAAU,SAAQ,MAAM,CAAC,cAAc;IAChD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAsB,EAAE,IAAmC;QACpH,OAAO,IAAI,SAAS,CAAC,IAAI,EAAO,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,YAAY,GAAG,oCAAoC,CAAC;IAE3E;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,SAAS,CAAC,YAAY,CAAC;IAC1D,CAAC;IAsDD,YAAY,IAAY,EAAE,WAA4C,EAAE,IAAmC;QACvG,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAyC,CAAC;YACxD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC;YAC3C,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC;YACnD,cAAc,CAAC,QAAQ,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC;YACzC,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC;YAC3C,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,CAAC;YACrC,cAAc,CAAC,aAAa,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC;YACnD,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,EAAE,OAAO,CAAC;YAC3C,cAAc,CAAC,2BAA2B,CAAC,GAAG,KAAK,EAAE,yBAAyB,CAAC;SAClF;aAAM;YACH,MAAM,IAAI,GAAG,WAAwC,CAAC;YACtD,IAAI,IAAI,EAAE,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACvC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;aACvD;YACD,IAAI,IAAI,EAAE,OAAO,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC1C,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;aAC1D;YACD,cAAc,CAAC,QAAQ,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC;YACxC,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC;YAC1C,cAAc,CAAC,MAAM,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC;YACpC,cAAc,CAAC,aAAa,CAAC,GAAG,IAAI,EAAE,WAAW,CAAC;YAClD,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC;YAC1C,cAAc,CAAC,2BAA2B,CAAC,GAAG,IAAI,EAAE,yBAAyB,CAAC;YAC9E,cAAc,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAClD,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC7C,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC9C;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC9D,CAAC;;AApHL,8BAqHC"}