1. Packages
  2. Volcengine
  3. API Docs
  4. waf
  5. getCustomBots
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.waf.getCustomBots

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of waf custom bots

    Example Usage

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

const foo = volcengine.waf.getCustomBots({
    host: "www.tf-test.com",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.waf.get_custom_bots(host="www.tf-test.com")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := waf.GetCustomBots(ctx, &waf.GetCustomBotsArgs{
			Host: pulumi.StringRef("www.tf-test.com"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Waf.GetCustomBots.Invoke(new()
    {
        Host = "www.tf-test.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.waf.WafFunctions;
import com.pulumi.volcengine.waf.inputs.GetCustomBotsArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var foo = WafFunctions.getCustomBots(GetCustomBotsArgs.builder()
            .host("www.tf-test.com")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:waf:getCustomBots
      Arguments:
        host: www.tf-test.com

    Using getCustomBots

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCustomBots(args: GetCustomBotsArgs, opts?: InvokeOptions): Promise<GetCustomBotsResult>
function getCustomBotsOutput(args: GetCustomBotsOutputArgs, opts?: InvokeOptions): Output<GetCustomBotsResult>
    def get_custom_bots(host: Optional[str] = None,
                    name_regex: Optional[str] = None,
                    output_file: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetCustomBotsResult
def get_custom_bots_output(host: Optional[pulumi.Input[str]] = None,
                    name_regex: Optional[pulumi.Input[str]] = None,
                    output_file: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetCustomBotsResult]
    func GetCustomBots(ctx *Context, args *GetCustomBotsArgs, opts ...InvokeOption) (*GetCustomBotsResult, error)
func GetCustomBotsOutput(ctx *Context, args *GetCustomBotsOutputArgs, opts ...InvokeOption) GetCustomBotsResultOutput

    > Note: This function is named GetCustomBots in the Go SDK.

    public static class GetCustomBots 
{
    public static Task<GetCustomBotsResult> InvokeAsync(GetCustomBotsArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomBotsResult> Invoke(GetCustomBotsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCustomBotsResult> getCustomBots(GetCustomBotsArgs args, InvokeOptions options)
public static Output<GetCustomBotsResult> getCustomBots(GetCustomBotsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:waf/getCustomBots:getCustomBots
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Host string
    The domain names that need to be viewed.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    Host string
    The domain names that need to be viewed.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    host String
    The domain names that need to be viewed.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    host string
    The domain names that need to be viewed.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    host str
    The domain names that need to be viewed.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    host String
    The domain names that need to be viewed.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.

    getCustomBots Result

    The following output properties are available:

    Datas List<GetCustomBotsData>
    The Details of Custom bot.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Host string
    NameRegex string
    OutputFile string
    Datas []GetCustomBotsData
    The Details of Custom bot.
    Id string
    The provider-assigned unique ID for this managed resource.
    TotalCount int
    The total count of query.
    Host string
    NameRegex string
    OutputFile string
    datas List<GetCustomBotsData>
    The Details of Custom bot.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Integer
    The total count of query.
    host String
    nameRegex String
    outputFile String
    datas GetCustomBotsData[]
    The Details of Custom bot.
    id string
    The provider-assigned unique ID for this managed resource.
    totalCount number
    The total count of query.
    host string
    nameRegex string
    outputFile string
    datas Sequence[GetCustomBotsData]
    The Details of Custom bot.
    id str
    The provider-assigned unique ID for this managed resource.
    total_count int
    The total count of query.
    host str
    name_regex str
    output_file str
    datas List<Property Map>
    The Details of Custom bot.
    id String
    The provider-assigned unique ID for this managed resource.
    totalCount Number
    The total count of query.
    host String
    nameRegex String
    outputFile String

    Supporting Types

    GetCustomBotsData

    Accurate GetCustomBotsDataAccurate
    Advanced conditions.
    Action string
    The execution action of the Bot.
    Advanced int
    Whether to set advanced conditions.
    BotType string
    bot name.
    Description string
    The description of bot.
    Enable int
    Whether to enable bot.
    Id int
    The actual count bits of the rule unique identifier (corresponding to the RuleTag).
    RuleTag string
    Rule unique identifier.
    UpdateTime string
    The update time.
    Accurate GetCustomBotsDataAccurate
    Advanced conditions.
    Action string
    The execution action of the Bot.
    Advanced int
    Whether to set advanced conditions.
    BotType string
    bot name.
    Description string
    The description of bot.
    Enable int
    Whether to enable bot.
    Id int
    The actual count bits of the rule unique identifier (corresponding to the RuleTag).
    RuleTag string
    Rule unique identifier.
    UpdateTime string
    The update time.
    accurate GetCustomBotsDataAccurate
    Advanced conditions.
    action String
    The execution action of the Bot.
    advanced Integer
    Whether to set advanced conditions.
    botType String
    bot name.
    description String
    The description of bot.
    enable Integer
    Whether to enable bot.
    id Integer
    The actual count bits of the rule unique identifier (corresponding to the RuleTag).
    ruleTag String
    Rule unique identifier.
    updateTime String
    The update time.
    accurate GetCustomBotsDataAccurate
    Advanced conditions.
    action string
    The execution action of the Bot.
    advanced number
    Whether to set advanced conditions.
    botType string
    bot name.
    description string
    The description of bot.
    enable number
    Whether to enable bot.
    id number
    The actual count bits of the rule unique identifier (corresponding to the RuleTag).
    ruleTag string
    Rule unique identifier.
    updateTime string
    The update time.
    accurate GetCustomBotsDataAccurate
    Advanced conditions.
    action str
    The execution action of the Bot.
    advanced int
    Whether to set advanced conditions.
    bot_type str
    bot name.
    description str
    The description of bot.
    enable int
    Whether to enable bot.
    id int
    The actual count bits of the rule unique identifier (corresponding to the RuleTag).
    rule_tag str
    Rule unique identifier.
    update_time str
    The update time.
    accurate Property Map
    Advanced conditions.
    action String
    The execution action of the Bot.
    advanced Number
    Whether to set advanced conditions.
    botType String
    bot name.
    description String
    The description of bot.
    enable Number
    Whether to enable bot.
    id Number
    The actual count bits of the rule unique identifier (corresponding to the RuleTag).
    ruleTag String
    Rule unique identifier.
    updateTime String
    The update time.

    GetCustomBotsDataAccurate

    AccurateRules List<GetCustomBotsDataAccurateAccurateRule>
    Details of advanced conditions.
    Logic int
    The logical relationship of advanced conditions.
    AccurateRules []GetCustomBotsDataAccurateAccurateRule
    Details of advanced conditions.
    Logic int
    The logical relationship of advanced conditions.
    accurateRules List<GetCustomBotsDataAccurateAccurateRule>
    Details of advanced conditions.
    logic Integer
    The logical relationship of advanced conditions.
    accurateRules GetCustomBotsDataAccurateAccurateRule[]
    Details of advanced conditions.
    logic number
    The logical relationship of advanced conditions.
    accurate_rules Sequence[GetCustomBotsDataAccurateAccurateRule]
    Details of advanced conditions.
    logic int
    The logical relationship of advanced conditions.
    accurateRules List<Property Map>
    Details of advanced conditions.
    logic Number
    The logical relationship of advanced conditions.

    GetCustomBotsDataAccurateAccurateRule

    HttpObj string
    The HTTP object to be added to the advanced conditions.
    ObjType int
    The matching field for HTTP objects.
    Opretar int
    The logical operator for the condition.
    Property int
    Operate the properties of the http object.
    ValueString string
    The value to be matched.
    HttpObj string
    The HTTP object to be added to the advanced conditions.
    ObjType int
    The matching field for HTTP objects.
    Opretar int
    The logical operator for the condition.
    Property int
    Operate the properties of the http object.
    ValueString string
    The value to be matched.
    httpObj String
    The HTTP object to be added to the advanced conditions.
    objType Integer
    The matching field for HTTP objects.
    opretar Integer
    The logical operator for the condition.
    property Integer
    Operate the properties of the http object.
    valueString String
    The value to be matched.
    httpObj string
    The HTTP object to be added to the advanced conditions.
    objType number
    The matching field for HTTP objects.
    opretar number
    The logical operator for the condition.
    property number
    Operate the properties of the http object.
    valueString string
    The value to be matched.
    http_obj str
    The HTTP object to be added to the advanced conditions.
    obj_type int
    The matching field for HTTP objects.
    opretar int
    The logical operator for the condition.
    property int
    Operate the properties of the http object.
    value_string str
    The value to be matched.
    httpObj String
    The HTTP object to be added to the advanced conditions.
    objType Number
    The matching field for HTTP objects.
    opretar Number
    The logical operator for the condition.
    property Number
    Operate the properties of the http object.
    valueString String
    The value to be matched.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate