elasticstack.getKibanaAgentbuilderAgent

elasticstack 0.14.5, Apr 23 26

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

Schema (JSON)

elastic/terraform-provider-elasticstack

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

Schema (JSON)

elastic/terraform-provider-elasticstack

Example Usage

Export an agent (with dependencies for cross-cluster import)

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

const config = new pulumi.Config();
// The agent ID to export (plain id, or `<space_id>/<agent_id>` if space_id is not set on the data source).
const agentId = config.require("agentId");
// Kibana space for the agent. Leave null for the default space.
const spaceId = config.get("spaceId");
const example = elasticstack.getKibanaAgentbuilderAgent({
    agentId: agentId,
    spaceId: spaceId,
    includeDependencies: true,
});
export const agentExport = example;

import pulumi
import pulumi_elasticstack as elasticstack

config = pulumi.Config()
# The agent ID to export (plain id, or `<space_id>/<agent_id>` if space_id is not set on the data source).
agent_id = config.require("agentId")
# Kibana space for the agent. Leave null for the default space.
space_id = config.get_object("spaceId")
if space_id is None:
    space_id = None
example = elasticstack.get_kibana_agentbuilder_agent(agent_id=agent_id,
    space_id=space_id,
    include_dependencies=True)
pulumi.export("agentExport", example)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		// The agent ID to export (plain id, or `<space_id>/<agent_id>` if space_id is not set on the data source).
		agentId := cfg.Require("agentId")
		// Kibana space for the agent. Leave null for the default space.
		spaceId := nil
		if param := cfg.GetObject("spaceId"); param != nil {
			spaceId = param
		}
		example, err := elasticstack.LookupKibanaAgentbuilderAgent(ctx, &elasticstack.LookupKibanaAgentbuilderAgentArgs{
			AgentId:             agentId,
			SpaceId:             pulumi.StringRef(spaceId),
			IncludeDependencies: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("agentExport", example)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    // The agent ID to export (plain id, or `<space_id>/<agent_id>` if space_id is not set on the data source).
    var agentId = config.Require("agentId");
    // Kibana space for the agent. Leave null for the default space.
    var spaceId = config.Get("spaceId");
    var example = Elasticstack.GetKibanaAgentbuilderAgent.Invoke(new()
    {
        AgentId = agentId,
        SpaceId = spaceId,
        IncludeDependencies = true,
    });

    return new Dictionary<string, object?>
    {
        ["agentExport"] = example,
    };
});

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.GetKibanaAgentbuilderAgentArgs;
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 config = ctx.config();
        final var agentId = config.get("agentId");
        final var spaceId = config.get("spaceId").orElse(null);
        final var example = ElasticstackFunctions.getKibanaAgentbuilderAgent(GetKibanaAgentbuilderAgentArgs.builder()
            .agentId(agentId)
            .spaceId(spaceId)
            .includeDependencies(true)
            .build());

        ctx.export("agentExport", example);
    }
}

configuration:
  agentId:
    type: string
  spaceId:
    type: union(none, string)
    default: null
variables:
  example:
    fn::invoke:
      function: elasticstack:getKibanaAgentbuilderAgent
      arguments:
        agentId: ${agentId}
        spaceId: ${spaceId}
        includeDependencies: true
outputs:
  agentExport: ${example}

Using getKibanaAgentbuilderAgent

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 getKibanaAgentbuilderAgent(args: GetKibanaAgentbuilderAgentArgs, opts?: InvokeOptions): Promise<GetKibanaAgentbuilderAgentResult>
function getKibanaAgentbuilderAgentOutput(args: GetKibanaAgentbuilderAgentOutputArgs, opts?: InvokeOptions): Output<GetKibanaAgentbuilderAgentResult>

def get_kibana_agentbuilder_agent(agent_id: Optional[str] = None,
                                  include_dependencies: Optional[bool] = None,
                                  kibana_connections: Optional[Sequence[GetKibanaAgentbuilderAgentKibanaConnection]] = None,
                                  space_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetKibanaAgentbuilderAgentResult
def get_kibana_agentbuilder_agent_output(agent_id: pulumi.Input[Optional[str]] = None,
                                  include_dependencies: pulumi.Input[Optional[bool]] = None,
                                  kibana_connections: pulumi.Input[Optional[Sequence[pulumi.Input[GetKibanaAgentbuilderAgentKibanaConnectionArgs]]]] = None,
                                  space_id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetKibanaAgentbuilderAgentResult]

func LookupKibanaAgentbuilderAgent(ctx *Context, args *LookupKibanaAgentbuilderAgentArgs, opts ...InvokeOption) (*LookupKibanaAgentbuilderAgentResult, error)
func LookupKibanaAgentbuilderAgentOutput(ctx *Context, args *LookupKibanaAgentbuilderAgentOutputArgs, opts ...InvokeOption) LookupKibanaAgentbuilderAgentResultOutput

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

public static class GetKibanaAgentbuilderAgent 
{
    public static Task<GetKibanaAgentbuilderAgentResult> InvokeAsync(GetKibanaAgentbuilderAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetKibanaAgentbuilderAgentResult> Invoke(GetKibanaAgentbuilderAgentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKibanaAgentbuilderAgentResult> getKibanaAgentbuilderAgent(GetKibanaAgentbuilderAgentArgs args, InvokeOptions options)
public static Output<GetKibanaAgentbuilderAgentResult> getKibanaAgentbuilderAgent(GetKibanaAgentbuilderAgentArgs args, InvokeOptions options)

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

The following arguments are supported:

AgentId string: The agent ID.
IncludeDependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
KibanaConnections List<GetKibanaAgentbuilderAgentKibanaConnection>: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

AgentId string: The agent ID.
IncludeDependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
KibanaConnections []GetKibanaAgentbuilderAgentKibanaConnection: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

agentId String: The agent ID.
includeDependencies Boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections List<GetKibanaAgentbuilderAgentKibanaConnection>: Kibana connection configuration block.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.

agentId string: The agent ID.
includeDependencies boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections GetKibanaAgentbuilderAgentKibanaConnection[]: Kibana connection configuration block.
spaceId string: An identifier for the space. If space_id is not provided, the default space is used.

agent_id str: The agent ID.
include_dependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibana_connections Sequence[GetKibanaAgentbuilderAgentKibanaConnection]: Kibana connection configuration block.
space_id str: An identifier for the space. If space_id is not provided, the default space is used.

agentId String: The agent ID.
includeDependencies Boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
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.

getKibanaAgentbuilderAgent Result

The following output properties are available:

AgentId string: The agent ID.
AvatarColor string: Hex color code for the agent avatar (e.g., #BFDBFF).
AvatarSymbol string: Symbol or initials for the agent avatar (e.g., SI).
Description string: The agent description.
Id string: The composite ID of the agent: <space_id>/<agent_id>.
Instructions string: Optional system instructions that define the agent behavior.
Labels List<string>: List of labels for the agent.
Name string: The agent name.
Tools List<GetKibanaAgentbuilderAgentTool>: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
IncludeDependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
KibanaConnections List<GetKibanaAgentbuilderAgentKibanaConnection>: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

AgentId string: The agent ID.
AvatarColor string: Hex color code for the agent avatar (e.g., #BFDBFF).
AvatarSymbol string: Symbol or initials for the agent avatar (e.g., SI).
Description string: The agent description.
Id string: The composite ID of the agent: <space_id>/<agent_id>.
Instructions string: Optional system instructions that define the agent behavior.
Labels []string: List of labels for the agent.
Name string: The agent name.
Tools []GetKibanaAgentbuilderAgentTool: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
IncludeDependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
KibanaConnections []GetKibanaAgentbuilderAgentKibanaConnection: Kibana connection configuration block.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.

agentId String: The agent ID.
avatarColor String: Hex color code for the agent avatar (e.g., #BFDBFF).
avatarSymbol String: Symbol or initials for the agent avatar (e.g., SI).
description String: The agent description.
id String: The composite ID of the agent: <space_id>/<agent_id>.
instructions String: Optional system instructions that define the agent behavior.
labels List<String>: List of labels for the agent.
name String: The agent name.
tools List<GetKibanaAgentbuilderAgentTool>: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
includeDependencies Boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections List<GetKibanaAgentbuilderAgentKibanaConnection>: Kibana connection configuration block.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.

agentId string: The agent ID.
avatarColor string: Hex color code for the agent avatar (e.g., #BFDBFF).
avatarSymbol string: Symbol or initials for the agent avatar (e.g., SI).
description string: The agent description.
id string: The composite ID of the agent: <space_id>/<agent_id>.
instructions string: Optional system instructions that define the agent behavior.
labels string[]: List of labels for the agent.
name string: The agent name.
tools GetKibanaAgentbuilderAgentTool[]: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
includeDependencies boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibanaConnections GetKibanaAgentbuilderAgentKibanaConnection[]: Kibana connection configuration block.
spaceId string: An identifier for the space. If space_id is not provided, the default space is used.

agent_id str: The agent ID.
avatar_color str: Hex color code for the agent avatar (e.g., #BFDBFF).
avatar_symbol str: Symbol or initials for the agent avatar (e.g., SI).
description str: The agent description.
id str: The composite ID of the agent: <space_id>/<agent_id>.
instructions str: Optional system instructions that define the agent behavior.
labels Sequence[str]: List of labels for the agent.
name str: The agent name.
tools Sequence[GetKibanaAgentbuilderAgentTool]: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
include_dependencies bool: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
kibana_connections Sequence[GetKibanaAgentbuilderAgentKibanaConnection]: Kibana connection configuration block.
space_id str: An identifier for the space. If space_id is not provided, the default space is used.

agentId String: The agent ID.
avatarColor String: Hex color code for the agent avatar (e.g., #BFDBFF).
avatarSymbol String: Symbol or initials for the agent avatar (e.g., SI).
description String: The agent description.
id String: The composite ID of the agent: <space_id>/<agent_id>.
instructions String: Optional system instructions that define the agent behavior.
labels List<String>: List of labels for the agent.
name String: The agent name.
tools List<Property Map>: Tools attached to the agent. When includedependencies is true, each entry includes full tool data and workflow YAML for workflow-type tools. When false, only id (composite space/tool), spaceid, and tool_id are set.
includeDependencies Boolean: If true, exports the agent along with its tools and workflows. If omitted, false is used (tool rows only list id, space_id, and tool_id unless this is true).
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

GetKibanaAgentbuilderAgentKibanaConnection

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.

GetKibanaAgentbuilderAgentTool

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.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.
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 for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
WorkflowId string: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

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.
SpaceId string: An identifier for the space. If space_id is not provided, the default space is used.
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 for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
WorkflowId string: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

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.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.
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 for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflowId String: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

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.
spaceId string: An identifier for the space. If space_id is not provided, the default space is used.
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 for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflowId string: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

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.
space_id str: An identifier for the space. If space_id is not provided, the default space is used.
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 for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflow_id str: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.

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.
spaceId String: An identifier for the space. If space_id is not provided, the default space is used.
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 for workflow-type tools. Requires Elastic Stack v9.4.0 or later.
workflowId String: The ID of the referenced workflow. Only populated for workflow-type tools. Requires Elastic Stack v9.4.0 or later.