Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. waf
  6. SystemBot
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.waf.SystemBot

volcenginecc logo
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    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

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const example = new volcenginecc.waf.SystemBot("example", {
    host: "www.testwaf.com",
    ruleTag: "J000000000025",
    botType: "search_engine_bot",
    action: "js",
    projectName: "default",
    verificationExemptionTime: 300,
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

example = volcenginecc.waf.SystemBot("example",
    host="www.testwaf.com",
    rule_tag="J000000000025",
    bot_type="search_engine_bot",
    action="js",
    project_name="default",
    verification_exemption_time=300)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/waf"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := waf.NewSystemBot(ctx, "example", &waf.SystemBotArgs{
			Host:                      pulumi.String("www.testwaf.com"),
			RuleTag:                   pulumi.String("J000000000025"),
			BotType:                   pulumi.String("search_engine_bot"),
			Action:                    pulumi.String("js"),
			ProjectName:               pulumi.String("default"),
			VerificationExemptionTime: pulumi.Int(300),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var example = new Volcenginecc.Waf.SystemBot("example", new()
    {
        Host = "www.testwaf.com",
        RuleTag = "J000000000025",
        BotType = "search_engine_bot",
        Action = "js",
        ProjectName = "default",
        VerificationExemptionTime = 300,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.waf.SystemBot;
import com.volcengine.volcenginecc.waf.SystemBotArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new SystemBot("example", SystemBotArgs.builder()
            .host("www.testwaf.com")
            .ruleTag("J000000000025")
            .botType("search_engine_bot")
            .action("js")
            .projectName("default")
            .verificationExemptionTime(300)
            .build());

    }
}

    resources:
  example:
    type: volcenginecc:waf:SystemBot
    properties:
      host: www.testwaf.com
      ruleTag: J000000000025
      botType: search_engine_bot
      action: js
      projectName: default
      verificationExemptionTime: 300

    pulumi {
  required_providers {
    volcenginecc = {
      source = "pulumi/volcenginecc"
    }
  }
}

resource "volcenginecc_waf_systembot" "example" {
  host                        = "www.testwaf.com"
  rule_tag                    = "J000000000025"
  bot_type                    = "search_engine_bot"
  action                      = "js"
  project_name                = "default"
  verification_exemption_time = 300
}

    Create SystemBot Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SystemBot(name: string, args: SystemBotArgs, opts?: CustomResourceOptions);
    @overload
def SystemBot(resource_name: str,
              args: SystemBotArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def SystemBot(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              host: Optional[str] = None,
              rule_tag: Optional[str] = None,
              action: Optional[str] = None,
              bot_type: Optional[str] = None,
              project_name: Optional[str] = None,
              verification_exemption_time: Optional[int] = None)
    func NewSystemBot(ctx *Context, name string, args SystemBotArgs, opts ...ResourceOption) (*SystemBot, error)
    public SystemBot(string name, SystemBotArgs args, CustomResourceOptions? opts = null)
    public SystemBot(String name, SystemBotArgs args)
public SystemBot(String name, SystemBotArgs args, CustomResourceOptions options)

    type: volcenginecc:waf:SystemBot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_waf_system_bot" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SystemBotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SystemBotArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SystemBotArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SystemBotArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SystemBotArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var systemBotResource = new Volcenginecc.Waf.SystemBot("systemBotResource", new()
{
    Host = "string",
    RuleTag = "string",
    Action = "string",
    BotType = "string",
    ProjectName = "string",
    VerificationExemptionTime = 0,
});

    example, err := waf.NewSystemBot(ctx, "systemBotResource", &waf.SystemBotArgs{
	Host:                      pulumi.String("string"),
	RuleTag:                   pulumi.String("string"),
	Action:                    pulumi.String("string"),
	BotType:                   pulumi.String("string"),
	ProjectName:               pulumi.String("string"),
	VerificationExemptionTime: pulumi.Int(0),
})

    resource "volcenginecc_waf_system_bot" "systemBotResource" {
  lifecycle {
    create_before_destroy = true
  }
  host                        = "string"
  rule_tag                    = "string"
  action                      = "string"
  bot_type                    = "string"
  project_name                = "string"
  verification_exemption_time = 0
}

    var systemBotResource = new SystemBot("systemBotResource", SystemBotArgs.builder()
    .host("string")
    .ruleTag("string")
    .action("string")
    .botType("string")
    .projectName("string")
    .verificationExemptionTime(0)
    .build());

    system_bot_resource = volcenginecc.waf.SystemBot("systemBotResource",
    host="string",
    rule_tag="string",
    action="string",
    bot_type="string",
    project_name="string",
    verification_exemption_time=0)

    const systemBotResource = new volcenginecc.waf.SystemBot("systemBotResource", {
    host: "string",
    ruleTag: "string",
    action: "string",
    botType: "string",
    projectName: "string",
    verificationExemptionTime: 0,
});

    type: volcenginecc:waf:SystemBot
properties:
    action: string
    botType: string
    host: string
    projectName: string
    ruleTag: string
    verificationExemptionTime: 0

    SystemBot Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SystemBot resource accepts the following input properties:

    Host string
    Domain name to be protected by the system Bot rule.
    RuleTag string
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    Action string
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    BotType string
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    ProjectName string
    Project name to which the resource belongs.
    VerificationExemptionTime int
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    Host string
    Domain name to be protected by the system Bot rule.
    RuleTag string
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    Action string
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    BotType string
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    ProjectName string
    Project name to which the resource belongs.
    VerificationExemptionTime int
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    host string
    Domain name to be protected by the system Bot rule.
    rule_tag string
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    action string
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    bot_type string
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    project_name string
    Project name to which the resource belongs.
    verification_exemption_time number
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    host String
    Domain name to be protected by the system Bot rule.
    ruleTag String
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    action String
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    botType String
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    projectName String
    Project name to which the resource belongs.
    verificationExemptionTime Integer
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    host string
    Domain name to be protected by the system Bot rule.
    ruleTag string
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    action string
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    botType string
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    projectName string
    Project name to which the resource belongs.
    verificationExemptionTime number
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    host str
    Domain name to be protected by the system Bot rule.
    rule_tag str
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    action str
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    bot_type str
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    project_name str
    Project name to which the resource belongs.
    verification_exemption_time int
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    host String
    Domain name to be protected by the system Bot rule.
    ruleTag String
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    action String
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    botType String
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    projectName String
    Project name to which the resource belongs.
    verificationExemptionTime Number
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SystemBot resource produces the following output properties:

    Description string
    Description of the sub-rule.
    Enable int
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    Id string
    The provider-assigned unique ID for this managed resource.
    IpMatch bool
    Whether this sub-rule supports IP-based matching.
    Name string
    Sub-rule name.
    Description string
    Description of the sub-rule.
    Enable int
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    Id string
    The provider-assigned unique ID for this managed resource.
    IpMatch bool
    Whether this sub-rule supports IP-based matching.
    Name string
    Sub-rule name.
    description string
    Description of the sub-rule.
    enable number
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    id string
    The provider-assigned unique ID for this managed resource.
    ip_match bool
    Whether this sub-rule supports IP-based matching.
    name string
    Sub-rule name.
    description String
    Description of the sub-rule.
    enable Integer
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    id String
    The provider-assigned unique ID for this managed resource.
    ipMatch Boolean
    Whether this sub-rule supports IP-based matching.
    name String
    Sub-rule name.
    description string
    Description of the sub-rule.
    enable number
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    id string
    The provider-assigned unique ID for this managed resource.
    ipMatch boolean
    Whether this sub-rule supports IP-based matching.
    name string
    Sub-rule name.
    description str
    Description of the sub-rule.
    enable int
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    id str
    The provider-assigned unique ID for this managed resource.
    ip_match bool
    Whether this sub-rule supports IP-based matching.
    name str
    Sub-rule name.
    description String
    Description of the sub-rule.
    enable Number
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    id String
    The provider-assigned unique ID for this managed resource.
    ipMatch Boolean
    Whether this sub-rule supports IP-based matching.
    name String
    Sub-rule name.

    Look up Existing SystemBot Resource

    Get an existing SystemBot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SystemBotState, opts?: CustomResourceOptions): SystemBot
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        bot_type: Optional[str] = None,
        description: Optional[str] = None,
        enable: Optional[int] = None,
        host: Optional[str] = None,
        ip_match: Optional[bool] = None,
        name: Optional[str] = None,
        project_name: Optional[str] = None,
        rule_tag: Optional[str] = None,
        verification_exemption_time: Optional[int] = None) -> SystemBot
    func GetSystemBot(ctx *Context, name string, id IDInput, state *SystemBotState, opts ...ResourceOption) (*SystemBot, error)
    public static SystemBot Get(string name, Input<string> id, SystemBotState? state, CustomResourceOptions? opts = null)
    public static SystemBot get(String name, Output<String> id, SystemBotState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:waf:SystemBot    get:      id: ${id}
    import {
  to = volcenginecc_waf_system_bot.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Action string
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    BotType string
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    Description string
    Description of the sub-rule.
    Enable int
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    Host string
    Domain name to be protected by the system Bot rule.
    IpMatch bool
    Whether this sub-rule supports IP-based matching.
    Name string
    Sub-rule name.
    ProjectName string
    Project name to which the resource belongs.
    RuleTag string
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    VerificationExemptionTime int
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    Action string
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    BotType string
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    Description string
    Description of the sub-rule.
    Enable int
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    Host string
    Domain name to be protected by the system Bot rule.
    IpMatch bool
    Whether this sub-rule supports IP-based matching.
    Name string
    Sub-rule name.
    ProjectName string
    Project name to which the resource belongs.
    RuleTag string
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    VerificationExemptionTime int
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    action string
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    bot_type string
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    description string
    Description of the sub-rule.
    enable number
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    host string
    Domain name to be protected by the system Bot rule.
    ip_match bool
    Whether this sub-rule supports IP-based matching.
    name string
    Sub-rule name.
    project_name string
    Project name to which the resource belongs.
    rule_tag string
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    verification_exemption_time number
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    action String
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    botType String
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    description String
    Description of the sub-rule.
    enable Integer
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    host String
    Domain name to be protected by the system Bot rule.
    ipMatch Boolean
    Whether this sub-rule supports IP-based matching.
    name String
    Sub-rule name.
    projectName String
    Project name to which the resource belongs.
    ruleTag String
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    verificationExemptionTime Integer
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    action string
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    botType string
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    description string
    Description of the sub-rule.
    enable number
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    host string
    Domain name to be protected by the system Bot rule.
    ipMatch boolean
    Whether this sub-rule supports IP-based matching.
    name string
    Sub-rule name.
    projectName string
    Project name to which the resource belongs.
    ruleTag string
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    verificationExemptionTime number
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    action str
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    bot_type str
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    description str
    Description of the sub-rule.
    enable int
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    host str
    Domain name to be protected by the system Bot rule.
    ip_match bool
    Whether this sub-rule supports IP-based matching.
    name str
    Sub-rule name.
    project_name str
    Project name to which the resource belongs.
    rule_tag str
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    verification_exemption_time int
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.
    action String
    Action taken when this sub-rule is triggered. Values: observe, block, etc.
    botType String
    Category of the system Bot rule, such as llmCrawlerBot (large model crawler), userBot (user-triggered crawling), searchEngineBot (search engine), marketing (marketing tool), etc.
    description String
    Description of the sub-rule.
    enable Number
    Sub-rule switch. Values:

    - 1: Enabled (fixed as 1 when created)
- 0: Disabled (fixed as 0 when deleted)
    host String
    Domain name to be protected by the system Bot rule.
    ipMatch Boolean
    Whether this sub-rule supports IP-based matching.
    name String
    Sub-rule name.
    projectName String
    Project name to which the resource belongs.
    ruleTag String
    Unique tag for the system Bot sub-rule, such as J000000001026. Used to uniquely identify a sub-rule within a BotType category.
    verificationExemptionTime Number
    Verification exemption duration, in seconds. The period during which verification is not required after a hit and successful verification.

    Import

    $ pulumi import volcenginecc:waf/systemBot:SystemBot example "host|rule_tag"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.60
    published on Thursday, Sep 3, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial