elasticstack.getKibanaAgentbuilderTool

elasticstack 0.14.5, Apr 23 26

Viewing docs for elasticstack 0.14.5
published on Thursday, Apr 23, 2026 by elastic

Example Usage

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

// Read a tool by ID
const myTool = elasticstack.getKibanaAgentbuilderTool({
    id: "my-esql-tool",
});
// Read a workflow-type tool and include the referenced workflow
const myWorkflowTool = elasticstack.getKibanaAgentbuilderTool({
    id: "my-workflow-tool",
    includeWorkflow: true,
});
export const workflowYaml = myWorkflowTool.then(myWorkflowTool => myWorkflowTool.workflowConfigurationYaml);

import pulumi
import pulumi_elasticstack as elasticstack

# Read a tool by ID
my_tool = elasticstack.get_kibana_agentbuilder_tool(id="my-esql-tool")
# Read a workflow-type tool and include the referenced workflow
my_workflow_tool = elasticstack.get_kibana_agentbuilder_tool(id="my-workflow-tool",
    include_workflow=True)
pulumi.export("workflowYaml", my_workflow_tool.workflow_configuration_yaml)

package main

import (
	"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 {
		// Read a tool by ID
		_, err := elasticstack.LookupKibanaAgentbuilderTool(ctx, &elasticstack.LookupKibanaAgentbuilderToolArgs{
			Id: "my-esql-tool",
		}, nil)
		if err != nil {
			return err
		}
		// Read a workflow-type tool and include the referenced workflow
		myWorkflowTool, err := elasticstack.LookupKibanaAgentbuilderTool(ctx, &elasticstack.LookupKibanaAgentbuilderToolArgs{
			Id:              "my-workflow-tool",
			IncludeWorkflow: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("workflowYaml", myWorkflowTool.WorkflowConfigurationYaml)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Read a tool by ID
    var myTool = Elasticstack.GetKibanaAgentbuilderTool.Invoke(new()
    {
        Id = "my-esql-tool",
    });

    // Read a workflow-type tool and include the referenced workflow
    var myWorkflowTool = Elasticstack.GetKibanaAgentbuilderTool.Invoke(new()
    {
        Id = "my-workflow-tool",
        IncludeWorkflow = true,
    });

    return new Dictionary<string, object?>
    {
        ["workflowYaml"] = myWorkflowTool.Apply(getKibanaAgentbuilderToolResult => getKibanaAgentbuilderToolResult.WorkflowConfigurationYaml),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticstackFunctions;
import com.pulumi.elasticstack.inputs.GetKibanaAgentbuilderToolArgs;
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) {
        // Read a tool by ID
        final var myTool = ElasticstackFunctions.getKibanaAgentbuilderTool(GetKibanaAgentbuilderToolArgs.builder()
            .id("my-esql-tool")
            .build());

        // Read a workflow-type tool and include the referenced workflow
        final var myWorkflowTool = ElasticstackFunctions.getKibanaAgentbuilderTool(GetKibanaAgentbuilderToolArgs.builder()
            .id("my-workflow-tool")
            .includeWorkflow(true)
            .build());

        ctx.export("workflowYaml", myWorkflowTool.workflowConfigurationYaml());
    }
}

variables:
  # Read a tool by ID
  myTool:
    fn::invoke:
      function: elasticstack:getKibanaAgentbuilderTool
      arguments:
        id: my-esql-tool
  # Read a workflow-type tool and include the referenced workflow
  myWorkflowTool:
    fn::invoke:
      function: elasticstack:getKibanaAgentbuilderTool
      arguments:
        id: my-workflow-tool
        includeWorkflow: true
outputs:
  workflowYaml: ${myWorkflowTool.workflowConfigurationYaml}

Using getKibanaAgentbuilderTool

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 getKibanaAgentbuilderTool(args: GetKibanaAgentbuilderToolArgs, opts?: InvokeOptions): Promise<GetKibanaAgentbuilderToolResult>
function getKibanaAgentbuilderToolOutput(args: GetKibanaAgentbuilderToolOutputArgs, opts?: InvokeOptions): Output<GetKibanaAgentbuilderToolResult>

def get_kibana_agentbuilder_tool(id: Optional[str] = None,
                                 include_workflow: Optional[bool] = None,
                                 kibana_connections: Optional[Sequence[GetKibanaAgentbuilderToolKibanaConnection]] = None,
                                 space_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetKibanaAgentbuilderToolResult
def get_kibana_agentbuilder_tool_output(id: pulumi.Input[Optional[str]] = None,
                                 include_workflow: pulumi.Input[Optional[bool]] = None,
                                 kibana_connections: pulumi.Input[Optional[Sequence[pulumi.Input[GetKibanaAgentbuilderToolKibanaConnectionArgs]]]] = None,
                                 space_id: pulumi.Input[Optional[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetKibanaAgentbuilderToolResult]

func LookupKibanaAgentbuilderTool(ctx *Context, args *LookupKibanaAgentbuilderToolArgs, opts ...InvokeOption) (*LookupKibanaAgentbuilderToolResult, error)
func LookupKibanaAgentbuilderToolOutput(ctx *Context, args *LookupKibanaAgentbuilderToolOutputArgs, opts ...InvokeOption) LookupKibanaAgentbuilderToolResultOutput

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

public static class GetKibanaAgentbuilderTool 
{
    public static Task<GetKibanaAgentbuilderToolResult> InvokeAsync(GetKibanaAgentbuilderToolArgs args, InvokeOptions? opts = null)
    public static Output<GetKibanaAgentbuilderToolResult> Invoke(GetKibanaAgentbuilderToolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKibanaAgentbuilderToolResult> getKibanaAgentbuilderTool(GetKibanaAgentbuilderToolArgs args, InvokeOptions options)
public static Output<GetKibanaAgentbuilderToolResult> getKibanaAgentbuilderTool(GetKibanaAgentbuilderToolArgs args, InvokeOptions options)

fn::invoke:
  function: elasticstack:index/getKibanaAgentbuilderTool:getKibanaAgentbuilderTool
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The tool ID to look up.
IncludeWorkflow bool: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
KibanaConnections List<GetKibanaAgentbuilderToolKibanaConnection>: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

Id string: The tool ID to look up.
IncludeWorkflow bool: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
KibanaConnections []GetKibanaAgentbuilderToolKibanaConnection: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

id String: The tool ID to look up.
includeWorkflow Boolean: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
kibanaConnections List<GetKibanaAgentbuilderToolKibanaConnection>: Kibana connection configuration block.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.

id string: The tool ID to look up.
includeWorkflow boolean: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
kibanaConnections GetKibanaAgentbuilderToolKibanaConnection[]: Kibana connection configuration block.
spaceId string: An identifier for the space. If space_id is not provided, the default space is used.

id str: The tool ID to look up.
include_workflow bool: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
kibana_connections Sequence[GetKibanaAgentbuilderToolKibanaConnection]: Kibana connection configuration block.
space_id str: An identifier for the space. If space_id is not provided, the default space is used.

id String: The tool ID to look up.
includeWorkflow Boolean: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
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.

getKibanaAgentbuilderTool Result

The following output properties are available:

Configuration string: The tool configuration in JSON format.
Description string: Description of what the tool does.
Id string: The tool ID to look up.
Readonly bool: Whether the tool is read-only.
Tags List<string>: Tags for categorizing and organizing tools.
ToolId string: The ID of the tool.
Type string: The type of the tool (esql, index_search, workflow, mcp).
WorkflowConfigurationYaml string: The YAML configuration of the referenced workflow. Only populated when include_workflow is true.
WorkflowId string: The ID of the referenced workflow. Only populated when include_workflow is true.
IncludeWorkflow bool: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
KibanaConnections List<GetKibanaAgentbuilderToolKibanaConnection>: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

Configuration string: The tool configuration in JSON format.
Description string: Description of what the tool does.
Id string: The tool ID to look up.
Readonly bool: Whether the tool is read-only.
Tags []string: Tags for categorizing and organizing tools.
ToolId string: The ID of the tool.
Type string: The type of the tool (esql, index_search, workflow, mcp).
WorkflowConfigurationYaml string: The YAML configuration of the referenced workflow. Only populated when include_workflow is true.
WorkflowId string: The ID of the referenced workflow. Only populated when include_workflow is true.
IncludeWorkflow bool: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
KibanaConnections []GetKibanaAgentbuilderToolKibanaConnection: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

configuration String: The tool configuration in JSON format.
description String: Description of what the tool does.
id String: The tool ID to look up.
readonly Boolean: Whether the tool is read-only.
tags List<String>: Tags for categorizing and organizing tools.
toolId String: The ID of the tool.
type String: The type of the tool (esql, index_search, workflow, mcp).
workflowConfigurationYaml String: The YAML configuration of the referenced workflow. Only populated when include_workflow is true.
workflowId String: The ID of the referenced workflow. Only populated when include_workflow is true.
includeWorkflow Boolean: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
kibanaConnections List<GetKibanaAgentbuilderToolKibanaConnection>: Kibana connection configuration block.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.

configuration string: The tool configuration in JSON format.
description string: Description of what the tool does.
id string: The tool ID to look up.
readonly boolean: Whether the tool is read-only.
tags string[]: Tags for categorizing and organizing tools.
toolId string: The ID of the tool.
type string: The type of the tool (esql, index_search, workflow, mcp).
workflowConfigurationYaml string: The YAML configuration of the referenced workflow. Only populated when include_workflow is true.
workflowId string: The ID of the referenced workflow. Only populated when include_workflow is true.
includeWorkflow boolean: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
kibanaConnections GetKibanaAgentbuilderToolKibanaConnection[]: Kibana connection configuration block.
spaceId string: An identifier for the space. If space_id is not provided, the default space is used.

configuration str: The tool configuration in JSON format.
description str: Description of what the tool does.
id str: The tool ID to look up.
readonly bool: Whether the tool is read-only.
tags Sequence[str]: Tags for categorizing and organizing tools.
tool_id str: The ID of the tool.
type str: The type of the tool (esql, index_search, workflow, mcp).
workflow_configuration_yaml str: The YAML configuration of the referenced workflow. Only populated when include_workflow is true.
workflow_id str: The ID of the referenced workflow. Only populated when include_workflow is true.
include_workflow bool: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
kibana_connections Sequence[GetKibanaAgentbuilderToolKibanaConnection]: Kibana connection configuration block.
space_id str: An identifier for the space. If space_id is not provided, the default space is used.

configuration String: The tool configuration in JSON format.
description String: Description of what the tool does.
id String: The tool ID to look up.
readonly Boolean: Whether the tool is read-only.
tags List<String>: Tags for categorizing and organizing tools.
toolId String: The ID of the tool.
type String: The type of the tool (esql, index_search, workflow, mcp).
workflowConfigurationYaml String: The YAML configuration of the referenced workflow. Only populated when include_workflow is true.
workflowId String: The ID of the referenced workflow. Only populated when include_workflow is true.
includeWorkflow Boolean: When true, the workflow referenced by this tool will also be included. Only valid when the tool type is workflow. Requires Kibana 9.4.0 or above. Defaults to false.
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.

Supporting Types

GetKibanaAgentbuilderToolKibanaConnection

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.

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.