Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Elasticstack Provider
  4. API Docs
  5. KibanaAgentbuilderTool
Viewing docs for elasticstack 0.16.5
published on Sunday, Sep 13, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

elasticstack.KibanaAgentbuilderTool

elasticstack
Viewing docs for elasticstack 0.16.5
published on Sunday, Sep 13, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

    Manages Kibana Agent Builder tools. Tools can be of type esql, index_search, or workflow. See the Agent Builder API documentation.

    Example Usage

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

// ES|QL tool
const esqlTool = new elasticstack.KibanaAgentbuilderTool("esql_tool", {
    toolId: "my-esql-tool",
    type: "esql",
    description: "Analyzes trade data with time filtering",
    tags: [
        "analytics",
        "finance",
    ],
    configuration: JSON.stringify({
        query: "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit",
        params: {
            limit: {
                type: "integer",
                description: "Maximum number of results to return",
            },
            startTime: {
                type: "date",
                description: "Start time for the analysis in ISO format",
            },
        },
    }),
});
// Workflow tool — references an agent builder workflow
const myWorkflow = new elasticstack.KibanaAgentbuilderWorkflow("my_workflow", {configurationYaml: `name: My Workflow
enabled: true
triggers:
  - type: manual
inputs:
  - name: message
    type: string
    default: \\"hello world\\"
steps:
  - name: hello_world_step
    type: console
    with:
      message: \\"{{ inputs.message }}\\"
`});
const workflowTool = new elasticstack.KibanaAgentbuilderTool("workflow_tool", {
    toolId: "my-workflow-tool",
    type: "workflow",
    description: "Exposes a workflow as an agent tool",
    configuration: pulumi.jsonStringify({
        workflow_id: myWorkflow.workflowId,
    }),
});

    import pulumi
import json
import pulumi_elasticstack as elasticstack

# ES|QL tool
esql_tool = elasticstack.KibanaAgentbuilderTool("esql_tool",
    tool_id="my-esql-tool",
    type="esql",
    description="Analyzes trade data with time filtering",
    tags=[
        "analytics",
        "finance",
    ],
    configuration=json.dumps({
        "query": "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit",
        "params": {
            "limit": {
                "type": "integer",
                "description": "Maximum number of results to return",
            },
            "startTime": {
                "type": "date",
                "description": "Start time for the analysis in ISO format",
            },
        },
    }))
# Workflow tool — references an agent builder workflow
my_workflow = elasticstack.KibanaAgentbuilderWorkflow("my_workflow", configuration_yaml="""name: My Workflow
enabled: true
triggers:
  - type: manual
inputs:
  - name: message
    type: string
    default: \"hello world\"
steps:
  - name: hello_world_step
    type: console
    with:
      message: \"{{ inputs.message }}\"
""")
workflow_tool = elasticstack.KibanaAgentbuilderTool("workflow_tool",
    tool_id="my-workflow-tool",
    type="workflow",
    description="Exposes a workflow as an agent tool",
    configuration=pulumi.Output.json_dumps({
        "workflow_id": my_workflow.workflow_id,
    }))

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"query": "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit",
			"params": map[string]interface{}{
				"limit": map[string]interface{}{
					"type":        "integer",
					"description": "Maximum number of results to return",
				},
				"startTime": map[string]interface{}{
					"type":        "date",
					"description": "Start time for the analysis in ISO format",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		// ES|QL tool
		_, err = elasticstack.NewKibanaAgentbuilderTool(ctx, "esql_tool", &elasticstack.KibanaAgentbuilderToolArgs{
			ToolId:      pulumi.String("my-esql-tool"),
			Type:        pulumi.String("esql"),
			Description: pulumi.String("Analyzes trade data with time filtering"),
			Tags: pulumi.StringArray{
				pulumi.String("analytics"),
				pulumi.String("finance"),
			},
			Configuration: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		// Workflow tool — references an agent builder workflow
		myWorkflow, err := elasticstack.NewKibanaAgentbuilderWorkflow(ctx, "my_workflow", &elasticstack.KibanaAgentbuilderWorkflowArgs{
			ConfigurationYaml: pulumi.String(`name: My Workflow
enabled: true
triggers:
  - type: manual
inputs:
  - name: message
    type: string
    default: \"hello world\"
steps:
  - name: hello_world_step
    type: console
    with:
      message: \"{{ inputs.message }}\"
`),
		})
		if err != nil {
			return err
		}
		_, err = elasticstack.NewKibanaAgentbuilderTool(ctx, "workflow_tool", &elasticstack.KibanaAgentbuilderToolArgs{
			ToolId:      pulumi.String("my-workflow-tool"),
			Type:        pulumi.String("workflow"),
			Description: pulumi.String("Exposes a workflow as an agent tool"),
			Configuration: myWorkflow.WorkflowId.ApplyT(func(workflowId string) (pulumi.String, error) {
				var _zero pulumi.String
				tmpJSON1, err := json.Marshal(map[string]interface{}{
					"workflow_id": workflowId,
				})
				if err != nil {
					return _zero, err
				}
				json1 := string(tmpJSON1)
				return pulumi.String(json1), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    // ES|QL tool
    var esqlTool = new Elasticstack.KibanaAgentbuilderTool("esql_tool", new()
    {
        ToolId = "my-esql-tool",
        Type = "esql",
        Description = "Analyzes trade data with time filtering",
        Tags = new[]
        {
            "analytics",
            "finance",
        },
        Configuration = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["query"] = "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit",
            ["params"] = new Dictionary<string, object?>
            {
                ["limit"] = new Dictionary<string, object?>
                {
                    ["type"] = "integer",
                    ["description"] = "Maximum number of results to return",
                },
                ["startTime"] = new Dictionary<string, object?>
                {
                    ["type"] = "date",
                    ["description"] = "Start time for the analysis in ISO format",
                },
            },
        }),
    });

    // Workflow tool — references an agent builder workflow
    var myWorkflow = new Elasticstack.KibanaAgentbuilderWorkflow("my_workflow", new()
    {
        ConfigurationYaml = @"name: My Workflow
enabled: true
triggers:
  - type: manual
inputs:
  - name: message
    type: string
    default: \""hello world\""
steps:
  - name: hello_world_step
    type: console
    with:
      message: \""{{ inputs.message }}\""
",
    });

    var workflowTool = new Elasticstack.KibanaAgentbuilderTool("workflow_tool", new()
    {
        ToolId = "my-workflow-tool",
        Type = "workflow",
        Description = "Exposes a workflow as an agent tool",
        Configuration = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
        {
            ["workflow_id"] = myWorkflow.WorkflowId,
        })),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaAgentbuilderTool;
import com.pulumi.elasticstack.KibanaAgentbuilderToolArgs;
import com.pulumi.elasticstack.KibanaAgentbuilderWorkflow;
import com.pulumi.elasticstack.KibanaAgentbuilderWorkflowArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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) {
        // ES|QL tool
        var esqlTool = new KibanaAgentbuilderTool("esqlTool", KibanaAgentbuilderToolArgs.builder()
            .toolId("my-esql-tool")
            .type("esql")
            .description("Analyzes trade data with time filtering")
            .tags(            
                "analytics",
                "finance")
            .configuration(serializeJson(
                jsonObject(
                    jsonProperty("query", "FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit"),
                    jsonProperty("params", jsonObject(
                        jsonProperty("limit", jsonObject(
                            jsonProperty("type", "integer"),
                            jsonProperty("description", "Maximum number of results to return")
                        )),
                        jsonProperty("startTime", jsonObject(
                            jsonProperty("type", "date"),
                            jsonProperty("description", "Start time for the analysis in ISO format")
                        ))
                    ))
                )))
            .build());

        // Workflow tool — references an agent builder workflow
        var myWorkflow = new KibanaAgentbuilderWorkflow("myWorkflow", KibanaAgentbuilderWorkflowArgs.builder()
            .configurationYaml("""
name: My Workflow
enabled: true
triggers:
  - type: manual
inputs:
  - name: message
    type: string
    default: \"hello world\"
steps:
  - name: hello_world_step
    type: console
    with:
      message: \"{{ inputs.message }}\"
            """)
            .build());

        var workflowTool = new KibanaAgentbuilderTool("workflowTool", KibanaAgentbuilderToolArgs.builder()
            .toolId("my-workflow-tool")
            .type("workflow")
            .description("Exposes a workflow as an agent tool")
            .configuration(myWorkflow.workflowId().applyValue(_workflowId -> serializeJson(
                jsonObject(
                    jsonProperty("workflow_id", _workflowId)
                ))))
            .build());

    }
}

    resources:
  # ES|QL tool
  esqlTool:
    type: elasticstack:KibanaAgentbuilderTool
    name: esql_tool
    properties:
      toolId: my-esql-tool
      type: esql
      description: Analyzes trade data with time filtering
      tags:
        - analytics
        - finance
      configuration:
        fn::toJSON:
          query: FROM financial_trades | WHERE execution_timestamp >= ?startTime | STATS trade_count=COUNT(*), avg_price=AVG(execution_price) BY symbol | SORT trade_count DESC | LIMIT ?limit
          params:
            limit:
              type: integer
              description: Maximum number of results to return
            startTime:
              type: date
              description: Start time for the analysis in ISO format
  # Workflow tool — references an agent builder workflow
  myWorkflow:
    type: elasticstack:KibanaAgentbuilderWorkflow
    name: my_workflow
    properties:
      configurationYaml: |
        name: My Workflow
        enabled: true
        triggers:
          - type: manual
        inputs:
          - name: message
            type: string
            default: \"hello world\"
        steps:
          - name: hello_world_step
            type: console
            with:
              message: \"{{ inputs.message }}\"
  workflowTool:
    type: elasticstack:KibanaAgentbuilderTool
    name: workflow_tool
    properties:
      toolId: my-workflow-tool
      type: workflow
      description: Exposes a workflow as an agent tool
      configuration:
        fn::toJSON:
          workflow_id: ${myWorkflow.workflowId}

    Example coming soon!

    Create KibanaAgentbuilderTool Resource

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

    Constructor syntax

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

@overload
def KibanaAgentbuilderTool(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           configuration: Optional[str] = None,
                           tool_id: Optional[str] = None,
                           type: Optional[str] = None,
                           description: Optional[str] = None,
                           kibana_connections: Optional[Sequence[KibanaAgentbuilderToolKibanaConnectionArgs]] = None,
                           space_id: Optional[str] = None,
                           tags: Optional[Sequence[str]] = None,
                           timeouts: Optional[KibanaAgentbuilderToolTimeoutsArgs] = None)
    func NewKibanaAgentbuilderTool(ctx *Context, name string, args KibanaAgentbuilderToolArgs, opts ...ResourceOption) (*KibanaAgentbuilderTool, error)
    public KibanaAgentbuilderTool(string name, KibanaAgentbuilderToolArgs args, CustomResourceOptions? opts = null)
    public KibanaAgentbuilderTool(String name, KibanaAgentbuilderToolArgs args)
public KibanaAgentbuilderTool(String name, KibanaAgentbuilderToolArgs args, CustomResourceOptions options)

    type: elasticstack:KibanaAgentbuilderTool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "elasticstack_kibana_agentbuilder_tool" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args KibanaAgentbuilderToolArgs
    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 KibanaAgentbuilderToolArgs
    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 KibanaAgentbuilderToolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KibanaAgentbuilderToolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KibanaAgentbuilderToolArgs
    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 kibanaAgentbuilderToolResource = new Elasticstack.KibanaAgentbuilderTool("kibanaAgentbuilderToolResource", new()
{
    Configuration = "string",
    ToolId = "string",
    Type = "string",
    Description = "string",
    KibanaConnections = new[]
    {
        new Elasticstack.Inputs.KibanaAgentbuilderToolKibanaConnectionArgs
        {
            ApiKey = "string",
            BearerToken = "string",
            CaCerts = new[]
            {
                "string",
            },
            Endpoints = new[]
            {
                "string",
            },
            Insecure = false,
            Password = "string",
            Username = "string",
        },
    },
    SpaceId = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Elasticstack.Inputs.KibanaAgentbuilderToolTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
});

    example, err := elasticstack.NewKibanaAgentbuilderTool(ctx, "kibanaAgentbuilderToolResource", &elasticstack.KibanaAgentbuilderToolArgs{
	Configuration: pulumi.String("string"),
	ToolId:        pulumi.String("string"),
	Type:          pulumi.String("string"),
	Description:   pulumi.String("string"),
	KibanaConnections: elasticstack.KibanaAgentbuilderToolKibanaConnectionArray{
		&elasticstack.KibanaAgentbuilderToolKibanaConnectionArgs{
			ApiKey:      pulumi.String("string"),
			BearerToken: pulumi.String("string"),
			CaCerts: pulumi.StringArray{
				pulumi.String("string"),
			},
			Endpoints: pulumi.StringArray{
				pulumi.String("string"),
			},
			Insecure: pulumi.Bool(false),
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
	},
	SpaceId: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &elasticstack.KibanaAgentbuilderToolTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    resource "elasticstack_kibana_agentbuilder_tool" "kibanaAgentbuilderToolResource" {
  lifecycle {
    create_before_destroy = true
  }
  configuration = "string"
  tool_id       = "string"
  type          = "string"
  description   = "string"
  kibana_connections {
    api_key      = "string"
    bearer_token = "string"
    ca_certs     = ["string"]
    endpoints    = ["string"]
    insecure     = false
    password     = "string"
    username     = "string"
  }
  space_id = "string"
  tags     = ["string"]
  timeouts = {
    create = "string"
    delete = "string"
    read   = "string"
    update = "string"
  }
}

    var kibanaAgentbuilderToolResource = new KibanaAgentbuilderTool("kibanaAgentbuilderToolResource", KibanaAgentbuilderToolArgs.builder()
    .configuration("string")
    .toolId("string")
    .type("string")
    .description("string")
    .kibanaConnections(KibanaAgentbuilderToolKibanaConnectionArgs.builder()
        .apiKey("string")
        .bearerToken("string")
        .caCerts("string")
        .endpoints("string")
        .insecure(false)
        .password("string")
        .username("string")
        .build())
    .spaceId("string")
    .tags("string")
    .timeouts(KibanaAgentbuilderToolTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .build());

    kibana_agentbuilder_tool_resource = elasticstack.KibanaAgentbuilderTool("kibanaAgentbuilderToolResource",
    configuration="string",
    tool_id="string",
    type="string",
    description="string",
    kibana_connections=[{
        "api_key": "string",
        "bearer_token": "string",
        "ca_certs": ["string"],
        "endpoints": ["string"],
        "insecure": False,
        "password": "string",
        "username": "string",
    }],
    space_id="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    })

    const kibanaAgentbuilderToolResource = new elasticstack.KibanaAgentbuilderTool("kibanaAgentbuilderToolResource", {
    configuration: "string",
    toolId: "string",
    type: "string",
    description: "string",
    kibanaConnections: [{
        apiKey: "string",
        bearerToken: "string",
        caCerts: ["string"],
        endpoints: ["string"],
        insecure: false,
        password: "string",
        username: "string",
    }],
    spaceId: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
});

    type: elasticstack:KibanaAgentbuilderTool
properties:
    configuration: string
    description: string
    kibanaConnections:
        - apiKey: string
          bearerToken: string
          caCerts:
            - string
          endpoints:
            - string
          insecure: false
          password: string
          username: string
    spaceId: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        read: string
        update: string
    toolId: string
    type: string

    KibanaAgentbuilderTool 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 KibanaAgentbuilderTool resource accepts the following input properties:

    Configuration string
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    ToolId string
    The tool ID.
    Type string
    The tool type. Must be one of: [esql index_search workflow mcp].
    Description string
    The tool description.
    KibanaConnections List<KibanaAgentbuilderToolKibanaConnection>
    Kibana connection configuration block.
    SpaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    Tags List<string>
    List of tags for the tool.
    Timeouts KibanaAgentbuilderToolTimeouts
    Configuration string
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    ToolId string
    The tool ID.
    Type string
    The tool type. Must be one of: [esql index_search workflow mcp].
    Description string
    The tool description.
    KibanaConnections []KibanaAgentbuilderToolKibanaConnectionArgs
    Kibana connection configuration block.
    SpaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    Tags []string
    List of tags for the tool.
    Timeouts KibanaAgentbuilderToolTimeoutsArgs
    configuration string
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    tool_id string
    The tool ID.
    type string
    The tool type. Must be one of: [esql index_search workflow mcp].
    description string
    The tool description.
    kibana_connections list(object)
    Kibana connection configuration block.
    space_id string
    An identifier for the space. If space_id is not provided, the default space is used.
    tags list(string)
    List of tags for the tool.
    timeouts object
    configuration String
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    toolId String
    The tool ID.
    type String
    The tool type. Must be one of: [esql index_search workflow mcp].
    description String
    The tool description.
    kibanaConnections List<KibanaAgentbuilderToolKibanaConnection>
    Kibana connection configuration block.
    spaceId String
    An identifier for the space. If space_id is not provided, the default space is used.
    tags List<String>
    List of tags for the tool.
    timeouts KibanaAgentbuilderToolTimeouts
    configuration string
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    toolId string
    The tool ID.
    type string
    The tool type. Must be one of: [esql index_search workflow mcp].
    description string
    The tool description.
    kibanaConnections KibanaAgentbuilderToolKibanaConnection[]
    Kibana connection configuration block.
    spaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    tags string[]
    List of tags for the tool.
    timeouts KibanaAgentbuilderToolTimeouts
    configuration str
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    tool_id str
    The tool ID.
    type str
    The tool type. Must be one of: [esql index_search workflow mcp].
    description str
    The tool description.
    kibana_connections Sequence[KibanaAgentbuilderToolKibanaConnectionArgs]
    Kibana connection configuration block.
    space_id str
    An identifier for the space. If space_id is not provided, the default space is used.
    tags Sequence[str]
    List of tags for the tool.
    timeouts KibanaAgentbuilderToolTimeoutsArgs
    configuration String
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    toolId String
    The tool ID.
    type String
    The tool type. Must be one of: [esql index_search workflow mcp].
    description String
    The tool description.
    kibanaConnections List<Property Map>
    Kibana connection configuration block.
    spaceId String
    An identifier for the space. If space_id is not provided, the default space is used.
    tags List<String>
    List of tags for the tool.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing KibanaAgentbuilderTool Resource

    Get an existing KibanaAgentbuilderTool 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?: KibanaAgentbuilderToolState, opts?: CustomResourceOptions): KibanaAgentbuilderTool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[str] = None,
        description: Optional[str] = None,
        kibana_connections: Optional[Sequence[KibanaAgentbuilderToolKibanaConnectionArgs]] = None,
        space_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[KibanaAgentbuilderToolTimeoutsArgs] = None,
        tool_id: Optional[str] = None,
        type: Optional[str] = None) -> KibanaAgentbuilderTool
    func GetKibanaAgentbuilderTool(ctx *Context, name string, id IDInput, state *KibanaAgentbuilderToolState, opts ...ResourceOption) (*KibanaAgentbuilderTool, error)
    public static KibanaAgentbuilderTool Get(string name, Input<string> id, KibanaAgentbuilderToolState? state, CustomResourceOptions? opts = null)
    public static KibanaAgentbuilderTool get(String name, Output<String> id, KibanaAgentbuilderToolState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:KibanaAgentbuilderTool    get:      id: ${id}
    import {
  to = elasticstack_kibana_agentbuilder_tool.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:
    Configuration string
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    Description string
    The tool description.
    KibanaConnections List<KibanaAgentbuilderToolKibanaConnection>
    Kibana connection configuration block.
    SpaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    Tags List<string>
    List of tags for the tool.
    Timeouts KibanaAgentbuilderToolTimeouts
    ToolId string
    The tool ID.
    Type string
    The tool type. Must be one of: [esql index_search workflow mcp].
    Configuration string
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    Description string
    The tool description.
    KibanaConnections []KibanaAgentbuilderToolKibanaConnectionArgs
    Kibana connection configuration block.
    SpaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    Tags []string
    List of tags for the tool.
    Timeouts KibanaAgentbuilderToolTimeoutsArgs
    ToolId string
    The tool ID.
    Type string
    The tool type. Must be one of: [esql index_search workflow mcp].
    configuration string
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    description string
    The tool description.
    kibana_connections list(object)
    Kibana connection configuration block.
    space_id string
    An identifier for the space. If space_id is not provided, the default space is used.
    tags list(string)
    List of tags for the tool.
    timeouts object
    tool_id string
    The tool ID.
    type string
    The tool type. Must be one of: [esql index_search workflow mcp].
    configuration String
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    description String
    The tool description.
    kibanaConnections List<KibanaAgentbuilderToolKibanaConnection>
    Kibana connection configuration block.
    spaceId String
    An identifier for the space. If space_id is not provided, the default space is used.
    tags List<String>
    List of tags for the tool.
    timeouts KibanaAgentbuilderToolTimeouts
    toolId String
    The tool ID.
    type String
    The tool type. Must be one of: [esql index_search workflow mcp].
    configuration string
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    description string
    The tool description.
    kibanaConnections KibanaAgentbuilderToolKibanaConnection[]
    Kibana connection configuration block.
    spaceId string
    An identifier for the space. If space_id is not provided, the default space is used.
    tags string[]
    List of tags for the tool.
    timeouts KibanaAgentbuilderToolTimeouts
    toolId string
    The tool ID.
    type string
    The tool type. Must be one of: [esql index_search workflow mcp].
    configuration str
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    description str
    The tool description.
    kibana_connections Sequence[KibanaAgentbuilderToolKibanaConnectionArgs]
    Kibana connection configuration block.
    space_id str
    An identifier for the space. If space_id is not provided, the default space is used.
    tags Sequence[str]
    List of tags for the tool.
    timeouts KibanaAgentbuilderToolTimeoutsArgs
    tool_id str
    The tool ID.
    type str
    The tool type. Must be one of: [esql index_search workflow mcp].
    configuration String
    The tool configuration as a JSON-encoded string. Use jsonencode() to pass a configuration object.
    description String
    The tool description.
    kibanaConnections List<Property Map>
    Kibana connection configuration block.
    spaceId String
    An identifier for the space. If space_id is not provided, the default space is used.
    tags List<String>
    List of tags for the tool.
    timeouts Property Map
    toolId String
    The tool ID.
    type String
    The tool type. Must be one of: [esql index_search workflow mcp].

    Supporting Types

    KibanaAgentbuilderToolKibanaConnection, KibanaAgentbuilderToolKibanaConnectionArgs

    ApiKey string
    API Key to use for authentication to Kibana
    BearerToken string
    Bearer Token to use for authentication to Kibana
    CaCerts List<string>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    Endpoints List<string>
    Insecure bool
    Disable TLS certificate validation
    Password string
    Password to use for API authentication to Kibana.
    Username string
    Username to use for API authentication to Kibana.
    ApiKey string
    API Key to use for authentication to Kibana
    BearerToken string
    Bearer Token to use for authentication to Kibana
    CaCerts []string
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    Endpoints []string
    Insecure bool
    Disable TLS certificate validation
    Password string
    Password to use for API authentication to Kibana.
    Username string
    Username to use for API authentication to Kibana.
    api_key string
    API Key to use for authentication to Kibana
    bearer_token string
    Bearer Token to use for authentication to Kibana
    ca_certs list(string)
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints list(string)
    insecure bool
    Disable TLS certificate validation
    password string
    Password to use for API authentication to Kibana.
    username string
    Username to use for API authentication to Kibana.
    apiKey String
    API Key to use for authentication to Kibana
    bearerToken String
    Bearer Token to use for authentication to Kibana
    caCerts List<String>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints List<String>
    insecure Boolean
    Disable TLS certificate validation
    password String
    Password to use for API authentication to Kibana.
    username String
    Username to use for API authentication to Kibana.
    apiKey string
    API Key to use for authentication to Kibana
    bearerToken string
    Bearer Token to use for authentication to Kibana
    caCerts string[]
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints string[]
    insecure boolean
    Disable TLS certificate validation
    password string
    Password to use for API authentication to Kibana.
    username string
    Username to use for API authentication to Kibana.
    api_key str
    API Key to use for authentication to Kibana
    bearer_token str
    Bearer Token to use for authentication to Kibana
    ca_certs Sequence[str]
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints Sequence[str]
    insecure bool
    Disable TLS certificate validation
    password str
    Password to use for API authentication to Kibana.
    username str
    Username to use for API authentication to Kibana.
    apiKey String
    API Key to use for authentication to Kibana
    bearerToken String
    Bearer Token to use for authentication to Kibana
    caCerts List<String>
    A list of paths to CA certificates to validate the certificate presented by the Kibana server.
    endpoints List<String>
    insecure Boolean
    Disable TLS certificate validation
    password String
    Password to use for API authentication to Kibana.
    username String
    Username to use for API authentication to Kibana.

    KibanaAgentbuilderToolTimeouts, KibanaAgentbuilderToolTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    read String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    elasticstack
    Viewing docs for elasticstack 0.16.5
    published on Sunday, Sep 13, 2026 by elastic
    Schema (JSON)
    elastic/terraform-provider-elasticstack

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial