dockeragent

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 15, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

A Pulumi provider for Docker Agent (docker-agent): define AI agent configurations as typed, validated code and share them as OCI artifacts, the same way `docker agent share push` does.

Index

Constants

View Source
const (
	ApiTypeOpenAIChatCompletions = ApiType("openai_chatcompletions")
	ApiTypeOpenAIResponses       = ApiType("openai_responses")
)
View Source
const (
	// Inject the message into the running turn (the default).
	BusySendModeSteer = BusySendMode("steer")
	// Hold the message until the turn ends.
	BusySendModeQueue = BusySendMode("queue")
)
View Source
const (
	// Leave the artifact in the registry.
	DeleteBehaviorRetain = DeleteBehavior("retain")
	// Delete the pushed manifest from the registry, unless another tag points to the same digest. Registries that do not support deletion (HTTP 405) only produce a warning.
	DeleteBehaviorDelete = DeleteBehavior("delete")
)
View Source
const (
	EvaluatorDecisionAllow = EvaluatorDecision("allow")
	EvaluatorDecisionAsk   = EvaluatorDecision("ask")
	EvaluatorDecisionDeny  = EvaluatorDecision("deny")
)
View Source
const (
	EvaluatorFallbackAsk  = EvaluatorFallback("ask")
	EvaluatorFallbackDeny = EvaluatorFallback("deny")
)
View Source
const (
	EvaluatorTypeBoolean = EvaluatorType("boolean")
	EvaluatorTypeChoice  = EvaluatorType("choice")
	EvaluatorTypeScore   = EvaluatorType("score")
)
View Source
const (
	HarnessEffortLow    = HarnessEffort("low")
	HarnessEffortMedium = HarnessEffort("medium")
	HarnessEffortHigh   = HarnessEffort("high")
	HarnessEffortXHigh  = HarnessEffort("xhigh")
	HarnessEffortMax    = HarnessEffort("max")
)
View Source
const (
	HarnessTypeClaudeCode = HarnessType("claude-code")
	HarnessTypeCodex      = HarnessType("codex")
	HarnessTypePi         = HarnessType("pi")
	HarnessTypeOpenCode   = HarnessType("opencode")
)
View Source
const (
	// Reports and continues (default).
	HookErrorPolicyWarn = HookErrorPolicy("warn")
	// Continues silently.
	HookErrorPolicyIgnore = HookErrorPolicy("ignore")
	// Denies block-capable events.
	HookErrorPolicyBlock = HookErrorPolicy("block")
)
View Source
const (
	// Executes a shell command.
	HookTypeCommand = HookType("command")
	// Invokes a named in-process Go function registered by the runtime.
	HookTypeBuiltin = HookType("builtin")
	// Asks an LLM and translates its reply into the hook's native output (used for LLM-as-a-judge pre_tool_use, summarizers, etc., with no Go code).
	HookTypeModel = HookType("model")
	// Assesses tool input through a named evaluator and applies a separate policy (tool_guard only).
	HookTypeEvaluator = HookType("evaluator")
)
View Source
const (
	HttpMethodGet    = HttpMethod("GET")
	HttpMethodPost   = HttpMethod("POST")
	HttpMethodPut    = HttpMethod("PUT")
	HttpMethodPatch  = HttpMethod("PATCH")
	HttpMethodDelete = HttpMethod("DELETE")
)
View Source
const (
	// Ask for confirmation (the default).
	InterruptConfirmationAlways = InterruptConfirmation("always")
	// Interrupt when Esc is pressed twice within a second.
	InterruptConfirmationDoubleTap = InterruptConfirmation("double-tap")
	// Interrupt immediately.
	InterruptConfirmationNone = InterruptConfirmation("none")
)
View Source
const (
	// Auto-restart on failure with exponential backoff (the default).
	LifecycleProfileResilient = LifecycleProfile("resilient")
	// Fail fast — the agent refuses to start when the toolset is unavailable.
	LifecycleProfileStrict = LifecycleProfile("strict")
	// Single attempt, no auto-restart.
	LifecycleProfileBestEffort = LifecycleProfile("best-effort")
)
View Source
const (
	// Report nothing while the agent runs, and no summary.
	LoggingNone = Logging("none")
	// Show the run's progress as status messages that are replaced by the next one (an agent started, a task was transferred or the conversation handed off, a tool call was approved or rejected, a model fell back to the next one), and log a summary of the run (duration, tool calls, tokens and estimated cost).
	LoggingStatus = Logging("status")
	// `status`, and also log every tool call with its arguments and whether it was approved.
	LoggingTools = Logging("tools")
	// `tools`, and also log the agents' messages and the tools' results.
	LoggingFull = Logging("full")
)
View Source
const (
	RagFusionStrategyRRF                  = RagFusionStrategy("rrf")
	RagFusionStrategyReciprocalRankFusion = RagFusionStrategy("reciprocal_rank_fusion")
	RagFusionStrategyWeighted             = RagFusionStrategy("weighted")
	RagFusionStrategyMax                  = RagFusionStrategy("max")
)
View Source
const (
	RagStrategyTypeBM25               = RagStrategyType("bm25")
	RagStrategyTypeChunkedEmbeddings  = RagStrategyType("chunked-embeddings")
	RagStrategyTypeSemanticEmbeddings = RagStrategyType("semantic-embeddings")
)
View Source
const (
	// Run the agent again only when an input that affects the run changes, including `triggers` (default).
	RerunPolicyOnChange = RerunPolicy("onChange")
	// Run the agent again on every `pulumi up` that includes this resource. Previews show it as an update and its run outputs as unknown; `pulumi refresh` does not.
	RerunPolicyAlways = RerunPolicy("always")
)
View Source
const (
	RestartPolicyNever     = RestartPolicy("never")
	RestartPolicyOnFailure = RestartPolicy("on_failure")
	RestartPolicyAlways    = RestartPolicy("always")
)
View Source
const (
	// Prompt for every tool call.
	SafetyModeStrict = SafetyMode("strict")
	// Auto-approve the tool calls docker-agent's classifier considers safe; prompt for the others.
	SafetyModeBalanced = SafetyMode("balanced")
	// Auto-approve the calls the classifier considers safe and deny every other unmatched call without prompting: the fail-closed profile for unattended runs. Custom permission rules still win.
	SafetyModeRestricted = SafetyMode("restricted")
	// Auto-approve every tool call (the legacy YOLO mode). Review configurations from URLs or OCI registries before running them.
	SafetyModeAutonomous = SafetyMode("autonomous")
)
View Source
const (
	// The default spacing.
	SectionSpacingNormal = SectionSpacing("normal")
	// Less space between sections.
	SectionSpacingCompact = SectionSpacing("compact")
	// More space between sections.
	SectionSpacingRelaxed = SectionSpacing("relaxed")
)
View Source
const (
	// Two lines per agent (the default).
	SidebarInfoModeCompact = SidebarInfoMode("compact")
	// Cards with effort, context and cost metrics.
	SidebarInfoModeDetailed = SidebarInfoMode("detailed")
)
View Source
const (
	// Right of the chat (the default).
	SidebarPositionRight = SidebarPosition("right")
	// Left of the chat.
	SidebarPositionLeft = SidebarPosition("left")
	// A compact horizontal band above the chat.
	SidebarPositionTop = SidebarPosition("top")
	// A compact horizontal band below the chat.
	SidebarPositionBottom = SidebarPosition("bottom")
)
View Source
const (
	// Passes it to the provider's native structured-output support (the default).
	StructuredOutputModeNative = StructuredOutputMode("native")
	// Exposes an internal tool the model must call with the final JSON; the runtime validates the arguments against the schema.
	StructuredOutputModeTool = StructuredOutputMode("tool")
)
View Source
const (
	// Run only the tool calls docker-agent approves without asking (read-only tools, `permissions` allow rules, the configuration's own safety mode); reject the rest. Codex agents run their commands in Codex's workspace-write sandbox.
	ToolApprovalDeny = ToolApproval("deny")
	// Approve every tool call, like `docker agent run --yolo`. Tools run on the machine executing `pulumi up`. Codex agents run without Codex's sandbox.
	ToolApprovalAllow = ToolApproval("allow")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Agent

type Agent struct {
	// Whether to add date information
	AddDate *bool `pulumi:"addDate"`
	// Whether to add a 'description' parameter to tool calls, allowing the LLM to provide context about why it is calling a tool
	AddDescriptionParameter *bool `pulumi:"addDescriptionParameter"`
	// Whether to add environment information
	AddEnvironmentInfo *bool `pulumi:"addEnvironmentInfo"`
	// List of prompt files to add
	AddPromptFiles []string `pulumi:"addPromptFiles"`
	// Also list, by path only, the add_prompt_files names found up to this many directory levels below the working directory (1 = direct subdirectories). Contents are not loaded: the agent reads the ones it needs. Useful in monorepos where each sub-project carries its own AGENTS.md. 0 (default) disables the scan.
	AddPromptFilesDepth *int `pulumi:"addPromptFilesDepth"`
	// Names of top-level 'budgets' entries this agent spends against. Every listed budget must be defined under the top-level 'budgets' key. An agent may list several, in which case all apply and the first to be exhausted stops the run. Agents sharing a budget name share one pot, so a fan-out cannot multiply the ceiling.
	Budgets []string `pulumi:"budgets"`
	// Optional response cache: when the same user question is asked again, replay the previous answer instead of calling the model.
	Cache *ResponseCache `pulumi:"cache"`
	// Enable Code Mode for tools
	CodeModeTools *bool `pulumi:"codeModeTools"`
	// Named commands (`/name`), in the object form: `description`, `instruction`, `agent` or `url`.
	Commands map[string]Command `pulumi:"commands"`
	// Model used to summarize the conversation when this agent's session is compacted (manual /compact, the proactive threshold trigger, or post-overflow recovery). Value can be a model name from the models section or an inline 'provider/model' spec. Highest priority: takes precedence over a compaction_model set on the agent's model or provider; when all are omitted, compaction reuses the agent's own model.
	CompactionModel *string `pulumi:"compactionModel"`
	// Fraction of the model's context window at which proactive auto-compaction triggers for this agent. Must be greater than 0 and at most 1. Defaults to 0.9 (90% of the context window). A compaction_threshold set on the agent's model takes precedence over this value.
	CompactionThreshold *float64 `pulumi:"compactionThreshold"`
	// Description of the agent
	Description *string `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Fallback model configuration for automatic failover and retry behavior
	Fallback *Fallback `pulumi:"fallback"`
	// Name of an agent that unconditionally receives the conversation whenever this agent produces a final response, bypassing the LLM's tool-calling entirely. Guarantees deterministic routing for strict pipelines (e.g. extractor -> summarizer). Can be the name of an agent defined in this config or an external reference. Pin an external OCI reference to an immutable digest (e.g. 'namespace/repo@sha256:...') to avoid a per-run registry lookup. Must not reference the agent itself, and force_handoff chains must not form a cycle.
	ForceHandoff *string `pulumi:"forceHandoff"`
	// List of agents this agent can hand off the conversation to. Can be names of agents defined in this config, external references (OCI images like 'namespace/repo' or URLs), or named external references using 'name:reference' syntax (e.g. 'reviewer:myorg/review-pr'). External agents without an explicit name are named after their last path segment. Pin external OCI references to an immutable digest (e.g. 'namespace/repo@sha256:...') to serve them from cache; tag references are re-resolved against the registry on every run.
	Handoffs []string `pulumi:"handoffs"`
	// External coding harness to run this agent with instead of a docker-agent model provider
	Harness *Harness `pulumi:"harness"`
	// Lifecycle hooks for executing shell commands at various points in the agent's execution
	Hooks *Hooks `pulumi:"hooks"`
	// Skills defined inline in the configuration. Rendered into the `skills` list after the entries of `skills`.
	InlineSkills []InlineSkill `pulumi:"inlineSkills"`
	// Instructions for the agent (the system prompt). docker-agent's YAML list form is the same as one string with the parts joined by a blank line.
	Instruction *string `pulumi:"instruction"`
	// Path(s) to a file or files, relative to the config file's directory, whose contents become the agent's instruction. Accepts a single string or a list of strings; when several files are given their contents are concatenated in order, separated by a blank line. Loaded at startup. Mutually exclusive with 'instruction'. Each path must be a local relative path inside the config directory (absolute paths and '..' traversal are rejected). Only supported for local file-based configs, not OCI/URL sources. The provider validates the configuration in memory, where relative files cannot be read, so `instructionFile` needs `skipValidation: true`. Prefer reading the file in your program and passing its contents as `instruction`.
	InstructionFile []string `pulumi:"instructionFile"`
	// Maximum consecutive identical tool calls before the agent is terminated. Prevents degenerate loops. 0 uses the default of 5.
	MaxConsecutiveToolCalls *int `pulumi:"maxConsecutiveToolCalls"`
	// Maximum number of iterations
	MaxIterations *int `pulumi:"maxIterations"`
	// Maximum number of tokens to keep from old tool call arguments and results. Older tool calls beyond this budget will have their content replaced with a placeholder. Tokens are approximated as len/4. Truncation is disabled by default; set a positive value to enable it. Set to -1 to disable truncation (unlimited tool content).
	MaxOldToolCallTokens *int `pulumi:"maxOldToolCallTokens"`
	// Maximum number of tokens to keep from each tool result when it is added to the session. Oversized results are truncated middle-out: the head and tail are kept and the removed middle is replaced with a truncation marker. Textual documents attached to the result share the same budget. Tokens are approximated as len/4. The cap is disabled by default; set a positive value to enable it. 0 and -1 both leave tool results unbounded.
	MaxToolResultTokens *int `pulumi:"maxToolResultTokens"`
	// Model to use for this agent (can be just model name or provider/model format)
	Model *string `pulumi:"model"`
	// The agent name. It becomes the key under `agents:` and is how other agents reference it in `subAgents`, `handoffs` and `forceHandoff`.
	Name string `pulumi:"name"`
	// Number of history items to keep
	NumHistoryItems *int `pulumi:"numHistoryItems"`
	// When true, makes every one of this agent's toolsets read-only: only tools whose annotations carry a read-only hint are listed and callable, and all other (mutating) tools are filtered out. Equivalent to setting 'readonly: true' on each toolset. A sub-agent or handoff agent is made read-only by setting this flag on that agent's own definition.
	Readonly *bool `pulumi:"readonly"`
	// Enabled by default. When true (the default), the runtime auto-installs the redact_secrets builtin on all three of tool_input_transform (scrubs detected secrets from tool arguments before approval), before_llm_call (scrubs the messages sent to the LLM), and tool_response_transform (scrubs tool output before it reaches event consumers, the persisted session, the post_tool_use hook input, or the next LLM call). Set to false to opt out. The same hook entries can be authored directly in YAML for finer-grained control — see the hooks.tool_response_transform / hooks.before_llm_call / hooks.tool_input_transform sections. Detection uses the portcullis ruleset (GitHub PATs, AWS keys, Stripe / Slack / GitLab tokens, JWTs, private keys, etc.). Each detected span is replaced with the literal '[REDACTED]'.
	RedactSecrets *bool `pulumi:"redactSecrets"`
	// Local agents that this agent's before_agent_run and after_agent_complete hooks may route to. Requires at least one of those hooks; the agent cannot route to itself or to harness agents, and the combined graph of possible routes and force_handoff edges must not contain a cycle.
	Routing *AgentRouting `pulumi:"routing"`
	// Safety mode new sessions started on this agent default to when the user has not chosen one (no --safety/--yolo flag, no alias option, no user-config setting). Takes precedence over the config-wide runtime.safety. A default only: it never overrides a user choice and never replaces the mode stored on a resumed session. 'restricted' is the fail-closed profile for unattended runs: safe calls auto-approve, every other unmatched call is denied without prompting. Trust warning: 'autonomous' auto-approves every tool call — review configs from URLs or OCI registries before running them.
	Safety *SafetyMode `pulumi:"safety"`
	// Enabled by default. When true (the default), the runtime automatically compacts the session: proactively when the estimated context usage crosses the compaction threshold, and reactively to recover from a context-overflow error. Set to false to disable both automatic triggers for this agent; the manual /compact command remains available.
	SessionCompaction *bool `pulumi:"sessionCompaction"`
	// Named commands in the short form `name: instruction`: the string is the prompt sent to the agent. Rendered into the same `commands` map as `commands`; a name must not appear in both.
	SimpleCommands map[string]string `pulumi:"simpleCommands"`
	// Skill sources and names: `local` (skills discovered on the local filesystem; `["local"]` is the same as `skills: true`), HTTP/HTTPS URLs of remote skill sources, or names of skills to include. Rendered into the `skills` list together with `inlineSkills`.
	Skills []string `pulumi:"skills"`
	// Structured output configuration for constraining model responses to a specific JSON schema. Supported by OpenAI (native) and Google Gemini (native). Anthropic requires prompt engineering or tool-based approaches.
	StructuredOutput *StructuredOutput `pulumi:"structuredOutput"`
	// List of sub-agents. Can be names of agents defined in this config, external references (OCI images like 'namespace/repo' or URLs), or named external references using 'name:reference' syntax (e.g. 'reviewer:myorg/review-pr'). External agents without an explicit name are named after their last path segment. Pin external OCI references to an immutable digest (e.g. 'namespace/repo@sha256:...') to serve them from cache; tag references (including the implicit ':latest') are re-resolved against the registry on every run, even when the sub-agent is never invoked.
	SubAgents []string `pulumi:"subAgents"`
	// List of toolsets available to the agent
	Toolsets []Toolset `pulumi:"toolsets"`
	// Names of reusable command groups (defined in the top-level commands section) to merge into this agent. Inline commands on the agent take precedence on name conflicts.
	UseCommands []string `pulumi:"useCommands"`
	// Names of reusable skill groups (defined in the top-level skills section) to merge into this agent. Inline skills on the agent take precedence on name conflicts.
	UseSkills []string `pulumi:"useSkills"`
	// Names of reusable toolset definitions (defined in the top-level toolsets section) to append to this agent's toolsets. Inline toolsets on the agent come first, followed by each referenced toolset in order.
	UseToolsets []string `pulumi:"useToolsets"`
	// Optional welcome message to display when the agent starts
	WelcomeMessage *string `pulumi:"welcomeMessage"`
}

Configuration for a single agent

type AgentArgs

type AgentArgs struct {
	// Whether to add date information
	AddDate pulumi.BoolPtrInput `pulumi:"addDate"`
	// Whether to add a 'description' parameter to tool calls, allowing the LLM to provide context about why it is calling a tool
	AddDescriptionParameter pulumi.BoolPtrInput `pulumi:"addDescriptionParameter"`
	// Whether to add environment information
	AddEnvironmentInfo pulumi.BoolPtrInput `pulumi:"addEnvironmentInfo"`
	// List of prompt files to add
	AddPromptFiles pulumi.StringArrayInput `pulumi:"addPromptFiles"`
	// Also list, by path only, the add_prompt_files names found up to this many directory levels below the working directory (1 = direct subdirectories). Contents are not loaded: the agent reads the ones it needs. Useful in monorepos where each sub-project carries its own AGENTS.md. 0 (default) disables the scan.
	AddPromptFilesDepth pulumi.IntPtrInput `pulumi:"addPromptFilesDepth"`
	// Names of top-level 'budgets' entries this agent spends against. Every listed budget must be defined under the top-level 'budgets' key. An agent may list several, in which case all apply and the first to be exhausted stops the run. Agents sharing a budget name share one pot, so a fan-out cannot multiply the ceiling.
	Budgets pulumi.StringArrayInput `pulumi:"budgets"`
	// Optional response cache: when the same user question is asked again, replay the previous answer instead of calling the model.
	Cache ResponseCachePtrInput `pulumi:"cache"`
	// Enable Code Mode for tools
	CodeModeTools pulumi.BoolPtrInput `pulumi:"codeModeTools"`
	// Named commands (`/name`), in the object form: `description`, `instruction`, `agent` or `url`.
	Commands CommandMapInput `pulumi:"commands"`
	// Model used to summarize the conversation when this agent's session is compacted (manual /compact, the proactive threshold trigger, or post-overflow recovery). Value can be a model name from the models section or an inline 'provider/model' spec. Highest priority: takes precedence over a compaction_model set on the agent's model or provider; when all are omitted, compaction reuses the agent's own model.
	CompactionModel pulumi.StringPtrInput `pulumi:"compactionModel"`
	// Fraction of the model's context window at which proactive auto-compaction triggers for this agent. Must be greater than 0 and at most 1. Defaults to 0.9 (90% of the context window). A compaction_threshold set on the agent's model takes precedence over this value.
	CompactionThreshold pulumi.Float64PtrInput `pulumi:"compactionThreshold"`
	// Description of the agent
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Fallback model configuration for automatic failover and retry behavior
	Fallback FallbackPtrInput `pulumi:"fallback"`
	// Name of an agent that unconditionally receives the conversation whenever this agent produces a final response, bypassing the LLM's tool-calling entirely. Guarantees deterministic routing for strict pipelines (e.g. extractor -> summarizer). Can be the name of an agent defined in this config or an external reference. Pin an external OCI reference to an immutable digest (e.g. 'namespace/repo@sha256:...') to avoid a per-run registry lookup. Must not reference the agent itself, and force_handoff chains must not form a cycle.
	ForceHandoff pulumi.StringPtrInput `pulumi:"forceHandoff"`
	// List of agents this agent can hand off the conversation to. Can be names of agents defined in this config, external references (OCI images like 'namespace/repo' or URLs), or named external references using 'name:reference' syntax (e.g. 'reviewer:myorg/review-pr'). External agents without an explicit name are named after their last path segment. Pin external OCI references to an immutable digest (e.g. 'namespace/repo@sha256:...') to serve them from cache; tag references are re-resolved against the registry on every run.
	Handoffs pulumi.StringArrayInput `pulumi:"handoffs"`
	// External coding harness to run this agent with instead of a docker-agent model provider
	Harness HarnessPtrInput `pulumi:"harness"`
	// Lifecycle hooks for executing shell commands at various points in the agent's execution
	Hooks HooksPtrInput `pulumi:"hooks"`
	// Skills defined inline in the configuration. Rendered into the `skills` list after the entries of `skills`.
	InlineSkills InlineSkillArrayInput `pulumi:"inlineSkills"`
	// Instructions for the agent (the system prompt). docker-agent's YAML list form is the same as one string with the parts joined by a blank line.
	Instruction pulumi.StringPtrInput `pulumi:"instruction"`
	// Path(s) to a file or files, relative to the config file's directory, whose contents become the agent's instruction. Accepts a single string or a list of strings; when several files are given their contents are concatenated in order, separated by a blank line. Loaded at startup. Mutually exclusive with 'instruction'. Each path must be a local relative path inside the config directory (absolute paths and '..' traversal are rejected). Only supported for local file-based configs, not OCI/URL sources. The provider validates the configuration in memory, where relative files cannot be read, so `instructionFile` needs `skipValidation: true`. Prefer reading the file in your program and passing its contents as `instruction`.
	InstructionFile pulumi.StringArrayInput `pulumi:"instructionFile"`
	// Maximum consecutive identical tool calls before the agent is terminated. Prevents degenerate loops. 0 uses the default of 5.
	MaxConsecutiveToolCalls pulumi.IntPtrInput `pulumi:"maxConsecutiveToolCalls"`
	// Maximum number of iterations
	MaxIterations pulumi.IntPtrInput `pulumi:"maxIterations"`
	// Maximum number of tokens to keep from old tool call arguments and results. Older tool calls beyond this budget will have their content replaced with a placeholder. Tokens are approximated as len/4. Truncation is disabled by default; set a positive value to enable it. Set to -1 to disable truncation (unlimited tool content).
	MaxOldToolCallTokens pulumi.IntPtrInput `pulumi:"maxOldToolCallTokens"`
	// Maximum number of tokens to keep from each tool result when it is added to the session. Oversized results are truncated middle-out: the head and tail are kept and the removed middle is replaced with a truncation marker. Textual documents attached to the result share the same budget. Tokens are approximated as len/4. The cap is disabled by default; set a positive value to enable it. 0 and -1 both leave tool results unbounded.
	MaxToolResultTokens pulumi.IntPtrInput `pulumi:"maxToolResultTokens"`
	// Model to use for this agent (can be just model name or provider/model format)
	Model pulumi.StringPtrInput `pulumi:"model"`
	// The agent name. It becomes the key under `agents:` and is how other agents reference it in `subAgents`, `handoffs` and `forceHandoff`.
	Name pulumi.StringInput `pulumi:"name"`
	// Number of history items to keep
	NumHistoryItems pulumi.IntPtrInput `pulumi:"numHistoryItems"`
	// When true, makes every one of this agent's toolsets read-only: only tools whose annotations carry a read-only hint are listed and callable, and all other (mutating) tools are filtered out. Equivalent to setting 'readonly: true' on each toolset. A sub-agent or handoff agent is made read-only by setting this flag on that agent's own definition.
	Readonly pulumi.BoolPtrInput `pulumi:"readonly"`
	// Enabled by default. When true (the default), the runtime auto-installs the redact_secrets builtin on all three of tool_input_transform (scrubs detected secrets from tool arguments before approval), before_llm_call (scrubs the messages sent to the LLM), and tool_response_transform (scrubs tool output before it reaches event consumers, the persisted session, the post_tool_use hook input, or the next LLM call). Set to false to opt out. The same hook entries can be authored directly in YAML for finer-grained control — see the hooks.tool_response_transform / hooks.before_llm_call / hooks.tool_input_transform sections. Detection uses the portcullis ruleset (GitHub PATs, AWS keys, Stripe / Slack / GitLab tokens, JWTs, private keys, etc.). Each detected span is replaced with the literal '[REDACTED]'.
	RedactSecrets pulumi.BoolPtrInput `pulumi:"redactSecrets"`
	// Local agents that this agent's before_agent_run and after_agent_complete hooks may route to. Requires at least one of those hooks; the agent cannot route to itself or to harness agents, and the combined graph of possible routes and force_handoff edges must not contain a cycle.
	Routing AgentRoutingPtrInput `pulumi:"routing"`
	// Safety mode new sessions started on this agent default to when the user has not chosen one (no --safety/--yolo flag, no alias option, no user-config setting). Takes precedence over the config-wide runtime.safety. A default only: it never overrides a user choice and never replaces the mode stored on a resumed session. 'restricted' is the fail-closed profile for unattended runs: safe calls auto-approve, every other unmatched call is denied without prompting. Trust warning: 'autonomous' auto-approves every tool call — review configs from URLs or OCI registries before running them.
	Safety SafetyModePtrInput `pulumi:"safety"`
	// Enabled by default. When true (the default), the runtime automatically compacts the session: proactively when the estimated context usage crosses the compaction threshold, and reactively to recover from a context-overflow error. Set to false to disable both automatic triggers for this agent; the manual /compact command remains available.
	SessionCompaction pulumi.BoolPtrInput `pulumi:"sessionCompaction"`
	// Named commands in the short form `name: instruction`: the string is the prompt sent to the agent. Rendered into the same `commands` map as `commands`; a name must not appear in both.
	SimpleCommands pulumi.StringMapInput `pulumi:"simpleCommands"`
	// Skill sources and names: `local` (skills discovered on the local filesystem; `["local"]` is the same as `skills: true`), HTTP/HTTPS URLs of remote skill sources, or names of skills to include. Rendered into the `skills` list together with `inlineSkills`.
	Skills pulumi.StringArrayInput `pulumi:"skills"`
	// Structured output configuration for constraining model responses to a specific JSON schema. Supported by OpenAI (native) and Google Gemini (native). Anthropic requires prompt engineering or tool-based approaches.
	StructuredOutput StructuredOutputPtrInput `pulumi:"structuredOutput"`
	// List of sub-agents. Can be names of agents defined in this config, external references (OCI images like 'namespace/repo' or URLs), or named external references using 'name:reference' syntax (e.g. 'reviewer:myorg/review-pr'). External agents without an explicit name are named after their last path segment. Pin external OCI references to an immutable digest (e.g. 'namespace/repo@sha256:...') to serve them from cache; tag references (including the implicit ':latest') are re-resolved against the registry on every run, even when the sub-agent is never invoked.
	SubAgents pulumi.StringArrayInput `pulumi:"subAgents"`
	// List of toolsets available to the agent
	Toolsets ToolsetArrayInput `pulumi:"toolsets"`
	// Names of reusable command groups (defined in the top-level commands section) to merge into this agent. Inline commands on the agent take precedence on name conflicts.
	UseCommands pulumi.StringArrayInput `pulumi:"useCommands"`
	// Names of reusable skill groups (defined in the top-level skills section) to merge into this agent. Inline skills on the agent take precedence on name conflicts.
	UseSkills pulumi.StringArrayInput `pulumi:"useSkills"`
	// Names of reusable toolset definitions (defined in the top-level toolsets section) to append to this agent's toolsets. Inline toolsets on the agent come first, followed by each referenced toolset in order.
	UseToolsets pulumi.StringArrayInput `pulumi:"useToolsets"`
	// Optional welcome message to display when the agent starts
	WelcomeMessage pulumi.StringPtrInput `pulumi:"welcomeMessage"`
}

Configuration for a single agent

func (AgentArgs) ElementType

func (AgentArgs) ElementType() reflect.Type

func (AgentArgs) ToAgentOutput

func (i AgentArgs) ToAgentOutput() AgentOutput

func (AgentArgs) ToAgentOutputWithContext

func (i AgentArgs) ToAgentOutputWithContext(ctx context.Context) AgentOutput

type AgentArray

type AgentArray []AgentInput

func (AgentArray) ElementType

func (AgentArray) ElementType() reflect.Type

func (AgentArray) ToAgentArrayOutput

func (i AgentArray) ToAgentArrayOutput() AgentArrayOutput

func (AgentArray) ToAgentArrayOutputWithContext

func (i AgentArray) ToAgentArrayOutputWithContext(ctx context.Context) AgentArrayOutput

type AgentArrayInput

type AgentArrayInput interface {
	pulumi.Input

	ToAgentArrayOutput() AgentArrayOutput
	ToAgentArrayOutputWithContext(context.Context) AgentArrayOutput
}

AgentArrayInput is an input type that accepts AgentArray and AgentArrayOutput values. You can construct a concrete instance of `AgentArrayInput` via:

AgentArray{ AgentArgs{...} }

type AgentArrayOutput

type AgentArrayOutput struct{ *pulumi.OutputState }

func (AgentArrayOutput) ElementType

func (AgentArrayOutput) ElementType() reflect.Type

func (AgentArrayOutput) Index

func (AgentArrayOutput) ToAgentArrayOutput

func (o AgentArrayOutput) ToAgentArrayOutput() AgentArrayOutput

func (AgentArrayOutput) ToAgentArrayOutputWithContext

func (o AgentArrayOutput) ToAgentArrayOutputWithContext(ctx context.Context) AgentArrayOutput

type AgentArtifact

type AgentArtifact struct {
	pulumi.CustomResourceState

	// Additional manifest annotations. They can override the description and the annotations derived from `metadata`, but not `io.docker.agent.version`, `io.docker.cagent.version` or `org.opencontainers.image.created`.
	Annotations pulumi.StringMapOutput `pulumi:"annotations"`
	// The hex-encoded SHA-256 of `yaml` (the layer's diff ID).
	ContentSha256 pulumi.StringOutput `pulumi:"contentSha256"`
	// The `org.opencontainers.image.created` timestamp of the pushed manifest. It only changes when the artifact is pushed again.
	Created pulumi.StringOutput `pulumi:"created"`
	// What to do with the pushed manifest when the resource is deleted. Defaults to `retain`. With `delete`, the manifest is kept (with a warning) if another tag of the repository points to the same digest, if the tags cannot be listed, or if the registry does not support deletion.
	DeleteBehavior DeleteBehaviorOutput `pulumi:"deleteBehavior"`
	// The manifest digest (`sha256:...`).
	Digest pulumi.StringOutput `pulumi:"digest"`
	// The docker-agent version written to the `io.docker.agent.version` annotation.
	DockerAgentVersion pulumi.StringOutput `pulumi:"dockerAgentVersion"`
	// Allow a plain-HTTP or self-signed registry. Without it, plain HTTP is only used as a fallback when HTTPS fails for `localhost`, `*.localhost`, loopback and private (RFC 1918: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) addresses, the same as the `docker agent` CLI; the provider's `forceHttps` option turns that fallback off except for localhost and loopback.
	Insecure pulumi.BoolPtrOutput `pulumi:"insecure"`
	// All annotations of the pushed manifest.
	ManifestAnnotations pulumi.StringMapOutput `pulumi:"manifestAnnotations"`
	// The artifact pinned by digest, `registry/repository@sha256:...`. Use it with `docker agent run` or as a sub-agent reference to get exactly this version.
	PinnedReference pulumi.StringOutput `pulumi:"pinnedReference"`
	// The tag to push to, as `registry/repository:tag`, for example `ghcr.io/my-org/agents/assistant:v1`. The tag defaults to `latest`. Changing it replaces the resource. Registries on `localhost`, `*.localhost`, loopback and private (RFC 1918) addresses may be reached over plain HTTP when HTTPS fails (see `insecure` and the provider's `forceHttps`).
	Reference pulumi.StringOutput `pulumi:"reference"`
	// Skip validating `yaml` with the docker-agent library before pushing.
	SkipValidation pulumi.BoolPtrOutput `pulumi:"skipValidation"`
	// The docker-agent configuration to push, usually the `yaml` output of an `AgentConfig` or the contents of an agent file. The bytes are pushed unchanged.
	Yaml pulumi.StringOutput `pulumi:"yaml"`
}

Shares a Docker Agent configuration through an OCI registry, the same way `docker agent share push` does.

The artifact is byte-compatible with the docker-agent CLI: an OCI manifest with artifact type `application/vnd.docker.agent.config.v1+json`, one layer holding the gzipped YAML, and the `io.docker.agent.version` annotation the CLI requires. Anyone can run it with `docker agent run <reference>`, pull it with `docker agent share pull <reference>`, or reference it as a sub-agent.

Unlike the CLI, the provider keeps the `org.opencontainers.image.created` timestamp in its state and only pushes when `yaml` or `annotations` change, so `pulumi up` without changes pushes nothing and the manifest digest stays stable. A refresh detects when the tag was moved by someone else.

Registry credentials come from the provider's `registryAuth` setting, falling back to the Docker credential store (`docker login`). Like the `docker agent` CLI, the provider tries HTTPS first and falls back to plain HTTP for `localhost`, `*.localhost`, loopback and private (RFC 1918) addresses; set `insecure` for any other plain-HTTP or self-signed registry, and the provider's `forceHttps` option to forbid the private-address fallback.

With `deleteBehavior: delete`, destroying the resource deletes the pushed manifest, unless another tag in the repository points to the same digest (two tags pushed with identical content in the same second) or the tags cannot be listed; the provider then keeps the artifact and logs a warning.

Unless `skipValidation` is set, the preview validates `yaml` with docker-agent and reports every independent problem at once. The artifact is readable by everyone who can pull it, so a secret `yaml` is pushed in plaintext; the provider warns about it.

## Example Usage ### Push an agent to a registry ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// The agent configuration, rendered and validated.
		assistant, err := dockeragent.NewAgentConfig(ctx, "assistant", &dockeragent.AgentConfigArgs{
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Model:       pulumi.String("openai/gpt-5-mini"),
					Instruction: pulumi.String("You are a helpful assistant. Answer briefly."),
				},
			},
		})
		if err != nil {
			return err
		}

		// Pushes the configuration like `docker agent share push`.
		artifact, err := dockeragent.NewAgentArtifact(ctx, "artifact", &dockeragent.AgentArtifactArgs{
			Reference: pulumi.String("ghcr.io/my-org/agents/assistant:v1"),
			Yaml:      assistant.Yaml,
		})
		if err != nil {
			return err
		}
		ctx.Export("pinnedReference", artifact.PinnedReference)
		ctx.Export("digest", artifact.Digest)
		return nil
	})
}

``` ### Push an existing agent file ```go package main

import (

"os"

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func readFileOrPanic(path string) string {
	data, err := os.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return string(data)
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// An agent file kept as raw YAML next to the program.
		agentFile := readFileOrPanic("./pirate.yaml")

		// Deleted from the registry when the resource is destroyed.
		pirate, err := dockeragent.NewAgentArtifact(ctx, "pirate", &dockeragent.AgentArtifactArgs{
			Reference: pulumi.String("localhost:5000/agents/pirate:latest"),
			Yaml:      pulumi.String(agentFile),
			Annotations: pulumi.StringMap{
				"org.opencontainers.image.source": pulumi.String("https://github.com/my-org/agents"),
			},
			DeleteBehavior: dockeragent.DeleteBehaviorDelete,
		})
		if err != nil {
			return err
		}
		ctx.Export("pinnedReference", pirate.PinnedReference)
		return nil
	})
}

```

## Import

An artifact pushed with `docker agent share push` (or by another stack) can be imported by its tag, `<registry>/<repository>:<tag>`. `<registry>/<repository>:<tag>@sha256:<digest>` checks that the tag still points to that digest, and `<registry>/<repository>@sha256:<digest>` imports the one tag of the repository that points to it. The registry is read with the provider's `registryAuth` and the Docker credential store. The imported resource has the pushed `yaml`, exactly as it is stored, the annotations the provider would not have set itself and `deleteBehavior: retain`; its ID is the tag.

```sh $ pulumi import docker-agent:index:AgentArtifact assistant ghcr.io/my-org/agents/assistant:v1 ```

func GetAgentArtifact

func GetAgentArtifact(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AgentArtifactState, opts ...pulumi.ResourceOption) (*AgentArtifact, error)

GetAgentArtifact gets an existing AgentArtifact resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAgentArtifact

func NewAgentArtifact(ctx *pulumi.Context,
	name string, args *AgentArtifactArgs, opts ...pulumi.ResourceOption) (*AgentArtifact, error)

NewAgentArtifact registers a new resource with the given unique name, arguments, and options.

func (*AgentArtifact) ElementType

func (*AgentArtifact) ElementType() reflect.Type

func (*AgentArtifact) ToAgentArtifactOutput

func (i *AgentArtifact) ToAgentArtifactOutput() AgentArtifactOutput

func (*AgentArtifact) ToAgentArtifactOutputWithContext

func (i *AgentArtifact) ToAgentArtifactOutputWithContext(ctx context.Context) AgentArtifactOutput

type AgentArtifactArgs

type AgentArtifactArgs struct {
	// Additional manifest annotations. They can override the description and the annotations derived from `metadata`, but not `io.docker.agent.version`, `io.docker.cagent.version` or `org.opencontainers.image.created`.
	Annotations pulumi.StringMapInput
	// What to do with the pushed manifest when the resource is deleted. Defaults to `retain`. With `delete`, the manifest is kept (with a warning) if another tag of the repository points to the same digest, if the tags cannot be listed, or if the registry does not support deletion.
	DeleteBehavior DeleteBehaviorPtrInput
	// Allow a plain-HTTP or self-signed registry. Without it, plain HTTP is only used as a fallback when HTTPS fails for `localhost`, `*.localhost`, loopback and private (RFC 1918: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) addresses, the same as the `docker agent` CLI; the provider's `forceHttps` option turns that fallback off except for localhost and loopback.
	Insecure pulumi.BoolPtrInput
	// The tag to push to, as `registry/repository:tag`, for example `ghcr.io/my-org/agents/assistant:v1`. The tag defaults to `latest`. Changing it replaces the resource. Registries on `localhost`, `*.localhost`, loopback and private (RFC 1918) addresses may be reached over plain HTTP when HTTPS fails (see `insecure` and the provider's `forceHttps`).
	Reference pulumi.StringInput
	// Skip validating `yaml` with the docker-agent library before pushing.
	SkipValidation pulumi.BoolPtrInput
	// The docker-agent configuration to push, usually the `yaml` output of an `AgentConfig` or the contents of an agent file. The bytes are pushed unchanged.
	Yaml pulumi.StringInput
}

The set of arguments for constructing a AgentArtifact resource.

func (AgentArtifactArgs) ElementType

func (AgentArtifactArgs) ElementType() reflect.Type

type AgentArtifactArray

type AgentArtifactArray []AgentArtifactInput

func (AgentArtifactArray) ElementType

func (AgentArtifactArray) ElementType() reflect.Type

func (AgentArtifactArray) ToAgentArtifactArrayOutput

func (i AgentArtifactArray) ToAgentArtifactArrayOutput() AgentArtifactArrayOutput

func (AgentArtifactArray) ToAgentArtifactArrayOutputWithContext

func (i AgentArtifactArray) ToAgentArtifactArrayOutputWithContext(ctx context.Context) AgentArtifactArrayOutput

type AgentArtifactArrayInput

type AgentArtifactArrayInput interface {
	pulumi.Input

	ToAgentArtifactArrayOutput() AgentArtifactArrayOutput
	ToAgentArtifactArrayOutputWithContext(context.Context) AgentArtifactArrayOutput
}

AgentArtifactArrayInput is an input type that accepts AgentArtifactArray and AgentArtifactArrayOutput values. You can construct a concrete instance of `AgentArtifactArrayInput` via:

AgentArtifactArray{ AgentArtifactArgs{...} }

type AgentArtifactArrayOutput

type AgentArtifactArrayOutput struct{ *pulumi.OutputState }

func (AgentArtifactArrayOutput) ElementType

func (AgentArtifactArrayOutput) ElementType() reflect.Type

func (AgentArtifactArrayOutput) Index

func (AgentArtifactArrayOutput) ToAgentArtifactArrayOutput

func (o AgentArtifactArrayOutput) ToAgentArtifactArrayOutput() AgentArtifactArrayOutput

func (AgentArtifactArrayOutput) ToAgentArtifactArrayOutputWithContext

func (o AgentArtifactArrayOutput) ToAgentArtifactArrayOutputWithContext(ctx context.Context) AgentArtifactArrayOutput

type AgentArtifactInput

type AgentArtifactInput interface {
	pulumi.Input

	ToAgentArtifactOutput() AgentArtifactOutput
	ToAgentArtifactOutputWithContext(ctx context.Context) AgentArtifactOutput
}

type AgentArtifactMap

type AgentArtifactMap map[string]AgentArtifactInput

func (AgentArtifactMap) ElementType

func (AgentArtifactMap) ElementType() reflect.Type

func (AgentArtifactMap) ToAgentArtifactMapOutput

func (i AgentArtifactMap) ToAgentArtifactMapOutput() AgentArtifactMapOutput

func (AgentArtifactMap) ToAgentArtifactMapOutputWithContext

func (i AgentArtifactMap) ToAgentArtifactMapOutputWithContext(ctx context.Context) AgentArtifactMapOutput

type AgentArtifactMapInput

type AgentArtifactMapInput interface {
	pulumi.Input

	ToAgentArtifactMapOutput() AgentArtifactMapOutput
	ToAgentArtifactMapOutputWithContext(context.Context) AgentArtifactMapOutput
}

AgentArtifactMapInput is an input type that accepts AgentArtifactMap and AgentArtifactMapOutput values. You can construct a concrete instance of `AgentArtifactMapInput` via:

AgentArtifactMap{ "key": AgentArtifactArgs{...} }

type AgentArtifactMapOutput

type AgentArtifactMapOutput struct{ *pulumi.OutputState }

func (AgentArtifactMapOutput) ElementType

func (AgentArtifactMapOutput) ElementType() reflect.Type

func (AgentArtifactMapOutput) MapIndex

func (AgentArtifactMapOutput) ToAgentArtifactMapOutput

func (o AgentArtifactMapOutput) ToAgentArtifactMapOutput() AgentArtifactMapOutput

func (AgentArtifactMapOutput) ToAgentArtifactMapOutputWithContext

func (o AgentArtifactMapOutput) ToAgentArtifactMapOutputWithContext(ctx context.Context) AgentArtifactMapOutput

type AgentArtifactOutput

type AgentArtifactOutput struct{ *pulumi.OutputState }

func (AgentArtifactOutput) Annotations

func (o AgentArtifactOutput) Annotations() pulumi.StringMapOutput

Additional manifest annotations. They can override the description and the annotations derived from `metadata`, but not `io.docker.agent.version`, `io.docker.cagent.version` or `org.opencontainers.image.created`.

func (AgentArtifactOutput) ContentSha256

func (o AgentArtifactOutput) ContentSha256() pulumi.StringOutput

The hex-encoded SHA-256 of `yaml` (the layer's diff ID).

func (AgentArtifactOutput) Created

The `org.opencontainers.image.created` timestamp of the pushed manifest. It only changes when the artifact is pushed again.

func (AgentArtifactOutput) DeleteBehavior

func (o AgentArtifactOutput) DeleteBehavior() DeleteBehaviorOutput

What to do with the pushed manifest when the resource is deleted. Defaults to `retain`. With `delete`, the manifest is kept (with a warning) if another tag of the repository points to the same digest, if the tags cannot be listed, or if the registry does not support deletion.

func (AgentArtifactOutput) Digest

The manifest digest (`sha256:...`).

func (AgentArtifactOutput) DockerAgentVersion

func (o AgentArtifactOutput) DockerAgentVersion() pulumi.StringOutput

The docker-agent version written to the `io.docker.agent.version` annotation.

func (AgentArtifactOutput) ElementType

func (AgentArtifactOutput) ElementType() reflect.Type

func (AgentArtifactOutput) Insecure

Allow a plain-HTTP or self-signed registry. Without it, plain HTTP is only used as a fallback when HTTPS fails for `localhost`, `*.localhost`, loopback and private (RFC 1918: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) addresses, the same as the `docker agent` CLI; the provider's `forceHttps` option turns that fallback off except for localhost and loopback.

func (AgentArtifactOutput) ManifestAnnotations

func (o AgentArtifactOutput) ManifestAnnotations() pulumi.StringMapOutput

All annotations of the pushed manifest.

func (AgentArtifactOutput) PinnedReference

func (o AgentArtifactOutput) PinnedReference() pulumi.StringOutput

The artifact pinned by digest, `registry/repository@sha256:...`. Use it with `docker agent run` or as a sub-agent reference to get exactly this version.

func (AgentArtifactOutput) Reference

func (o AgentArtifactOutput) Reference() pulumi.StringOutput

The tag to push to, as `registry/repository:tag`, for example `ghcr.io/my-org/agents/assistant:v1`. The tag defaults to `latest`. Changing it replaces the resource. Registries on `localhost`, `*.localhost`, loopback and private (RFC 1918) addresses may be reached over plain HTTP when HTTPS fails (see `insecure` and the provider's `forceHttps`).

func (AgentArtifactOutput) SkipValidation

func (o AgentArtifactOutput) SkipValidation() pulumi.BoolPtrOutput

Skip validating `yaml` with the docker-agent library before pushing.

func (AgentArtifactOutput) ToAgentArtifactOutput

func (o AgentArtifactOutput) ToAgentArtifactOutput() AgentArtifactOutput

func (AgentArtifactOutput) ToAgentArtifactOutputWithContext

func (o AgentArtifactOutput) ToAgentArtifactOutputWithContext(ctx context.Context) AgentArtifactOutput

func (AgentArtifactOutput) Yaml

The docker-agent configuration to push, usually the `yaml` output of an `AgentConfig` or the contents of an agent file. The bytes are pushed unchanged.

type AgentArtifactState

type AgentArtifactState struct {
}

func (AgentArtifactState) ElementType

func (AgentArtifactState) ElementType() reflect.Type

type AgentConfig

type AgentConfig struct {
	pulumi.CustomResourceState

	// The agent names, in order.
	AgentNames pulumi.StringArrayOutput `pulumi:"agentNames"`
	// The agents, in order. At least one agent is required. The agent named `root`, or else the first agent, is the default agent. Rendered as the `agents` map keyed by each agent's `name`.
	Agents AgentArrayOutput `pulumi:"agents"`
	// Ceilings on what a single run may consume before the agent is stopped, regardless of which agent spends. Scoped to a run and shared by every sub-session spawned inside it, so delegated work spends against the same budget as its parent.
	Budget BudgetPtrOutput `pulumi:"budget"`
	// Reusable, named budget definitions. An agent opts into one by listing its name in its 'budgets' field. A named budget is a single shared pot: when several agents reference the same name they draw from the SAME ceiling rather than each getting a copy, so a fan-out to N sub-agents cannot spend N times the limit. Give agents distinct budget names when you want independent pots.
	Budgets BudgetMapOutput `pulumi:"budgets"`
	// Map of reusable, named command groups. Define command sets here and reference them by name from an agent's use_commands to avoid duplication.
	Commands CommandGroupMapOutput `pulumi:"commands"`
	// The agent docker-agent starts by default: `root` if an agent has that name, else the first agent.
	DefaultAgent pulumi.StringOutput `pulumi:"defaultAgent"`
	// The docker-agent library version the configuration was validated against.
	DockerAgentVersion pulumi.StringOutput `pulumi:"dockerAgentVersion"`
	// Named provider-backed assessments, independent of chat models and decision policies.
	Evaluators EvaluatorMapOutput `pulumi:"evaluators"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapOutput `pulumi:"extra"`
	// Named YAML patches applied on top of the rest of the document when enabled at run time (e.g. 'docker agent run --flavor <name>'). Each flavor is a partial config document merged with JSON Merge Patch semantics: objects merge recursively, scalars and arrays replace, null deletes a key. A key ending in '+' appends its items to the existing array (e.g. 'toolsets+:'); a scalar existing value is promoted to a one-element array first, so 'instruction+:' extends a string instruction. A key ending in '-' removes entries — from an object by key name, from an array by scalar equality or partial object match (e.g. 'toolsets-: [{type: shell}]'). Enabled flavors are applied in the order they were requested; requested flavors not defined here are ignored. Each flavor is a free-form YAML patch with the same structure as the configuration (snake_case keys), rendered verbatim.
	Flavors pulumi.MapMapOutput `pulumi:"flavors"`
	// Map of reusable MCP server definitions. Define MCP servers here and reference them by name from agent toolsets to avoid duplication.
	Mcps McpDefinitionMapOutput `pulumi:"mcps"`
	// Configuration metadata
	Metadata MetadataPtrOutput `pulumi:"metadata"`
	// Map of model configurations
	Models ModelDefMapOutput `pulumi:"models"`
	// Tool permission configuration for controlling tool approval behavior
	Permissions PermissionsPtrOutput `pulumi:"permissions"`
	// Map of custom provider configurations. Providers define reusable defaults (base_url, token_key, api_type) that models can reference.
	Providers ProviderDefMapOutput `pulumi:"providers"`
	// Map of reusable RAG source definitions. Define RAG sources here and reference them by name from agent toolsets to avoid duplication.
	Rag RagSourceMapOutput `pulumi:"rag"`
	// Best effort list of the environment variables the configured models need at run time, for example `OPENAI_API_KEY`, `ANTHROPIC_API_KEY` or the `tokenKey` values.
	RequiredEnvVars pulumi.StringArrayOutput `pulumi:"requiredEnvVars"`
	// Execution-time defaults the agent author wants applied. Values act as defaults only — explicit CLI flags or user-config settings always win.
	Runtime RuntimeDefaultsPtrOutput `pulumi:"runtime"`
	// The hex-encoded SHA-256 of `yaml`.
	Sha256 pulumi.StringOutput `pulumi:"sha256"`
	// Map of reusable, named skill groups. Define skill sets here and reference them by name from an agent's use_skills to avoid duplication.
	Skills SkillSetMapOutput `pulumi:"skills"`
	// Skip validating the rendered YAML with the docker-agent library, and accept enum values (such as a `safety` mode) that this provider version does not list. Use it for configurations that rely on docker-agent features newer than v1.150.0.
	SkipValidation pulumi.BoolPtrOutput `pulumi:"skipValidation"`
	// Map of reusable, named toolset definitions. Define a toolset here and reference it by name from an agent's use_toolsets to share the same toolset across multiple agents.
	Toolsets ToolsetMapOutput `pulumi:"toolsets"`
	// The docker-agent configuration schema version. Allowed values: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`.
	Version pulumi.StringOutput `pulumi:"version"`
	// The rendered docker-agent YAML document. Identical inputs always render the same bytes: agents keep their order and all map keys are sorted.
	Yaml pulumi.StringOutput `pulumi:"yaml"`
}

A typed, validated [Docker Agent](https://docs.docker.com/ai/docker-agent/) configuration.

`AgentConfig` renders its inputs into a deterministic docker-agent YAML document (output `yaml`) and validates it with the docker-agent library during preview, so typos, unknown fields, references to undefined models or agents and unknown toolset types fail before anything is deployed. The resource is purely local: it creates nothing outside of the Pulumi state. Feed `yaml` into an `AgentArtifact` to share the agent through an OCI registry, or write it to a file for `docker agent run`.

Every key of the docker-agent configuration (version 16) is a typed input: agents, models, providers, toolsets, MCP and RAG definitions, commands, skills, hooks, permissions, sandbox mode (`runtime`), budgets, evaluators, structured output and flavors. Inputs are camelCase and rendered as the snake_case keys of the docker-agent YAML. Agents are rendered in list order. The agent named `root`, or else the first agent, is the default agent. Each object also has an `extra` map, merged verbatim into the YAML, for keys added by docker-agent releases newer than the one this provider pins. `instructionFile` needs `skipValidation` because validation happens in memory; read the file in your program and pass its contents as `instruction`.

Closed value sets, such as the `safety` modes or a hook's `type`, are enums. A value that this provider version does not list fails on its property during preview unless `skipValidation` is set; in C# and Java, whose enums cannot hold other values, set such a value through the object's `extra` map (for example `runtime.extra`), which replaces the typed key.

The preview reports every independent problem at once, each attached to the input that caused it, for example `property agents[0].subAgents ... has a problem: invalid docker-agent configuration: agent 'root' references non-existent sub-agent 'missing'`. docker-agent stops at the first problem; the provider removes the faulty value and validates again to find the rest. A problem with a whole definition (a model, provider or toolset) is reported alone. The provider also warns about `headers` and `env` values that look like literal credentials: they end up in `yaml` and in every artifact made from it, so use a `${env.NAME}` placeholder that docker-agent resolves at run time instead.

## Example Usage ### A single agent with tools ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// A typed docker-agent configuration, validated during `pulumi preview`.
		assistant, err := dockeragent.NewAgentConfig(ctx, "assistant", &dockeragent.AgentConfigArgs{
			Metadata: &dockeragent.MetadataArgs{
				Author:  pulumi.String("platform-team"),
				License: pulumi.String("Apache-2.0"),
			},
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Model:       pulumi.String("openai/gpt-5-mini"),
					Description: pulumi.String("A helpful assistant"),
					Instruction: pulumi.String("You are a helpful assistant. Answer briefly."),
					Toolsets: dockeragent.ToolsetArray{
						&dockeragent.ToolsetArgs{
							Type: pulumi.String("think"),
						},
						&dockeragent.ToolsetArgs{
							Type: pulumi.String("mcp"),
							Ref:  pulumi.String("docker:duckduckgo"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("agentYaml", assistant.Yaml)
		ctx.Export("requiredEnvVars", assistant.RequiredEnvVars)
		return nil
	})
}

``` ### A team with a named model ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// `root` delegates research questions to the `researcher` sub-agent.
		team, err := dockeragent.NewAgentConfig(ctx, "team", &dockeragent.AgentConfigArgs{
			Models: dockeragent.ModelDefMap{
				"fast": &dockeragent.ModelDefArgs{
					Provider:  pulumi.String("anthropic"),
					Model:     pulumi.String("claude-haiku-4-5"),
					MaxTokens: pulumi.Int(8192),
				},
			},
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Model:       pulumi.String("fast"),
					Instruction: pulumi.String("Coordinate the team and delegate research questions."),
					SubAgents: pulumi.StringArray{
						pulumi.String("researcher"),
					},
				},
				&dockeragent.AgentArgs{
					Name:        pulumi.String("researcher"),
					Model:       pulumi.String("openai/gpt-5-mini"),
					Description: pulumi.String("Searches the web"),
					Instruction: pulumi.String("Research the question and report sources."),
					Toolsets: dockeragent.ToolsetArray{
						&dockeragent.ToolsetArgs{
							Type: pulumi.String("fetch"),
						},
					},
					MaxConsecutiveToolCalls: pulumi.Int(10),
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("agentNames", team.AgentNames)
		ctx.Export("defaultAgent", team.DefaultAgent)
		return nil
	})
}

``` ### Sandbox mode, a safety mode, hooks and a budget ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Runs in a sandbox by default, with the fail-closed `restricted` safety mode.
		sandboxed, err := dockeragent.NewAgentConfig(ctx, "sandboxed", &dockeragent.AgentConfigArgs{
			Runtime: &dockeragent.RuntimeDefaultsArgs{
				Sandbox: pulumi.Bool(true),
				Safety:  dockeragent.SafetyModeRestricted,
				NetworkAllowlist: pulumi.StringArray{
					pulumi.String("api.github.com"),
					pulumi.String("registry.npmjs.org:443"),
				},
			},
			Permissions: &dockeragent.PermissionsArgs{
				Deny: pulumi.StringArray{
					pulumi.String("shell:cmd=sudo*"),
				},
			},
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Model:       pulumi.String("anthropic/claude-sonnet-4-5"),
					Instruction: pulumi.String("Run the test suite and fix the failing tests."),
					Toolsets: dockeragent.ToolsetArray{
						&dockeragent.ToolsetArgs{
							Type: pulumi.String("shell"),
						},
						&dockeragent.ToolsetArgs{
							Type: pulumi.String("filesystem"),
						},
					},
					Hooks: &dockeragent.HooksArgs{
						SessionStart: dockeragent.HookDefinitionArray{
							&dockeragent.HookDefinitionArgs{
								Type:    dockeragent.HookTypeBuiltin,
								Command: pulumi.String("add_environment_info"),
							},
						},
					},
					SimpleCommands: pulumi.StringMap{
						"test": pulumi.String("Run the tests and summarise the failures"),
					},
				},
			},
			Budget: &dockeragent.BudgetArgs{
				MaxCost: pulumi.Float64(5),
				MaxTime: pulumi.String("30m"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("agentYaml", sandboxed.Yaml)
		return nil
	})
}

```

## Import

An existing docker-agent configuration can be imported, and `pulumi import` generates its typed inputs in your program's language. The ID is `file://<path>`, a path ending in `.yaml`, `.yml` or `.hcl` (relative to the project directory), or `oci://<registry>/<repository>:<tag>` (or `@sha256:<digest>`) for a shared agent, read with the provider's registry credentials. Only configurations that pass validation are imported; set the provider's `skipValidation` to import one that needs a newer docker-agent (the resource then gets `skipValidation: true`). Keys without a typed input go to `extra`, `instruction_file` contents become `instruction`, and comments, key order and YAML anchors are not kept. The imported resource's ID is its name; it keeps no link to the file or artifact.

```sh $ pulumi import docker-agent:index:AgentConfig assistant ./agent.yaml ```

```sh $ pulumi import docker-agent:index:AgentConfig shared oci://ghcr.io/my-org/agents/assistant:v1 ```

func GetAgentConfig

func GetAgentConfig(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AgentConfigState, opts ...pulumi.ResourceOption) (*AgentConfig, error)

GetAgentConfig gets an existing AgentConfig resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAgentConfig

func NewAgentConfig(ctx *pulumi.Context,
	name string, args *AgentConfigArgs, opts ...pulumi.ResourceOption) (*AgentConfig, error)

NewAgentConfig registers a new resource with the given unique name, arguments, and options.

func (*AgentConfig) ElementType

func (*AgentConfig) ElementType() reflect.Type

func (*AgentConfig) ToAgentConfigOutput

func (i *AgentConfig) ToAgentConfigOutput() AgentConfigOutput

func (*AgentConfig) ToAgentConfigOutputWithContext

func (i *AgentConfig) ToAgentConfigOutputWithContext(ctx context.Context) AgentConfigOutput

type AgentConfigArgs

type AgentConfigArgs struct {
	// The agents, in order. At least one agent is required. The agent named `root`, or else the first agent, is the default agent. Rendered as the `agents` map keyed by each agent's `name`.
	Agents AgentArrayInput
	// Ceilings on what a single run may consume before the agent is stopped, regardless of which agent spends. Scoped to a run and shared by every sub-session spawned inside it, so delegated work spends against the same budget as its parent.
	Budget BudgetPtrInput
	// Reusable, named budget definitions. An agent opts into one by listing its name in its 'budgets' field. A named budget is a single shared pot: when several agents reference the same name they draw from the SAME ceiling rather than each getting a copy, so a fan-out to N sub-agents cannot spend N times the limit. Give agents distinct budget names when you want independent pots.
	Budgets BudgetMapInput
	// Map of reusable, named command groups. Define command sets here and reference them by name from an agent's use_commands to avoid duplication.
	Commands CommandGroupMapInput
	// Named provider-backed assessments, independent of chat models and decision policies.
	Evaluators EvaluatorMapInput
	// Additional top-level YAML sections that are not modelled by this provider version, merged verbatim into the document (snake_case keys). Keys of typed inputs (`agents`, `models`, `runtime`, ...) are rejected: set the typed input instead.
	Extra pulumi.MapInput
	// Named YAML patches applied on top of the rest of the document when enabled at run time (e.g. 'docker agent run --flavor <name>'). Each flavor is a partial config document merged with JSON Merge Patch semantics: objects merge recursively, scalars and arrays replace, null deletes a key. A key ending in '+' appends its items to the existing array (e.g. 'toolsets+:'); a scalar existing value is promoted to a one-element array first, so 'instruction+:' extends a string instruction. A key ending in '-' removes entries — from an object by key name, from an array by scalar equality or partial object match (e.g. 'toolsets-: [{type: shell}]'). Enabled flavors are applied in the order they were requested; requested flavors not defined here are ignored. Each flavor is a free-form YAML patch with the same structure as the configuration (snake_case keys), rendered verbatim.
	Flavors pulumi.MapMapInput
	// Map of reusable MCP server definitions. Define MCP servers here and reference them by name from agent toolsets to avoid duplication.
	Mcps McpDefinitionMapInput
	// Configuration metadata
	Metadata MetadataPtrInput
	// Map of model configurations
	Models ModelDefMapInput
	// Tool permission configuration for controlling tool approval behavior
	Permissions PermissionsPtrInput
	// Map of custom provider configurations. Providers define reusable defaults (base_url, token_key, api_type) that models can reference.
	Providers ProviderDefMapInput
	// Map of reusable RAG source definitions. Define RAG sources here and reference them by name from agent toolsets to avoid duplication.
	Rag RagSourceMapInput
	// Execution-time defaults the agent author wants applied. Values act as defaults only — explicit CLI flags or user-config settings always win.
	Runtime RuntimeDefaultsPtrInput
	// Map of reusable, named skill groups. Define skill sets here and reference them by name from an agent's use_skills to avoid duplication.
	Skills SkillSetMapInput
	// Skip validating the rendered YAML with the docker-agent library, and accept enum values (such as a `safety` mode) that this provider version does not list. Use it for configurations that rely on docker-agent features newer than v1.150.0.
	SkipValidation pulumi.BoolPtrInput
	// Map of reusable, named toolset definitions. Define a toolset here and reference it by name from an agent's use_toolsets to share the same toolset across multiple agents.
	Toolsets ToolsetMapInput
	// The docker-agent configuration schema version. Defaults to `"16"`, the latest version understood by docker-agent v1.150.0.
	Version pulumi.StringPtrInput
}

The set of arguments for constructing a AgentConfig resource.

func (AgentConfigArgs) ElementType

func (AgentConfigArgs) ElementType() reflect.Type

type AgentConfigArray

type AgentConfigArray []AgentConfigInput

func (AgentConfigArray) ElementType

func (AgentConfigArray) ElementType() reflect.Type

func (AgentConfigArray) ToAgentConfigArrayOutput

func (i AgentConfigArray) ToAgentConfigArrayOutput() AgentConfigArrayOutput

func (AgentConfigArray) ToAgentConfigArrayOutputWithContext

func (i AgentConfigArray) ToAgentConfigArrayOutputWithContext(ctx context.Context) AgentConfigArrayOutput

type AgentConfigArrayInput

type AgentConfigArrayInput interface {
	pulumi.Input

	ToAgentConfigArrayOutput() AgentConfigArrayOutput
	ToAgentConfigArrayOutputWithContext(context.Context) AgentConfigArrayOutput
}

AgentConfigArrayInput is an input type that accepts AgentConfigArray and AgentConfigArrayOutput values. You can construct a concrete instance of `AgentConfigArrayInput` via:

AgentConfigArray{ AgentConfigArgs{...} }

type AgentConfigArrayOutput

type AgentConfigArrayOutput struct{ *pulumi.OutputState }

func (AgentConfigArrayOutput) ElementType

func (AgentConfigArrayOutput) ElementType() reflect.Type

func (AgentConfigArrayOutput) Index

func (AgentConfigArrayOutput) ToAgentConfigArrayOutput

func (o AgentConfigArrayOutput) ToAgentConfigArrayOutput() AgentConfigArrayOutput

func (AgentConfigArrayOutput) ToAgentConfigArrayOutputWithContext

func (o AgentConfigArrayOutput) ToAgentConfigArrayOutputWithContext(ctx context.Context) AgentConfigArrayOutput

type AgentConfigInput

type AgentConfigInput interface {
	pulumi.Input

	ToAgentConfigOutput() AgentConfigOutput
	ToAgentConfigOutputWithContext(ctx context.Context) AgentConfigOutput
}

type AgentConfigMap

type AgentConfigMap map[string]AgentConfigInput

func (AgentConfigMap) ElementType

func (AgentConfigMap) ElementType() reflect.Type

func (AgentConfigMap) ToAgentConfigMapOutput

func (i AgentConfigMap) ToAgentConfigMapOutput() AgentConfigMapOutput

func (AgentConfigMap) ToAgentConfigMapOutputWithContext

func (i AgentConfigMap) ToAgentConfigMapOutputWithContext(ctx context.Context) AgentConfigMapOutput

type AgentConfigMapInput

type AgentConfigMapInput interface {
	pulumi.Input

	ToAgentConfigMapOutput() AgentConfigMapOutput
	ToAgentConfigMapOutputWithContext(context.Context) AgentConfigMapOutput
}

AgentConfigMapInput is an input type that accepts AgentConfigMap and AgentConfigMapOutput values. You can construct a concrete instance of `AgentConfigMapInput` via:

AgentConfigMap{ "key": AgentConfigArgs{...} }

type AgentConfigMapOutput

type AgentConfigMapOutput struct{ *pulumi.OutputState }

func (AgentConfigMapOutput) ElementType

func (AgentConfigMapOutput) ElementType() reflect.Type

func (AgentConfigMapOutput) MapIndex

func (AgentConfigMapOutput) ToAgentConfigMapOutput

func (o AgentConfigMapOutput) ToAgentConfigMapOutput() AgentConfigMapOutput

func (AgentConfigMapOutput) ToAgentConfigMapOutputWithContext

func (o AgentConfigMapOutput) ToAgentConfigMapOutputWithContext(ctx context.Context) AgentConfigMapOutput

type AgentConfigOutput

type AgentConfigOutput struct{ *pulumi.OutputState }

func (AgentConfigOutput) AgentNames

The agent names, in order.

func (AgentConfigOutput) Agents

The agents, in order. At least one agent is required. The agent named `root`, or else the first agent, is the default agent. Rendered as the `agents` map keyed by each agent's `name`.

func (AgentConfigOutput) Budget

Ceilings on what a single run may consume before the agent is stopped, regardless of which agent spends. Scoped to a run and shared by every sub-session spawned inside it, so delegated work spends against the same budget as its parent.

func (AgentConfigOutput) Budgets

func (o AgentConfigOutput) Budgets() BudgetMapOutput

Reusable, named budget definitions. An agent opts into one by listing its name in its 'budgets' field. A named budget is a single shared pot: when several agents reference the same name they draw from the SAME ceiling rather than each getting a copy, so a fan-out to N sub-agents cannot spend N times the limit. Give agents distinct budget names when you want independent pots.

func (AgentConfigOutput) Commands

Map of reusable, named command groups. Define command sets here and reference them by name from an agent's use_commands to avoid duplication.

func (AgentConfigOutput) DefaultAgent

func (o AgentConfigOutput) DefaultAgent() pulumi.StringOutput

The agent docker-agent starts by default: `root` if an agent has that name, else the first agent.

func (AgentConfigOutput) DockerAgentVersion

func (o AgentConfigOutput) DockerAgentVersion() pulumi.StringOutput

The docker-agent library version the configuration was validated against.

func (AgentConfigOutput) ElementType

func (AgentConfigOutput) ElementType() reflect.Type

func (AgentConfigOutput) Evaluators

func (o AgentConfigOutput) Evaluators() EvaluatorMapOutput

Named provider-backed assessments, independent of chat models and decision policies.

func (AgentConfigOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (AgentConfigOutput) Flavors

Named YAML patches applied on top of the rest of the document when enabled at run time (e.g. 'docker agent run --flavor <name>'). Each flavor is a partial config document merged with JSON Merge Patch semantics: objects merge recursively, scalars and arrays replace, null deletes a key. A key ending in '+' appends its items to the existing array (e.g. 'toolsets+:'); a scalar existing value is promoted to a one-element array first, so 'instruction+:' extends a string instruction. A key ending in '-' removes entries — from an object by key name, from an array by scalar equality or partial object match (e.g. 'toolsets-: [{type: shell}]'). Enabled flavors are applied in the order they were requested; requested flavors not defined here are ignored. Each flavor is a free-form YAML patch with the same structure as the configuration (snake_case keys), rendered verbatim.

func (AgentConfigOutput) Mcps

Map of reusable MCP server definitions. Define MCP servers here and reference them by name from agent toolsets to avoid duplication.

func (AgentConfigOutput) Metadata

func (o AgentConfigOutput) Metadata() MetadataPtrOutput

Configuration metadata

func (AgentConfigOutput) Models

Map of model configurations

func (AgentConfigOutput) Permissions

func (o AgentConfigOutput) Permissions() PermissionsPtrOutput

Tool permission configuration for controlling tool approval behavior

func (AgentConfigOutput) Providers

Map of custom provider configurations. Providers define reusable defaults (base_url, token_key, api_type) that models can reference.

func (AgentConfigOutput) Rag

Map of reusable RAG source definitions. Define RAG sources here and reference them by name from agent toolsets to avoid duplication.

func (AgentConfigOutput) RequiredEnvVars

func (o AgentConfigOutput) RequiredEnvVars() pulumi.StringArrayOutput

Best effort list of the environment variables the configured models need at run time, for example `OPENAI_API_KEY`, `ANTHROPIC_API_KEY` or the `tokenKey` values.

func (AgentConfigOutput) Runtime

Execution-time defaults the agent author wants applied. Values act as defaults only — explicit CLI flags or user-config settings always win.

func (AgentConfigOutput) Sha256

The hex-encoded SHA-256 of `yaml`.

func (AgentConfigOutput) Skills

Map of reusable, named skill groups. Define skill sets here and reference them by name from an agent's use_skills to avoid duplication.

func (AgentConfigOutput) SkipValidation

func (o AgentConfigOutput) SkipValidation() pulumi.BoolPtrOutput

Skip validating the rendered YAML with the docker-agent library, and accept enum values (such as a `safety` mode) that this provider version does not list. Use it for configurations that rely on docker-agent features newer than v1.150.0.

func (AgentConfigOutput) ToAgentConfigOutput

func (o AgentConfigOutput) ToAgentConfigOutput() AgentConfigOutput

func (AgentConfigOutput) ToAgentConfigOutputWithContext

func (o AgentConfigOutput) ToAgentConfigOutputWithContext(ctx context.Context) AgentConfigOutput

func (AgentConfigOutput) Toolsets

func (o AgentConfigOutput) Toolsets() ToolsetMapOutput

Map of reusable, named toolset definitions. Define a toolset here and reference it by name from an agent's use_toolsets to share the same toolset across multiple agents.

func (AgentConfigOutput) Version

The docker-agent configuration schema version. Allowed values: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`, `16`.

func (AgentConfigOutput) Yaml

The rendered docker-agent YAML document. Identical inputs always render the same bytes: agents keep their order and all map keys are sorted.

type AgentConfigState

type AgentConfigState struct {
}

func (AgentConfigState) ElementType

func (AgentConfigState) ElementType() reflect.Type

type AgentInput

type AgentInput interface {
	pulumi.Input

	ToAgentOutput() AgentOutput
	ToAgentOutputWithContext(context.Context) AgentOutput
}

AgentInput is an input type that accepts AgentArgs and AgentOutput values. You can construct a concrete instance of `AgentInput` via:

AgentArgs{...}

type AgentOutput

type AgentOutput struct{ *pulumi.OutputState }

Configuration for a single agent

func (AgentOutput) AddDate

func (o AgentOutput) AddDate() pulumi.BoolPtrOutput

Whether to add date information

func (AgentOutput) AddDescriptionParameter

func (o AgentOutput) AddDescriptionParameter() pulumi.BoolPtrOutput

Whether to add a 'description' parameter to tool calls, allowing the LLM to provide context about why it is calling a tool

func (AgentOutput) AddEnvironmentInfo

func (o AgentOutput) AddEnvironmentInfo() pulumi.BoolPtrOutput

Whether to add environment information

func (AgentOutput) AddPromptFiles

func (o AgentOutput) AddPromptFiles() pulumi.StringArrayOutput

List of prompt files to add

func (AgentOutput) AddPromptFilesDepth

func (o AgentOutput) AddPromptFilesDepth() pulumi.IntPtrOutput

Also list, by path only, the add_prompt_files names found up to this many directory levels below the working directory (1 = direct subdirectories). Contents are not loaded: the agent reads the ones it needs. Useful in monorepos where each sub-project carries its own AGENTS.md. 0 (default) disables the scan.

func (AgentOutput) Budgets

func (o AgentOutput) Budgets() pulumi.StringArrayOutput

Names of top-level 'budgets' entries this agent spends against. Every listed budget must be defined under the top-level 'budgets' key. An agent may list several, in which case all apply and the first to be exhausted stops the run. Agents sharing a budget name share one pot, so a fan-out cannot multiply the ceiling.

func (AgentOutput) Cache

Optional response cache: when the same user question is asked again, replay the previous answer instead of calling the model.

func (AgentOutput) CodeModeTools

func (o AgentOutput) CodeModeTools() pulumi.BoolPtrOutput

Enable Code Mode for tools

func (AgentOutput) Commands

func (o AgentOutput) Commands() CommandMapOutput

Named commands (`/name`), in the object form: `description`, `instruction`, `agent` or `url`.

func (AgentOutput) CompactionModel

func (o AgentOutput) CompactionModel() pulumi.StringPtrOutput

Model used to summarize the conversation when this agent's session is compacted (manual /compact, the proactive threshold trigger, or post-overflow recovery). Value can be a model name from the models section or an inline 'provider/model' spec. Highest priority: takes precedence over a compaction_model set on the agent's model or provider; when all are omitted, compaction reuses the agent's own model.

func (AgentOutput) CompactionThreshold

func (o AgentOutput) CompactionThreshold() pulumi.Float64PtrOutput

Fraction of the model's context window at which proactive auto-compaction triggers for this agent. Must be greater than 0 and at most 1. Defaults to 0.9 (90% of the context window). A compaction_threshold set on the agent's model takes precedence over this value.

func (AgentOutput) Description

func (o AgentOutput) Description() pulumi.StringPtrOutput

Description of the agent

func (AgentOutput) ElementType

func (AgentOutput) ElementType() reflect.Type

func (AgentOutput) Extra

func (o AgentOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (AgentOutput) Fallback

func (o AgentOutput) Fallback() FallbackPtrOutput

Fallback model configuration for automatic failover and retry behavior

func (AgentOutput) ForceHandoff

func (o AgentOutput) ForceHandoff() pulumi.StringPtrOutput

Name of an agent that unconditionally receives the conversation whenever this agent produces a final response, bypassing the LLM's tool-calling entirely. Guarantees deterministic routing for strict pipelines (e.g. extractor -> summarizer). Can be the name of an agent defined in this config or an external reference. Pin an external OCI reference to an immutable digest (e.g. 'namespace/repo@sha256:...') to avoid a per-run registry lookup. Must not reference the agent itself, and force_handoff chains must not form a cycle.

func (AgentOutput) Handoffs

func (o AgentOutput) Handoffs() pulumi.StringArrayOutput

List of agents this agent can hand off the conversation to. Can be names of agents defined in this config, external references (OCI images like 'namespace/repo' or URLs), or named external references using 'name:reference' syntax (e.g. 'reviewer:myorg/review-pr'). External agents without an explicit name are named after their last path segment. Pin external OCI references to an immutable digest (e.g. 'namespace/repo@sha256:...') to serve them from cache; tag references are re-resolved against the registry on every run.

func (AgentOutput) Harness

func (o AgentOutput) Harness() HarnessPtrOutput

External coding harness to run this agent with instead of a docker-agent model provider

func (AgentOutput) Hooks

func (o AgentOutput) Hooks() HooksPtrOutput

Lifecycle hooks for executing shell commands at various points in the agent's execution

func (AgentOutput) InlineSkills

func (o AgentOutput) InlineSkills() InlineSkillArrayOutput

Skills defined inline in the configuration. Rendered into the `skills` list after the entries of `skills`.

func (AgentOutput) Instruction

func (o AgentOutput) Instruction() pulumi.StringPtrOutput

Instructions for the agent (the system prompt). docker-agent's YAML list form is the same as one string with the parts joined by a blank line.

func (AgentOutput) InstructionFile

func (o AgentOutput) InstructionFile() pulumi.StringArrayOutput

Path(s) to a file or files, relative to the config file's directory, whose contents become the agent's instruction. Accepts a single string or a list of strings; when several files are given their contents are concatenated in order, separated by a blank line. Loaded at startup. Mutually exclusive with 'instruction'. Each path must be a local relative path inside the config directory (absolute paths and '..' traversal are rejected). Only supported for local file-based configs, not OCI/URL sources. The provider validates the configuration in memory, where relative files cannot be read, so `instructionFile` needs `skipValidation: true`. Prefer reading the file in your program and passing its contents as `instruction`.

func (AgentOutput) MaxConsecutiveToolCalls

func (o AgentOutput) MaxConsecutiveToolCalls() pulumi.IntPtrOutput

Maximum consecutive identical tool calls before the agent is terminated. Prevents degenerate loops. 0 uses the default of 5.

func (AgentOutput) MaxIterations

func (o AgentOutput) MaxIterations() pulumi.IntPtrOutput

Maximum number of iterations

func (AgentOutput) MaxOldToolCallTokens

func (o AgentOutput) MaxOldToolCallTokens() pulumi.IntPtrOutput

Maximum number of tokens to keep from old tool call arguments and results. Older tool calls beyond this budget will have their content replaced with a placeholder. Tokens are approximated as len/4. Truncation is disabled by default; set a positive value to enable it. Set to -1 to disable truncation (unlimited tool content).

func (AgentOutput) MaxToolResultTokens

func (o AgentOutput) MaxToolResultTokens() pulumi.IntPtrOutput

Maximum number of tokens to keep from each tool result when it is added to the session. Oversized results are truncated middle-out: the head and tail are kept and the removed middle is replaced with a truncation marker. Textual documents attached to the result share the same budget. Tokens are approximated as len/4. The cap is disabled by default; set a positive value to enable it. 0 and -1 both leave tool results unbounded.

func (AgentOutput) Model

Model to use for this agent (can be just model name or provider/model format)

func (AgentOutput) Name

func (o AgentOutput) Name() pulumi.StringOutput

The agent name. It becomes the key under `agents:` and is how other agents reference it in `subAgents`, `handoffs` and `forceHandoff`.

func (AgentOutput) NumHistoryItems

func (o AgentOutput) NumHistoryItems() pulumi.IntPtrOutput

Number of history items to keep

func (AgentOutput) Readonly

func (o AgentOutput) Readonly() pulumi.BoolPtrOutput

When true, makes every one of this agent's toolsets read-only: only tools whose annotations carry a read-only hint are listed and callable, and all other (mutating) tools are filtered out. Equivalent to setting 'readonly: true' on each toolset. A sub-agent or handoff agent is made read-only by setting this flag on that agent's own definition.

func (AgentOutput) RedactSecrets

func (o AgentOutput) RedactSecrets() pulumi.BoolPtrOutput

Enabled by default. When true (the default), the runtime auto-installs the redact_secrets builtin on all three of tool_input_transform (scrubs detected secrets from tool arguments before approval), before_llm_call (scrubs the messages sent to the LLM), and tool_response_transform (scrubs tool output before it reaches event consumers, the persisted session, the post_tool_use hook input, or the next LLM call). Set to false to opt out. The same hook entries can be authored directly in YAML for finer-grained control — see the hooks.tool_response_transform / hooks.before_llm_call / hooks.tool_input_transform sections. Detection uses the portcullis ruleset (GitHub PATs, AWS keys, Stripe / Slack / GitLab tokens, JWTs, private keys, etc.). Each detected span is replaced with the literal '[REDACTED]'.

func (AgentOutput) Routing

func (o AgentOutput) Routing() AgentRoutingPtrOutput

Local agents that this agent's before_agent_run and after_agent_complete hooks may route to. Requires at least one of those hooks; the agent cannot route to itself or to harness agents, and the combined graph of possible routes and force_handoff edges must not contain a cycle.

func (AgentOutput) Safety

func (o AgentOutput) Safety() SafetyModePtrOutput

Safety mode new sessions started on this agent default to when the user has not chosen one (no --safety/--yolo flag, no alias option, no user-config setting). Takes precedence over the config-wide runtime.safety. A default only: it never overrides a user choice and never replaces the mode stored on a resumed session. 'restricted' is the fail-closed profile for unattended runs: safe calls auto-approve, every other unmatched call is denied without prompting. Trust warning: 'autonomous' auto-approves every tool call — review configs from URLs or OCI registries before running them.

func (AgentOutput) SessionCompaction

func (o AgentOutput) SessionCompaction() pulumi.BoolPtrOutput

Enabled by default. When true (the default), the runtime automatically compacts the session: proactively when the estimated context usage crosses the compaction threshold, and reactively to recover from a context-overflow error. Set to false to disable both automatic triggers for this agent; the manual /compact command remains available.

func (AgentOutput) SimpleCommands

func (o AgentOutput) SimpleCommands() pulumi.StringMapOutput

Named commands in the short form `name: instruction`: the string is the prompt sent to the agent. Rendered into the same `commands` map as `commands`; a name must not appear in both.

func (AgentOutput) Skills

Skill sources and names: `local` (skills discovered on the local filesystem; `["local"]` is the same as `skills: true`), HTTP/HTTPS URLs of remote skill sources, or names of skills to include. Rendered into the `skills` list together with `inlineSkills`.

func (AgentOutput) StructuredOutput

func (o AgentOutput) StructuredOutput() StructuredOutputPtrOutput

Structured output configuration for constraining model responses to a specific JSON schema. Supported by OpenAI (native) and Google Gemini (native). Anthropic requires prompt engineering or tool-based approaches.

func (AgentOutput) SubAgents

func (o AgentOutput) SubAgents() pulumi.StringArrayOutput

List of sub-agents. Can be names of agents defined in this config, external references (OCI images like 'namespace/repo' or URLs), or named external references using 'name:reference' syntax (e.g. 'reviewer:myorg/review-pr'). External agents without an explicit name are named after their last path segment. Pin external OCI references to an immutable digest (e.g. 'namespace/repo@sha256:...') to serve them from cache; tag references (including the implicit ':latest') are re-resolved against the registry on every run, even when the sub-agent is never invoked.

func (AgentOutput) ToAgentOutput

func (o AgentOutput) ToAgentOutput() AgentOutput

func (AgentOutput) ToAgentOutputWithContext

func (o AgentOutput) ToAgentOutputWithContext(ctx context.Context) AgentOutput

func (AgentOutput) Toolsets

func (o AgentOutput) Toolsets() ToolsetArrayOutput

List of toolsets available to the agent

func (AgentOutput) UseCommands

func (o AgentOutput) UseCommands() pulumi.StringArrayOutput

Names of reusable command groups (defined in the top-level commands section) to merge into this agent. Inline commands on the agent take precedence on name conflicts.

func (AgentOutput) UseSkills

func (o AgentOutput) UseSkills() pulumi.StringArrayOutput

Names of reusable skill groups (defined in the top-level skills section) to merge into this agent. Inline skills on the agent take precedence on name conflicts.

func (AgentOutput) UseToolsets

func (o AgentOutput) UseToolsets() pulumi.StringArrayOutput

Names of reusable toolset definitions (defined in the top-level toolsets section) to append to this agent's toolsets. Inline toolsets on the agent come first, followed by each referenced toolset in order.

func (AgentOutput) WelcomeMessage

func (o AgentOutput) WelcomeMessage() pulumi.StringPtrOutput

Optional welcome message to display when the agent starts

type AgentRouting

type AgentRouting struct {
	// Names of agents defined in this config that a hook may select. A transition to any other agent fails the run.
	AllowedAgents []string `pulumi:"allowedAgents"`
	// Agent used when a choice-evaluator assessment is uncertain (low probability, tie, invalid distribution) or the evaluator fails. Required when an evaluator selects the route; must be in allowed_agents. Cancellation and budget exhaustion never use it.
	DefaultAgent *string `pulumi:"defaultAgent"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
}

Local agents that this agent's before_agent_run and after_agent_complete hooks may route to. Requires at least one of those hooks; the agent cannot route to itself or to harness agents, and the combined graph of possible routes and force_handoff edges must not contain a cycle.

type AgentRoutingArgs

type AgentRoutingArgs struct {
	// Names of agents defined in this config that a hook may select. A transition to any other agent fails the run.
	AllowedAgents pulumi.StringArrayInput `pulumi:"allowedAgents"`
	// Agent used when a choice-evaluator assessment is uncertain (low probability, tie, invalid distribution) or the evaluator fails. Required when an evaluator selects the route; must be in allowed_agents. Cancellation and budget exhaustion never use it.
	DefaultAgent pulumi.StringPtrInput `pulumi:"defaultAgent"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
}

Local agents that this agent's before_agent_run and after_agent_complete hooks may route to. Requires at least one of those hooks; the agent cannot route to itself or to harness agents, and the combined graph of possible routes and force_handoff edges must not contain a cycle.

func (AgentRoutingArgs) ElementType

func (AgentRoutingArgs) ElementType() reflect.Type

func (AgentRoutingArgs) ToAgentRoutingOutput

func (i AgentRoutingArgs) ToAgentRoutingOutput() AgentRoutingOutput

func (AgentRoutingArgs) ToAgentRoutingOutputWithContext

func (i AgentRoutingArgs) ToAgentRoutingOutputWithContext(ctx context.Context) AgentRoutingOutput

func (AgentRoutingArgs) ToAgentRoutingPtrOutput

func (i AgentRoutingArgs) ToAgentRoutingPtrOutput() AgentRoutingPtrOutput

func (AgentRoutingArgs) ToAgentRoutingPtrOutputWithContext

func (i AgentRoutingArgs) ToAgentRoutingPtrOutputWithContext(ctx context.Context) AgentRoutingPtrOutput

type AgentRoutingInput

type AgentRoutingInput interface {
	pulumi.Input

	ToAgentRoutingOutput() AgentRoutingOutput
	ToAgentRoutingOutputWithContext(context.Context) AgentRoutingOutput
}

AgentRoutingInput is an input type that accepts AgentRoutingArgs and AgentRoutingOutput values. You can construct a concrete instance of `AgentRoutingInput` via:

AgentRoutingArgs{...}

type AgentRoutingOutput

type AgentRoutingOutput struct{ *pulumi.OutputState }

Local agents that this agent's before_agent_run and after_agent_complete hooks may route to. Requires at least one of those hooks; the agent cannot route to itself or to harness agents, and the combined graph of possible routes and force_handoff edges must not contain a cycle.

func (AgentRoutingOutput) AllowedAgents

func (o AgentRoutingOutput) AllowedAgents() pulumi.StringArrayOutput

Names of agents defined in this config that a hook may select. A transition to any other agent fails the run.

func (AgentRoutingOutput) DefaultAgent

func (o AgentRoutingOutput) DefaultAgent() pulumi.StringPtrOutput

Agent used when a choice-evaluator assessment is uncertain (low probability, tie, invalid distribution) or the evaluator fails. Required when an evaluator selects the route; must be in allowed_agents. Cancellation and budget exhaustion never use it.

func (AgentRoutingOutput) ElementType

func (AgentRoutingOutput) ElementType() reflect.Type

func (AgentRoutingOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (AgentRoutingOutput) ToAgentRoutingOutput

func (o AgentRoutingOutput) ToAgentRoutingOutput() AgentRoutingOutput

func (AgentRoutingOutput) ToAgentRoutingOutputWithContext

func (o AgentRoutingOutput) ToAgentRoutingOutputWithContext(ctx context.Context) AgentRoutingOutput

func (AgentRoutingOutput) ToAgentRoutingPtrOutput

func (o AgentRoutingOutput) ToAgentRoutingPtrOutput() AgentRoutingPtrOutput

func (AgentRoutingOutput) ToAgentRoutingPtrOutputWithContext

func (o AgentRoutingOutput) ToAgentRoutingPtrOutputWithContext(ctx context.Context) AgentRoutingPtrOutput

type AgentRoutingPtrInput

type AgentRoutingPtrInput interface {
	pulumi.Input

	ToAgentRoutingPtrOutput() AgentRoutingPtrOutput
	ToAgentRoutingPtrOutputWithContext(context.Context) AgentRoutingPtrOutput
}

AgentRoutingPtrInput is an input type that accepts AgentRoutingArgs, AgentRoutingPtr and AgentRoutingPtrOutput values. You can construct a concrete instance of `AgentRoutingPtrInput` via:

        AgentRoutingArgs{...}

or:

        nil

type AgentRoutingPtrOutput

type AgentRoutingPtrOutput struct{ *pulumi.OutputState }

func (AgentRoutingPtrOutput) AllowedAgents

Names of agents defined in this config that a hook may select. A transition to any other agent fails the run.

func (AgentRoutingPtrOutput) DefaultAgent

func (o AgentRoutingPtrOutput) DefaultAgent() pulumi.StringPtrOutput

Agent used when a choice-evaluator assessment is uncertain (low probability, tie, invalid distribution) or the evaluator fails. Required when an evaluator selects the route; must be in allowed_agents. Cancellation and budget exhaustion never use it.

func (AgentRoutingPtrOutput) Elem

func (AgentRoutingPtrOutput) ElementType

func (AgentRoutingPtrOutput) ElementType() reflect.Type

func (AgentRoutingPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (AgentRoutingPtrOutput) ToAgentRoutingPtrOutput

func (o AgentRoutingPtrOutput) ToAgentRoutingPtrOutput() AgentRoutingPtrOutput

func (AgentRoutingPtrOutput) ToAgentRoutingPtrOutputWithContext

func (o AgentRoutingPtrOutput) ToAgentRoutingPtrOutputWithContext(ctx context.Context) AgentRoutingPtrOutput

type AgentRun

type AgentRun struct {
	pulumi.CustomResourceState

	// The agent to run. Defaults to `root`, or else the first agent of the configuration.
	Agent pulumi.StringPtrOutput `pulumi:"agent"`
	// The agent that gave the final answer: the selected agent, or the agent it handed the conversation off to.
	AgentName pulumi.StringOutput `pulumi:"agentName"`
	// Run coding-harness agents: agents with `harness`. AgentRun supports `harness.type: claude-code` and `codex` on Linux and macOS. Such an agent starts the Claude Code CLI (`claude`) or the Codex CLI (`codex`) on the machine that runs `pulumi up`. The CLI runs its own tools (shell commands, file edits, web requests, MCP tools): `allowHookApprovals` and the configuration's `permissions` do not apply to it. Claude Code runs them without approval whatever `toolApproval` says; Codex runs its commands in its `workspace-write` sandbox under `toolApproval: deny` (which limits writes and network, not reads) and without a sandbox under `allow`. The CLI runs in `workingDir`, with the environment described for `inheritEnvironment` plus `env`. It uses its user's login and settings: the `claude` login of this machine or `CLAUDE_CODE_OAUTH_TOKEN` in `env`, or the Codex login of `CODEX_HOME` (default `~/.codex`) or `CODEX_API_KEY` in `env`. Without it, a coding-harness agent fails the run, and a `yaml` configuration (that the provider's docker-agent version can load) already fails the preview. Changing it updates the state without running the agent again.
	AllowHarnessAgents pulumi.BoolOutput `pulumi:"allowHarnessAgents"`
	// Let the configuration's hooks approve tool calls under `toolApproval: deny`. docker-agent runs a tool call that a `pre_tool_use` hook (`permission_decision: allow`) or a `permission_request` hook approves; by default AgentRun ignores such approvals and rejects the call, so `deny` only runs what docker-agent approves by its rules. Hook denials always apply. It has no effect with `toolApproval: allow`.
	AllowHookApprovals pulumi.BoolOutput `pulumi:"allowHookApprovals"`
	// A user message the agent runs when the resource is deleted: by `pulumi destroy`, by removing it from the program, or by a replacement. It runs with the configuration and inputs stored in the state, and the environment of the deleting command, for example to clean up what earlier runs created in `workingDir`. Its answer is not kept. When it fails, the delete fails and the resource stays in the state. For a resource that was removed or replaced, that fails every later `pulumi up` as well. To delete without running it, set `DOCKER_AGENT_SKIP_DELETE_PROMPTS=true` for that command. It is skipped with a warning when `workingDir` no longer exists or is no longer a directory, and when an AgentRun of the same provider already ran in that `workingDir` during the same `pulumi` command. That happens when a replacement or a rename creates the new run first; use the `deleteBeforeReplace` resource option or `aliases`. It does not run with the `retainOnDelete` resource option, or when the `deletedWith` resource is deleted in the same operation. Changing it updates the state without running the agent.
	DeletePrompt pulumi.StringPtrOutput `pulumi:"deletePrompt"`
	// Environment variables for model credentials (for example `OPENAI_API_KEY`, `AWS_ACCESS_KEY_ID` or the `tokenKey` of a custom provider), the variables the model SDKs read (base URLs such as `OPENAI_BASE_URL`, `GOOGLE_APPLICATION_CREDENTIALS`, headers) and `${env.NAME}` references in the configuration. The run's child process gets them over the environment of the Pulumi CLI (with `inheritEnvironment`) or over a base environment without credentials. They are stored as secrets and redacted from errors and logs (except values that are configuration, such as a region or a boolean), and also reach command hooks and the Claude Code and Codex CLIs of coding-harness agents (for example `CLAUDE_CODE_OAUTH_TOKEN`, `CODEX_HOME` or `CODEX_API_KEY`). When `env` sets `CLAUDE_CODE_OAUTH_TOKEN`, an inherited `ANTHROPIC_API_KEY` or `ANTHROPIC_AUTH_TOKEN` is not passed to Claude Code, and when it sets `CODEX_ACCESS_TOKEN`, an inherited `CODEX_API_KEY` is not passed to Codex. `shell`, `script` and `background_jobs` tools and MCP and LSP servers get them only through their toolset's own `env` (`${env.NAME}`); `docker:` MCP servers, filesystem `post_edit` commands, the `open_url` launcher and docker-agent's on-demand tool installation get them too.
	Env pulumi.StringMapOutput `pulumi:"env"`
	// Also resolve credentials, `${env.NAME}` references and the variables the model SDKs read (base URLs, AWS and Google credentials, headers) from the environment of the Pulumi CLI, and let the processes the configuration starts inherit that environment. With `false`, the run's child process gets only `env` and a base environment without credentials (the system variables, proxies and CA certificates, the Docker connection, the Claude Code and Codex configuration locations, Go and docker-agent settings), so a key, base URL or header exported in the shell does not reach the models; the preview warns about such variables. Command hooks, `shell`, `script` and `background_jobs` tools, MCP and LSP servers started with `command`, and the CLIs of coding-harness agents then see the system variables (`PATH`, `HOME`, `USER`, `SHELL`, `LANG`, `TMPDIR`, `TZ`, ...) plus their own `env` (hooks and the CLIs also get `env`); Claude Code also keeps its configuration locations (`CLAUDE_CONFIG_DIR`, `CLAUDE_SECURESTORAGE_CONFIG_DIR`, `XDG_*_HOME`) and `IS_SANDBOX`, and Codex `CODEX_HOME`, `CODEX_CA_CERTIFICATE` and the proxy variables. `docker:` MCP servers, filesystem `post_edit` commands, the `open_url` launcher and docker-agent's on-demand tool installation get the child's environment. Credentials that are not environment variables still apply: the logins of the `claude` and `codex` CLIs, the ChatGPT login of `docker agent setup`, the AWS shared files and instance metadata, and the gcloud login. docker-agent's other credential sources (its `.env` file, credential helper, Docker Desktop) are never used.
	InheritEnvironment pulumi.BoolOutput `pulumi:"inheritEnvironment"`
	// What `pulumi up` shows while the agent runs. `status` (default) shows the run's progress as status messages that the next one replaces (an agent started, a task was transferred or the conversation handed off, each tool call and whether it was approved or rejected, a model that fell back to the next one) and logs one summary (duration, tool calls, input and output tokens, estimated cost). `tools` also logs every tool call with its arguments, `full` also the agents' messages and the tools' results; `none` shows nothing. Messages are redacted like errors (`env` values, secret inputs, credentials of the environment and `tokenKey` variables). When the answer is secret (`outputSecret`, or a secret `prompt`, `updatePrompt` or `yaml`; for a delete run also a secret `deletePrompt`), `tools` and `full` log no arguments, messages or results, and with a secret `yaml` or `agent` the messages name no agents, tools or models. Changing it updates the state without running the agent again.
	Logging LoggingOutput `pulumi:"logging"`
	// The agent's final answer. For a coding-harness agent, Claude Code's final result (or, when that is empty, the text Claude Code wrote during the run), or Codex's last message.
	Output pulumi.StringOutput `pulumi:"output"`
	// Mark `output` and `structuredOutput` as secret. They are also secret when `prompt`, `updatePrompt` or `yaml` is secret, and when the answer contains the value of a secret (an `env` value, a secret input, or a credential of the environment such as an API key the agent was given through `${env.NAME}`). A secret `env` alone does not make them secret. Changing it updates the state without running the agent again.
	OutputSecret pulumi.BoolOutput `pulumi:"outputSecret"`
	// The user message sent when the resource is created, and on reruns caused by a change of `prompt`.
	Prompt pulumi.StringOutput `pulumi:"prompt"`
	// When the run finished (RFC 3339).
	RanAt pulumi.StringOutput `pulumi:"ranAt"`
	// An agent shared through an OCI registry (`registry/repository:tag` or `@sha256:...`), pulled like `getAgent` with the provider's `registryAuth`. Pin it by digest, or use `triggers`, to control when a moved tag reruns the agent: only input changes do.
	Reference pulumi.StringPtrOutput `pulumi:"reference"`
	// When `pulumi up` runs the agent again after it first ran. `onChange` (default) runs it when an input that affects the run changes, including `triggers`. `always` runs it on every `pulumi up` that includes this resource. The preview then shows the resource as an update (`[diff: ~rerun]`) with unknown outputs, so a stack with such an AgentRun never previews without changes, and resources that consume its outputs change too. `pulumi refresh` reports no drift for it. Changing `rerun` alone updates the state, unless the new value is `always`.
	Rerun RerunPolicyOutput `pulumi:"rerun"`
	// The final answer decoded as JSON, when the answering agent declares `structured_output`.
	StructuredOutput pulumi.AnyOutput `pulumi:"structuredOutput"`
	// How long the run may take, in seconds, from loading the configuration (starting MCP servers, pulling a Docker Model Runner model) to the answer, before it fails. When it runs out, AgentRun stops the run and the processes it started, including a Claude Code or Codex CLI: SIGTERM (Codex gets SIGINT 2 s before), and SIGKILL after 10 s (or 1 s after the CLI exited, if that comes first). Changing it updates the state without running the agent again.
	TimeoutSeconds pulumi.IntOutput `pulumi:"timeoutSeconds"`
	// What happens to tool calls that docker-agent would ask a user to confirm. `deny` rejects them and tells the model; `allow` approves every tool call. Tools run on the machine executing `pulumi up`. For a Codex agent it also selects Codex's sandbox: `deny` runs its commands in Codex's `workspace-write` sandbox (writes only in `workingDir` and the temporary directories, no network, reads unrestricted), `allow` turns the sandbox off. Claude Code agents run every tool without approval either way.
	ToolApproval ToolApprovalOutput `pulumi:"toolApproval"`
	// The names of the tools that ran, in order, including those of sub-agents the agent transferred tasks to and the tools Claude Code or Codex reports it ran. Rejected tool calls are reported as warnings instead.
	ToolCalls pulumi.StringArrayOutput `pulumi:"toolCalls"`
	// Arbitrary values; any change runs the agent again, like a change of any other input.
	Triggers pulumi.ArrayOutput `pulumi:"triggers"`
	// The user message sent when the agent runs again while `prompt` is unchanged: after a change of `triggers`, `yaml`, `reference`, `agent`, `env`, `inheritEnvironment`, `workingDir`, `toolApproval` or `allowHookApprovals`, or on every `pulumi up` with `rerun: always`. When `prompt` changes, the rerun sends `prompt`. Defaults to `prompt`. Use it to tell the agent that its earlier work exists, for example files in `workingDir`. Changing it updates the state without running the agent; the next rerun uses it.
	UpdatePrompt pulumi.StringPtrOutput `pulumi:"updatePrompt"`
	// Token usage and estimated cost of the run.
	Usage AgentRunUsageOutput `pulumi:"usage"`
	// The agent's working directory, used by the shell, filesystem and other local tools, and the Claude Code or Codex CLI of a coding-harness agent. Defaults to a fresh temporary directory that is deleted after the run. Relative paths are resolved against the directory of the Pulumi program.
	WorkingDir pulumi.StringPtrOutput `pulumi:"workingDir"`
	// The docker-agent configuration to run, for example `AgentConfig.yaml` or the contents of an agent file. Exactly one of `yaml` and `reference` is required.
	Yaml pulumi.StringPtrOutput `pulumi:"yaml"`
}

Runs a prompt against a [Docker Agent](https://docs.docker.com/ai/docker-agent/) configuration during `pulumi up` and exposes the agent's answer as outputs, for example to generate content, a review or a structured decision that other resources consume.

The agent runs with the docker-agent Go SDK (the same runtime as `docker agent run --exec`), headless and unattended, in a child process of the provider on the machine that runs `pulumi up`, with any model provider docker-agent supports: API-key providers and their aliases, Amazon Bedrock, Google Vertex AI, Docker Model Runner, Ollama, custom OpenAI-compatible endpoints, and a ChatGPT subscription (`chatgpt/<model>`, with the login of `docker agent setup`). It never runs during `pulumi preview`: the outputs are unknown until the update.

**When the agent runs.** Creating the resource sends `prompt`. A change of `yaml`, `reference`, `agent`, `prompt`, `env`, `inheritEnvironment`, `workingDir`, `toolApproval`, `allowHookApprovals` or `triggers` (including a value that is unknown during the preview) runs the agent again: with `prompt` when `prompt` changed, otherwise with `updatePrompt` (which defaults to `prompt`). With `rerun: always` every `pulumi up` that includes the resource runs it again; the preview then shows it as an update, and the resources that consume its outputs change too. A change of `updatePrompt`, `deletePrompt`, `allowHarnessAgents`, `timeoutSeconds`, `outputSecret`, `logging` or `rerun` alone only updates the state (unless `rerun` becomes `always`). Without changes, `pulumi up` reuses the stored answer (unless `rerun: always`), and `pulumi refresh` always does; importing is not supported. A retry through the `hooks.onError` resource option runs the whole agent again.

**Deleting the resource** (`pulumi destroy`, removing it from the program, or the old resource of a replacement) runs `deletePrompt` when one is set, with the inputs stored in the state and the environment of the deleting command; its answer is not kept. When it fails, the delete fails and the resource stays in the state, and for a removed or replaced resource every later `pulumi up` tries the delete again. To delete without running it, set `DOCKER_AGENT_SKIP_DELETE_PROMPTS=true` for that command. It is skipped with a warning when `workingDir` no longer exists or is no longer a directory, and when another AgentRun of the same provider ran in the same `workingDir` during the same command (also while the delete prompt waited for it): a replacement that bypasses the provider's diff (`replacementTrigger`, `--replace`, `replaceWith`, `deletedWith`) and a rename without `aliases` create the new run before they delete the old one. A change of the provider replaces no resource: a changed setting (also only through `DOCKER_AGENT_SKIP_VALIDATION` or `DOCKER_AGENT_FORCE_HTTPS` in the environment of one command), a new provider version and a move to another provider instance update the provider in place. Use the `deleteBeforeReplace` resource option (AgentRun asks for it when a `deletePrompt` is stored, which covers `replaceOnChanges`), `aliases`, and one `workingDir` per AgentRun. With `retainOnDelete`, or when the `deletedWith` resource is deleted in the same operation, Delete is not called and nothing runs.

**Tools run on the machine executing `pulumi up`.** With the default `toolApproval: deny`, a tool call only runs when docker-agent would run it without asking: tools annotated read-only (for example `think`, `todo`, `memory` reads, the filesystem toolset's read and search tools, `api` tools and MCP tools whose server declares them read-only), calls an `allow` rule of the configuration's `permissions` matches, calls the configuration's own `safety` mode (`strict`, `balanced` or `restricted`) approves, and agent delegation (`transfer_task`, `handoff`). Approvals from the configuration's hooks (`pre_tool_use` or `permission_request`) are ignored unless `allowHookApprovals` is set. Every other call (shell commands, `script` tools, file writes, `fetch`, MCP tools without a read-only annotation, ...) is rejected, and the model is told why. `toolApproval: allow` runs every tool call, like `docker agent run --yolo`.

In both modes, these run without approval because they are part of the configuration: command hooks, MCP and LSP servers started with `command`, `docker:` MCP servers (through the Docker MCP Gateway), and filesystem `post_edit` commands after an approved write. Read-only tools can read any file the provider can read unless the toolset restricts them (`allow_list`). Review configurations pulled by `reference` before running them.

**Coding-harness agents** (`harness: {type: claude-code}` and `harness: {type: codex}`) run only with `allowHarnessAgents: true`, on Linux and macOS; pi and opencode harnesses are not supported yet. Such an agent starts the Claude Code CLI (`claude`) or the Codex CLI (`codex`), found on the `PATH` of its environment, on the machine that runs `pulumi up`, in `workingDir` (or a temporary directory) with the prompt on stdin, the environment described for `inheritEnvironment` plus `env`, and its user's login and settings: for Claude Code the `claude` login of this machine or `CLAUDE_CODE_OAUTH_TOKEN` (from `claude setup-token`) in `env`, for Codex the login of its `CODEX_HOME` (preferably a directory of AgentRun's own, passed in `env`) or `CODEX_API_KEY` in `env`. The CLI runs its own tools: `allowHookApprovals` and the configuration's `permissions` do not apply to it. Claude Code runs every tool without approval whatever `toolApproval` says. For Codex, `toolApproval: deny` runs its commands in Codex's `workspace-write` sandbox (writes only in `workingDir` and the temporary directories, no network unless its `config.toml` allows it, but every file the user can read stays readable, and MCP servers, hooks and web search run outside the sandbox), and `allow` turns the sandbox off; under `deny`, the run fails before the first Codex turn when the sandbox cannot start on the machine, as in most containers. An `ANTHROPIC_API_KEY` or `ANTHROPIC_AUTH_TOKEN` (Claude Code) or a `CODEX_API_KEY` (Codex) in the CLI's environment bills API usage instead of the subscription; when `env` sets `CLAUDE_CODE_OAUTH_TOKEN` (or `CODEX_ACCESS_TOKEN`), inherited ones are not passed to the CLI. `output` is the CLI's final answer (for Claude Code, when that is empty, the text it wrote during the run, with a warning), the agent's `instruction` is not sent to it, and `structured_output` is decoded from the answer but not enforced (for Codex, `strict: true` enforces it with `--output-schema`): an answer that is not JSON fails the run.

While the CLI runs, AgentRun records the processes it starts: both CLIs run each shell command in a session of its own, outside the CLI's process group, and can leave the commands they ran in the background running when they exit. They also inherit a random value in `DOCKER_AGENT_RUN_COOKIE`, by which AgentRun finds the ones whose parent exited before it saw them. When the run times out or is cancelled, AgentRun sends Codex SIGINT first, then SIGTERM to the CLI's process group and to those processes (for Codex 2 seconds later), and SIGKILL after 10 seconds, or 1 second after the CLI exited if that comes first; after the CLI exited, what is left gets SIGTERM and SIGKILL after 1 second, with a warning that says how many processes were left running outside the CLI's process group; when Pulumi stops the provider, no new CLI starts and the running ones and their processes are stopped within about 2 seconds. A process that left the CLI's process group and session before AgentRun saw it, and whose environment does not show that value (started with `env -i`, or, on macOS, a program whose environment the system does not show to other processes, as for some signed programs under System Integrity Protection), can keep running, and so can everything when the provider is killed.

Credentials, `${env.NAME}` references and the variables the model SDKs read themselves (base URLs, AWS and Google credentials, headers) resolve from `env` and, unless `inheritEnvironment` is false, the environment of the Pulumi CLI: the run's child process has exactly that environment, with `env` first. With `inheritEnvironment: false`, it gets `env` and a base environment without credentials (the system variables, proxies and CA certificates, the Docker connection, the Claude Code and Codex configuration locations, Go and docker-agent settings). Credentials that are not environment variables still apply: the logins of the `claude` and `codex` CLIs, the ChatGPT login of `docker agent setup` for `chatgpt` models, the AWS shared files and instance metadata for Bedrock, and the gcloud login and metadata server for Vertex AI. For a `yaml` configuration known during the preview, a preview that plans a run warns about variables the run would miss, about variables of the Pulumi CLI's environment that no longer reach a model with `inheritEnvironment: false` (since v0.2.0) or that send its requests elsewhere with `inheritEnvironment: true`, and about models that would use the machine's credentials; each run shows its models and where their credentials come from.

The processes the configuration starts get the environment of the Pulumi CLI, or with `inheritEnvironment: false` only the system variables (`PATH`, `HOME`, `USER`, `SHELL`, `LANG`, `TMPDIR`, `TZ`, ...), and `env` only as follows: command hooks and the Claude Code and Codex CLIs get `env`; `shell`, `script` and `background_jobs` tools and MCP and LSP servers started with `command` get only their toolset's own `env`. `docker:` MCP servers, filesystem `post_edit` commands, the `open_url` launcher and docker-agent's on-demand tool installation get the run's environment, `env` included. Errors, warnings and logs are redacted: the values of `env`, secret inputs, credential-named variables of the environment (`*_API_KEY`, `*_TOKEN`, `*SECRET*`, `*PASSWORD*`, ...), the variables the configuration names as `token_key`, and the tokens of the ChatGPT and Codex logins a run uses. When the answer contains one of these values, `output` and `structuredOutput` are stored as secrets. `env` values that are configuration rather than credentials (a region, a project, a boolean, a base URL without credentials) are not redacted.

Each run is isolated from the docker-agent CLI on the same machine: docker-agent's data, config and cache directories point to a private temporary directory that is deleted afterwards, so `~/.cagent` and the user settings, aliases, global providers, `.env` file and credential helper in `~/.config/cagent` are neither read nor written. The one exception is the ChatGPT login of `docker agent setup` (`~/.config/cagent/chatgpt-auth.json`), for a configuration that names a `chatgpt` model and whose environment does not set `CHATGPT_OAUTH_TOKEN`: AgentRun copies it into the run, and writes a login the run refreshed back to the file. A Docker models gateway is never used, and `model: auto` honours `DOCKER_AGENT_DEFAULT_MODEL`. The agent works in a fresh temporary directory unless `workingDir` is set. Runs of one provider process execute one at a time, and when a run ends, AgentRun stops the processes it left running, with a warning.

`logging` controls what `pulumi up` shows while the agent runs. `status` (the default) shows the models of the run and where their credentials come from (for example `models: openai/gpt-5-mini (OPENAI_API_KEY from env)`), the run's progress as status messages that the next one replaces (an agent started, a task was transferred or the conversation handed off, each tool call and whether it was approved or rejected, and why, a model that fell back to the next one) and ends with one summary line: duration, tool calls, input and output tokens and the estimated cost, or why there is none (for example "billed to the ChatGPT plan"). `tools` also logs every tool call with its arguments, and `full` also logs the agents' messages and the tools' results. `none` shows nothing. Messages are redacted like errors. When the answer is secret (`outputSecret`, or a secret `prompt`, `updatePrompt` or `yaml`), `tools` and `full` log no arguments, messages or results, and with a secret `yaml` or `agent` the messages name no agents, tools or models.

An AgentRun has two time limits. `timeoutSeconds` (default 300) limits the agent run, from loading the configuration (starting MCP servers, pulling a Docker Model Runner model) to the answer: when it runs out, the run is cancelled and the create or update fails with "the agent did not finish within ... (timeoutSeconds)". The `customTimeouts` resource option (`create`, `update`, `delete`) limits the whole provider operation, including pulling a `reference` and waiting for another AgentRun of the same provider process to finish; when it runs out, Pulumi cancels the operation and the run fails with "the operation's time limit (customTimeouts) ran out before the agent finished". The shorter limit wins. Use `customTimeouts` to bound the deployment step as a whole and keep `timeoutSeconds` as the per-run safety limit.

## Example Usage ### Structured output from an agent ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"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, "")

		// Set it with `pulumi config set --secret openaiApiKey <key>`.
		openaiApiKey := cfg.RequireSecret("openaiApiKey")

		// The agent: its answer must match a JSON schema.
		reviewer, err := dockeragent.NewAgentConfig(ctx, "reviewer", &dockeragent.AgentConfigArgs{
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Model:       pulumi.String("openai/gpt-5-mini"),
					Instruction: pulumi.String("Rate the risk of the infrastructure change and explain it in one sentence."),
					StructuredOutput: dockeragent.StructuredOutputArgs{
						Name: pulumi.String("change_review"),
						Schema: pulumi.Map{
							"type": pulumi.Any("object"),
							"properties": pulumi.Any(map[string]interface{}{
								"risk": map[string]interface{}{
									"type": "string",
									"enum": []string{
										"low",
										"medium",
										"high",
									},
								},
								"summary": map[string]string{
									"type": "string",
								},
							}),
							"required": pulumi.Any([]interface{}{
								"risk",
								"summary",
							}),
							"additionalProperties": pulumi.Any(false),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}

		// Runs the agent during `pulumi up` (never during a preview) and keeps its answer in the state.
		review, err := dockeragent.NewAgentRun(ctx, "review", &dockeragent.AgentRunArgs{
			Yaml:   reviewer.Yaml,
			Prompt: pulumi.String("Upgrade the production PostgreSQL cluster from version 15 to 17."),
			Env: pulumi.StringMap{
				"OPENAI_API_KEY": openaiApiKey,
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("verdict", review.StructuredOutput)
		ctx.Export("usage", review.Usage)
		return nil
	})
}

``` ### Run a shared agent and log its tool calls ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"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, "")

		// Set it with `pulumi config set --secret anthropicApiKey <key>`.
		anthropicApiKey := cfg.RequireSecret("anthropicApiKey")

		// The commit range to summarise, for example `v1.2.0..HEAD`.
		commits := cfg.Require("commits")

		// Pulls the agent from a registry, pinned by digest, and runs it.
		notes, err := dockeragent.NewAgentRun(ctx, "notes", &dockeragent.AgentRunArgs{
			Reference:          pulumi.String("docker.io/my-org/release-notes@sha256:2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae"),
			Prompt:             pulumi.Sprintf("Write the release notes for %v.", commits),
			InheritEnvironment: pulumi.Bool(false),
			Env: pulumi.StringMap{
				"ANTHROPIC_API_KEY": anthropicApiKey,
			},
			ToolApproval:   dockeragent.ToolApprovalDeny,
			Logging:        dockeragent.LoggingTools,
			TimeoutSeconds: pulumi.Int(600),
		})
		if err != nil {
			return err
		}
		ctx.Export("releaseNotes", notes.Output)
		ctx.Export("toolCalls", notes.ToolCalls)
		return nil
	})
}

``` ### Claude Code on a Claude subscription ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"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, "")

		// A long-lived token from `claude setup-token`, which needs a Claude subscription. Set it with
		// `pulumi config set --secret claudeCodeOauthToken <token>`.
		claudeCodeOauthToken := cfg.RequireSecret("claudeCodeOauthToken")

		// The agent: Claude Code as a coding harness. It needs no model and no API key.
		coder, err := dockeragent.NewAgentConfig(ctx, "coder", &dockeragent.AgentConfigArgs{
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Description: pulumi.String("Maintains the notes of a repository with Claude Code"),
					Harness: &dockeragent.HarnessArgs{
						Type:   dockeragent.HarnessTypeClaudeCode,
						Model:  pulumi.String("sonnet"),
						Effort: dockeragent.HarnessEffortHigh,
					},
				},
			},
		})
		if err != nil {
			return err
		}

		// Starts the claude CLI during `pulumi up` in the existing directory ./workspace, where Claude Code
		// runs its own tools (shell commands, file edits) without approval. Without `env`, it uses the
		// `claude` login of the machine that runs `pulumi up`.
		notes, err := dockeragent.NewAgentRun(ctx, "notes", &dockeragent.AgentRunArgs{
			Yaml:               coder.Yaml,
			AllowHarnessAgents: pulumi.Bool(true),
			WorkingDir:         pulumi.String("./workspace"),
			Prompt:             pulumi.String("Write NOTES.md with three bullet points about the files in this directory."),
			UpdatePrompt:       pulumi.String("NOTES.md exists. Bring it up to date and keep its format."),
			DeletePrompt:       pulumi.String("Delete NOTES.md if it exists, then answer: done."),
			InheritEnvironment: pulumi.Bool(false),
			Env: pulumi.StringMap{
				"CLAUDE_CODE_OAUTH_TOKEN": claudeCodeOauthToken,
			},
			TimeoutSeconds: pulumi.Int(900),
		}, pulumi.DeleteBeforeReplace(true))
		if err != nil {
			return err
		}
		ctx.Export("summary", notes.Output)
		ctx.Export("usage", notes.Usage)
		return nil
	})
}

``` ### A ChatGPT subscription model ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// A docker-agent agent on a ChatGPT plan (Plus, Pro or Business). Sign in once with
		// `docker agent setup` (choose ChatGPT) on the machine that runs `pulumi up`; no API key.
		// The models available depend on the plan: use one that `codex` lists for your account
		// (run `codex`, then /model).
		reviewer, err := dockeragent.NewAgentConfig(ctx, "reviewer", &dockeragent.AgentConfigArgs{
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Model:       pulumi.String("chatgpt/gpt-5.5"),
					Instruction: pulumi.String("You review Pulumi programs for security issues. Answer in at most five bullet points."),
					Toolsets: dockeragent.ToolsetArray{
						&dockeragent.ToolsetArgs{
							Type: pulumi.String("filesystem"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}

		// Reads the files of ./infra with the read-only filesystem tools: toolApproval: deny (the
		// default) rejects writes. The ChatGPT login is not an environment variable, so the run uses
		// it also with inheritEnvironment: false.
		review, err := dockeragent.NewAgentRun(ctx, "review", &dockeragent.AgentRunArgs{
			Yaml:               reviewer.Yaml,
			WorkingDir:         pulumi.String("./infra"),
			Prompt:             pulumi.String("Review the Pulumi program in this directory."),
			InheritEnvironment: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		ctx.Export("findings", review.Output)
		ctx.Export("usage", review.Usage)
		return nil
	})
}

``` ### Codex on a ChatGPT plan ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"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, "")

		// A Codex home of AgentRun's own, logged in once with a ChatGPT plan:
		// `mkdir ~/.codex-agentrun && CODEX_HOME=~/.codex-agentrun codex login`. Set it with
		// `pulumi config set codexHome $HOME/.codex-agentrun`.
		codexHome := cfg.Require("codexHome")

		// The agent: Codex as a coding harness. Without harness.model, Codex uses the model of its
		// config.toml, or its default.
		coder, err := dockeragent.NewAgentConfig(ctx, "coder", &dockeragent.AgentConfigArgs{
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Description: pulumi.String("Maintains the notes of a repository with Codex"),
					Harness: &dockeragent.HarnessArgs{
						Type: dockeragent.HarnessTypeCodex,
					},
				},
			},
		})
		if err != nil {
			return err
		}

		// Starts the codex CLI during `pulumi up` in the existing directory ./workspace. With
		// toolApproval: deny (the default), Codex runs its commands in its workspace-write sandbox:
		// they can write only in workingDir and the temporary directories and reach no network, but
		// they can read every file of the user.
		notes, err := dockeragent.NewAgentRun(ctx, "notes", &dockeragent.AgentRunArgs{
			Yaml:               coder.Yaml,
			AllowHarnessAgents: pulumi.Bool(true),
			WorkingDir:         pulumi.String("./workspace"),
			Prompt:             pulumi.String("Write NOTES.md with three bullet points about the files in this directory."),
			UpdatePrompt:       pulumi.String("NOTES.md exists. Bring it up to date and keep its format."),
			InheritEnvironment: pulumi.Bool(false),
			Env: pulumi.StringMap{
				"CODEX_HOME": pulumi.String(codexHome),
			},
			TimeoutSeconds: pulumi.Int(900),
		})
		if err != nil {
			return err
		}
		ctx.Export("summary", notes.Output)
		ctx.Export("usage", notes.Usage)
		return nil
	})
}

``` ### One agent, several runs ```go package main

import (

"fmt"

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"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, "")

		// Set it with `pulumi config set --secret openaiApiKey <key>`.
		openaiApiKey := cfg.RequireSecret("openaiApiKey")

		// The agent, authored once.
		writer, err := dockeragent.NewAgentConfig(ctx, "writer", &dockeragent.AgentConfigArgs{
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Model:       pulumi.String("openai/gpt-5-mini"),
					Instruction: pulumi.String("You write short, precise texts about infrastructure changes."),
				},
			},
		})
		if err != nil {
			return err
		}

		// Run 1.
		summary, err := dockeragent.NewAgentRun(ctx, "summary", &dockeragent.AgentRunArgs{
			Yaml:   writer.Yaml,
			Prompt: pulumi.String("Explain in two sentences why a team upgrades PostgreSQL from version 15 to 17."),
			Env: pulumi.StringMap{
				"OPENAI_API_KEY": openaiApiKey,
			},
		})
		if err != nil {
			return err
		}

		// Run 2: the same agent with another prompt. It uses the answer of run 1 and runs again whenever
		// run 1 ran, also when that answer did not change.
		translation, err := dockeragent.NewAgentRun(ctx, "translation", &dockeragent.AgentRunArgs{
			Yaml: writer.Yaml,
			Prompt: summary.Output.ApplyT(func(output string) (string, error) {
				return fmt.Sprintf("Translate this text into German: %v", output), nil
			}).(pulumi.StringOutput),
			Triggers: pulumi.Array{
				summary.RanAt,
			},
			Env: pulumi.StringMap{
				"OPENAI_API_KEY": openaiApiKey,
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("summaryText", summary.Output)
		ctx.Export("translationText", translation.Output)
		return nil
	})
}

```

## Import

An AgentRun cannot be imported: a run has nothing to read back. Declare the resource instead; the next `pulumi up` runs the agent.

func GetAgentRun

func GetAgentRun(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AgentRunState, opts ...pulumi.ResourceOption) (*AgentRun, error)

GetAgentRun gets an existing AgentRun resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAgentRun

func NewAgentRun(ctx *pulumi.Context,
	name string, args *AgentRunArgs, opts ...pulumi.ResourceOption) (*AgentRun, error)

NewAgentRun registers a new resource with the given unique name, arguments, and options.

func (*AgentRun) ElementType

func (*AgentRun) ElementType() reflect.Type

func (*AgentRun) ToAgentRunOutput

func (i *AgentRun) ToAgentRunOutput() AgentRunOutput

func (*AgentRun) ToAgentRunOutputWithContext

func (i *AgentRun) ToAgentRunOutputWithContext(ctx context.Context) AgentRunOutput

type AgentRunArgs

type AgentRunArgs struct {
	// The agent to run. Defaults to `root`, or else the first agent of the configuration.
	Agent pulumi.StringPtrInput
	// Run coding-harness agents: agents with `harness`. AgentRun supports `harness.type: claude-code` and `codex` on Linux and macOS. Such an agent starts the Claude Code CLI (`claude`) or the Codex CLI (`codex`) on the machine that runs `pulumi up`. The CLI runs its own tools (shell commands, file edits, web requests, MCP tools): `allowHookApprovals` and the configuration's `permissions` do not apply to it. Claude Code runs them without approval whatever `toolApproval` says; Codex runs its commands in its `workspace-write` sandbox under `toolApproval: deny` (which limits writes and network, not reads) and without a sandbox under `allow`. The CLI runs in `workingDir`, with the environment described for `inheritEnvironment` plus `env`. It uses its user's login and settings: the `claude` login of this machine or `CLAUDE_CODE_OAUTH_TOKEN` in `env`, or the Codex login of `CODEX_HOME` (default `~/.codex`) or `CODEX_API_KEY` in `env`. Without it, a coding-harness agent fails the run, and a `yaml` configuration (that the provider's docker-agent version can load) already fails the preview. Changing it updates the state without running the agent again.
	AllowHarnessAgents pulumi.BoolPtrInput
	// Let the configuration's hooks approve tool calls under `toolApproval: deny`. docker-agent runs a tool call that a `pre_tool_use` hook (`permission_decision: allow`) or a `permission_request` hook approves; by default AgentRun ignores such approvals and rejects the call, so `deny` only runs what docker-agent approves by its rules. Hook denials always apply. It has no effect with `toolApproval: allow`.
	AllowHookApprovals pulumi.BoolPtrInput
	// A user message the agent runs when the resource is deleted: by `pulumi destroy`, by removing it from the program, or by a replacement. It runs with the configuration and inputs stored in the state, and the environment of the deleting command, for example to clean up what earlier runs created in `workingDir`. Its answer is not kept. When it fails, the delete fails and the resource stays in the state. For a resource that was removed or replaced, that fails every later `pulumi up` as well. To delete without running it, set `DOCKER_AGENT_SKIP_DELETE_PROMPTS=true` for that command. It is skipped with a warning when `workingDir` no longer exists or is no longer a directory, and when an AgentRun of the same provider already ran in that `workingDir` during the same `pulumi` command. That happens when a replacement or a rename creates the new run first; use the `deleteBeforeReplace` resource option or `aliases`. It does not run with the `retainOnDelete` resource option, or when the `deletedWith` resource is deleted in the same operation. Changing it updates the state without running the agent.
	DeletePrompt pulumi.StringPtrInput
	// Environment variables for model credentials (for example `OPENAI_API_KEY`, `AWS_ACCESS_KEY_ID` or the `tokenKey` of a custom provider), the variables the model SDKs read (base URLs such as `OPENAI_BASE_URL`, `GOOGLE_APPLICATION_CREDENTIALS`, headers) and `${env.NAME}` references in the configuration. The run's child process gets them over the environment of the Pulumi CLI (with `inheritEnvironment`) or over a base environment without credentials. They are stored as secrets and redacted from errors and logs (except values that are configuration, such as a region or a boolean), and also reach command hooks and the Claude Code and Codex CLIs of coding-harness agents (for example `CLAUDE_CODE_OAUTH_TOKEN`, `CODEX_HOME` or `CODEX_API_KEY`). When `env` sets `CLAUDE_CODE_OAUTH_TOKEN`, an inherited `ANTHROPIC_API_KEY` or `ANTHROPIC_AUTH_TOKEN` is not passed to Claude Code, and when it sets `CODEX_ACCESS_TOKEN`, an inherited `CODEX_API_KEY` is not passed to Codex. `shell`, `script` and `background_jobs` tools and MCP and LSP servers get them only through their toolset's own `env` (`${env.NAME}`); `docker:` MCP servers, filesystem `post_edit` commands, the `open_url` launcher and docker-agent's on-demand tool installation get them too.
	Env pulumi.StringMapInput
	// Also resolve credentials, `${env.NAME}` references and the variables the model SDKs read (base URLs, AWS and Google credentials, headers) from the environment of the Pulumi CLI, and let the processes the configuration starts inherit that environment. With `false`, the run's child process gets only `env` and a base environment without credentials (the system variables, proxies and CA certificates, the Docker connection, the Claude Code and Codex configuration locations, Go and docker-agent settings), so a key, base URL or header exported in the shell does not reach the models; the preview warns about such variables. Command hooks, `shell`, `script` and `background_jobs` tools, MCP and LSP servers started with `command`, and the CLIs of coding-harness agents then see the system variables (`PATH`, `HOME`, `USER`, `SHELL`, `LANG`, `TMPDIR`, `TZ`, ...) plus their own `env` (hooks and the CLIs also get `env`); Claude Code also keeps its configuration locations (`CLAUDE_CONFIG_DIR`, `CLAUDE_SECURESTORAGE_CONFIG_DIR`, `XDG_*_HOME`) and `IS_SANDBOX`, and Codex `CODEX_HOME`, `CODEX_CA_CERTIFICATE` and the proxy variables. `docker:` MCP servers, filesystem `post_edit` commands, the `open_url` launcher and docker-agent's on-demand tool installation get the child's environment. Credentials that are not environment variables still apply: the logins of the `claude` and `codex` CLIs, the ChatGPT login of `docker agent setup`, the AWS shared files and instance metadata, and the gcloud login. docker-agent's other credential sources (its `.env` file, credential helper, Docker Desktop) are never used.
	InheritEnvironment pulumi.BoolPtrInput
	// What `pulumi up` shows while the agent runs. `status` (default) shows the run's progress as status messages that the next one replaces (an agent started, a task was transferred or the conversation handed off, each tool call and whether it was approved or rejected, a model that fell back to the next one) and logs one summary (duration, tool calls, input and output tokens, estimated cost). `tools` also logs every tool call with its arguments, `full` also the agents' messages and the tools' results; `none` shows nothing. Messages are redacted like errors (`env` values, secret inputs, credentials of the environment and `tokenKey` variables). When the answer is secret (`outputSecret`, or a secret `prompt`, `updatePrompt` or `yaml`; for a delete run also a secret `deletePrompt`), `tools` and `full` log no arguments, messages or results, and with a secret `yaml` or `agent` the messages name no agents, tools or models. Changing it updates the state without running the agent again.
	Logging LoggingPtrInput
	// Mark `output` and `structuredOutput` as secret. They are also secret when `prompt`, `updatePrompt` or `yaml` is secret, and when the answer contains the value of a secret (an `env` value, a secret input, or a credential of the environment such as an API key the agent was given through `${env.NAME}`). A secret `env` alone does not make them secret. Changing it updates the state without running the agent again.
	OutputSecret pulumi.BoolPtrInput
	// The user message sent when the resource is created, and on reruns caused by a change of `prompt`.
	Prompt pulumi.StringInput
	// An agent shared through an OCI registry (`registry/repository:tag` or `@sha256:...`), pulled like `getAgent` with the provider's `registryAuth`. Pin it by digest, or use `triggers`, to control when a moved tag reruns the agent: only input changes do.
	Reference pulumi.StringPtrInput
	// When `pulumi up` runs the agent again after it first ran. `onChange` (default) runs it when an input that affects the run changes, including `triggers`. `always` runs it on every `pulumi up` that includes this resource. The preview then shows the resource as an update (`[diff: ~rerun]`) with unknown outputs, so a stack with such an AgentRun never previews without changes, and resources that consume its outputs change too. `pulumi refresh` reports no drift for it. Changing `rerun` alone updates the state, unless the new value is `always`.
	Rerun RerunPolicyPtrInput
	// How long the run may take, in seconds, from loading the configuration (starting MCP servers, pulling a Docker Model Runner model) to the answer, before it fails. When it runs out, AgentRun stops the run and the processes it started, including a Claude Code or Codex CLI: SIGTERM (Codex gets SIGINT 2 s before), and SIGKILL after 10 s (or 1 s after the CLI exited, if that comes first). Changing it updates the state without running the agent again.
	TimeoutSeconds pulumi.IntPtrInput
	// What happens to tool calls that docker-agent would ask a user to confirm. `deny` rejects them and tells the model; `allow` approves every tool call. Tools run on the machine executing `pulumi up`. For a Codex agent it also selects Codex's sandbox: `deny` runs its commands in Codex's `workspace-write` sandbox (writes only in `workingDir` and the temporary directories, no network, reads unrestricted), `allow` turns the sandbox off. Claude Code agents run every tool without approval either way.
	ToolApproval ToolApprovalPtrInput
	// Arbitrary values; any change runs the agent again, like a change of any other input.
	Triggers pulumi.ArrayInput
	// The user message sent when the agent runs again while `prompt` is unchanged: after a change of `triggers`, `yaml`, `reference`, `agent`, `env`, `inheritEnvironment`, `workingDir`, `toolApproval` or `allowHookApprovals`, or on every `pulumi up` with `rerun: always`. When `prompt` changes, the rerun sends `prompt`. Defaults to `prompt`. Use it to tell the agent that its earlier work exists, for example files in `workingDir`. Changing it updates the state without running the agent; the next rerun uses it.
	UpdatePrompt pulumi.StringPtrInput
	// The agent's working directory, used by the shell, filesystem and other local tools, and the Claude Code or Codex CLI of a coding-harness agent. Defaults to a fresh temporary directory that is deleted after the run. Relative paths are resolved against the directory of the Pulumi program.
	WorkingDir pulumi.StringPtrInput
	// The docker-agent configuration to run, for example `AgentConfig.yaml` or the contents of an agent file. Exactly one of `yaml` and `reference` is required.
	Yaml pulumi.StringPtrInput
}

The set of arguments for constructing a AgentRun resource.

func (AgentRunArgs) ElementType

func (AgentRunArgs) ElementType() reflect.Type

type AgentRunArray

type AgentRunArray []AgentRunInput

func (AgentRunArray) ElementType

func (AgentRunArray) ElementType() reflect.Type

func (AgentRunArray) ToAgentRunArrayOutput

func (i AgentRunArray) ToAgentRunArrayOutput() AgentRunArrayOutput

func (AgentRunArray) ToAgentRunArrayOutputWithContext

func (i AgentRunArray) ToAgentRunArrayOutputWithContext(ctx context.Context) AgentRunArrayOutput

type AgentRunArrayInput

type AgentRunArrayInput interface {
	pulumi.Input

	ToAgentRunArrayOutput() AgentRunArrayOutput
	ToAgentRunArrayOutputWithContext(context.Context) AgentRunArrayOutput
}

AgentRunArrayInput is an input type that accepts AgentRunArray and AgentRunArrayOutput values. You can construct a concrete instance of `AgentRunArrayInput` via:

AgentRunArray{ AgentRunArgs{...} }

type AgentRunArrayOutput

type AgentRunArrayOutput struct{ *pulumi.OutputState }

func (AgentRunArrayOutput) ElementType

func (AgentRunArrayOutput) ElementType() reflect.Type

func (AgentRunArrayOutput) Index

func (AgentRunArrayOutput) ToAgentRunArrayOutput

func (o AgentRunArrayOutput) ToAgentRunArrayOutput() AgentRunArrayOutput

func (AgentRunArrayOutput) ToAgentRunArrayOutputWithContext

func (o AgentRunArrayOutput) ToAgentRunArrayOutputWithContext(ctx context.Context) AgentRunArrayOutput

type AgentRunInput

type AgentRunInput interface {
	pulumi.Input

	ToAgentRunOutput() AgentRunOutput
	ToAgentRunOutputWithContext(ctx context.Context) AgentRunOutput
}

type AgentRunMap

type AgentRunMap map[string]AgentRunInput

func (AgentRunMap) ElementType

func (AgentRunMap) ElementType() reflect.Type

func (AgentRunMap) ToAgentRunMapOutput

func (i AgentRunMap) ToAgentRunMapOutput() AgentRunMapOutput

func (AgentRunMap) ToAgentRunMapOutputWithContext

func (i AgentRunMap) ToAgentRunMapOutputWithContext(ctx context.Context) AgentRunMapOutput

type AgentRunMapInput

type AgentRunMapInput interface {
	pulumi.Input

	ToAgentRunMapOutput() AgentRunMapOutput
	ToAgentRunMapOutputWithContext(context.Context) AgentRunMapOutput
}

AgentRunMapInput is an input type that accepts AgentRunMap and AgentRunMapOutput values. You can construct a concrete instance of `AgentRunMapInput` via:

AgentRunMap{ "key": AgentRunArgs{...} }

type AgentRunMapOutput

type AgentRunMapOutput struct{ *pulumi.OutputState }

func (AgentRunMapOutput) ElementType

func (AgentRunMapOutput) ElementType() reflect.Type

func (AgentRunMapOutput) MapIndex

func (AgentRunMapOutput) ToAgentRunMapOutput

func (o AgentRunMapOutput) ToAgentRunMapOutput() AgentRunMapOutput

func (AgentRunMapOutput) ToAgentRunMapOutputWithContext

func (o AgentRunMapOutput) ToAgentRunMapOutputWithContext(ctx context.Context) AgentRunMapOutput

type AgentRunOutput

type AgentRunOutput struct{ *pulumi.OutputState }

func (AgentRunOutput) Agent

The agent to run. Defaults to `root`, or else the first agent of the configuration.

func (AgentRunOutput) AgentName

func (o AgentRunOutput) AgentName() pulumi.StringOutput

The agent that gave the final answer: the selected agent, or the agent it handed the conversation off to.

func (AgentRunOutput) AllowHarnessAgents added in v0.1.2

func (o AgentRunOutput) AllowHarnessAgents() pulumi.BoolOutput

Run coding-harness agents: agents with `harness`. AgentRun supports `harness.type: claude-code` and `codex` on Linux and macOS. Such an agent starts the Claude Code CLI (`claude`) or the Codex CLI (`codex`) on the machine that runs `pulumi up`. The CLI runs its own tools (shell commands, file edits, web requests, MCP tools): `allowHookApprovals` and the configuration's `permissions` do not apply to it. Claude Code runs them without approval whatever `toolApproval` says; Codex runs its commands in its `workspace-write` sandbox under `toolApproval: deny` (which limits writes and network, not reads) and without a sandbox under `allow`. The CLI runs in `workingDir`, with the environment described for `inheritEnvironment` plus `env`. It uses its user's login and settings: the `claude` login of this machine or `CLAUDE_CODE_OAUTH_TOKEN` in `env`, or the Codex login of `CODEX_HOME` (default `~/.codex`) or `CODEX_API_KEY` in `env`. Without it, a coding-harness agent fails the run, and a `yaml` configuration (that the provider's docker-agent version can load) already fails the preview. Changing it updates the state without running the agent again.

func (AgentRunOutput) AllowHookApprovals

func (o AgentRunOutput) AllowHookApprovals() pulumi.BoolOutput

Let the configuration's hooks approve tool calls under `toolApproval: deny`. docker-agent runs a tool call that a `pre_tool_use` hook (`permission_decision: allow`) or a `permission_request` hook approves; by default AgentRun ignores such approvals and rejects the call, so `deny` only runs what docker-agent approves by its rules. Hook denials always apply. It has no effect with `toolApproval: allow`.

func (AgentRunOutput) DeletePrompt added in v0.1.2

func (o AgentRunOutput) DeletePrompt() pulumi.StringPtrOutput

A user message the agent runs when the resource is deleted: by `pulumi destroy`, by removing it from the program, or by a replacement. It runs with the configuration and inputs stored in the state, and the environment of the deleting command, for example to clean up what earlier runs created in `workingDir`. Its answer is not kept. When it fails, the delete fails and the resource stays in the state. For a resource that was removed or replaced, that fails every later `pulumi up` as well. To delete without running it, set `DOCKER_AGENT_SKIP_DELETE_PROMPTS=true` for that command. It is skipped with a warning when `workingDir` no longer exists or is no longer a directory, and when an AgentRun of the same provider already ran in that `workingDir` during the same `pulumi` command. That happens when a replacement or a rename creates the new run first; use the `deleteBeforeReplace` resource option or `aliases`. It does not run with the `retainOnDelete` resource option, or when the `deletedWith` resource is deleted in the same operation. Changing it updates the state without running the agent.

func (AgentRunOutput) ElementType

func (AgentRunOutput) ElementType() reflect.Type

func (AgentRunOutput) Env

Environment variables for model credentials (for example `OPENAI_API_KEY`, `AWS_ACCESS_KEY_ID` or the `tokenKey` of a custom provider), the variables the model SDKs read (base URLs such as `OPENAI_BASE_URL`, `GOOGLE_APPLICATION_CREDENTIALS`, headers) and `${env.NAME}` references in the configuration. The run's child process gets them over the environment of the Pulumi CLI (with `inheritEnvironment`) or over a base environment without credentials. They are stored as secrets and redacted from errors and logs (except values that are configuration, such as a region or a boolean), and also reach command hooks and the Claude Code and Codex CLIs of coding-harness agents (for example `CLAUDE_CODE_OAUTH_TOKEN`, `CODEX_HOME` or `CODEX_API_KEY`). When `env` sets `CLAUDE_CODE_OAUTH_TOKEN`, an inherited `ANTHROPIC_API_KEY` or `ANTHROPIC_AUTH_TOKEN` is not passed to Claude Code, and when it sets `CODEX_ACCESS_TOKEN`, an inherited `CODEX_API_KEY` is not passed to Codex. `shell`, `script` and `background_jobs` tools and MCP and LSP servers get them only through their toolset's own `env` (`${env.NAME}`); `docker:` MCP servers, filesystem `post_edit` commands, the `open_url` launcher and docker-agent's on-demand tool installation get them too.

func (AgentRunOutput) InheritEnvironment

func (o AgentRunOutput) InheritEnvironment() pulumi.BoolOutput

Also resolve credentials, `${env.NAME}` references and the variables the model SDKs read (base URLs, AWS and Google credentials, headers) from the environment of the Pulumi CLI, and let the processes the configuration starts inherit that environment. With `false`, the run's child process gets only `env` and a base environment without credentials (the system variables, proxies and CA certificates, the Docker connection, the Claude Code and Codex configuration locations, Go and docker-agent settings), so a key, base URL or header exported in the shell does not reach the models; the preview warns about such variables. Command hooks, `shell`, `script` and `background_jobs` tools, MCP and LSP servers started with `command`, and the CLIs of coding-harness agents then see the system variables (`PATH`, `HOME`, `USER`, `SHELL`, `LANG`, `TMPDIR`, `TZ`, ...) plus their own `env` (hooks and the CLIs also get `env`); Claude Code also keeps its configuration locations (`CLAUDE_CONFIG_DIR`, `CLAUDE_SECURESTORAGE_CONFIG_DIR`, `XDG_*_HOME`) and `IS_SANDBOX`, and Codex `CODEX_HOME`, `CODEX_CA_CERTIFICATE` and the proxy variables. `docker:` MCP servers, filesystem `post_edit` commands, the `open_url` launcher and docker-agent's on-demand tool installation get the child's environment. Credentials that are not environment variables still apply: the logins of the `claude` and `codex` CLIs, the ChatGPT login of `docker agent setup`, the AWS shared files and instance metadata, and the gcloud login. docker-agent's other credential sources (its `.env` file, credential helper, Docker Desktop) are never used.

func (AgentRunOutput) Logging

func (o AgentRunOutput) Logging() LoggingOutput

What `pulumi up` shows while the agent runs. `status` (default) shows the run's progress as status messages that the next one replaces (an agent started, a task was transferred or the conversation handed off, each tool call and whether it was approved or rejected, a model that fell back to the next one) and logs one summary (duration, tool calls, input and output tokens, estimated cost). `tools` also logs every tool call with its arguments, `full` also the agents' messages and the tools' results; `none` shows nothing. Messages are redacted like errors (`env` values, secret inputs, credentials of the environment and `tokenKey` variables). When the answer is secret (`outputSecret`, or a secret `prompt`, `updatePrompt` or `yaml`; for a delete run also a secret `deletePrompt`), `tools` and `full` log no arguments, messages or results, and with a secret `yaml` or `agent` the messages name no agents, tools or models. Changing it updates the state without running the agent again.

func (AgentRunOutput) Output

func (o AgentRunOutput) Output() pulumi.StringOutput

The agent's final answer. For a coding-harness agent, Claude Code's final result (or, when that is empty, the text Claude Code wrote during the run), or Codex's last message.

func (AgentRunOutput) OutputSecret

func (o AgentRunOutput) OutputSecret() pulumi.BoolOutput

Mark `output` and `structuredOutput` as secret. They are also secret when `prompt`, `updatePrompt` or `yaml` is secret, and when the answer contains the value of a secret (an `env` value, a secret input, or a credential of the environment such as an API key the agent was given through `${env.NAME}`). A secret `env` alone does not make them secret. Changing it updates the state without running the agent again.

func (AgentRunOutput) Prompt

func (o AgentRunOutput) Prompt() pulumi.StringOutput

The user message sent when the resource is created, and on reruns caused by a change of `prompt`.

func (AgentRunOutput) RanAt

When the run finished (RFC 3339).

func (AgentRunOutput) Reference

func (o AgentRunOutput) Reference() pulumi.StringPtrOutput

An agent shared through an OCI registry (`registry/repository:tag` or `@sha256:...`), pulled like `getAgent` with the provider's `registryAuth`. Pin it by digest, or use `triggers`, to control when a moved tag reruns the agent: only input changes do.

func (AgentRunOutput) Rerun added in v0.1.2

When `pulumi up` runs the agent again after it first ran. `onChange` (default) runs it when an input that affects the run changes, including `triggers`. `always` runs it on every `pulumi up` that includes this resource. The preview then shows the resource as an update (`[diff: ~rerun]`) with unknown outputs, so a stack with such an AgentRun never previews without changes, and resources that consume its outputs change too. `pulumi refresh` reports no drift for it. Changing `rerun` alone updates the state, unless the new value is `always`.

func (AgentRunOutput) StructuredOutput

func (o AgentRunOutput) StructuredOutput() pulumi.AnyOutput

The final answer decoded as JSON, when the answering agent declares `structured_output`.

func (AgentRunOutput) TimeoutSeconds

func (o AgentRunOutput) TimeoutSeconds() pulumi.IntOutput

How long the run may take, in seconds, from loading the configuration (starting MCP servers, pulling a Docker Model Runner model) to the answer, before it fails. When it runs out, AgentRun stops the run and the processes it started, including a Claude Code or Codex CLI: SIGTERM (Codex gets SIGINT 2 s before), and SIGKILL after 10 s (or 1 s after the CLI exited, if that comes first). Changing it updates the state without running the agent again.

func (AgentRunOutput) ToAgentRunOutput

func (o AgentRunOutput) ToAgentRunOutput() AgentRunOutput

func (AgentRunOutput) ToAgentRunOutputWithContext

func (o AgentRunOutput) ToAgentRunOutputWithContext(ctx context.Context) AgentRunOutput

func (AgentRunOutput) ToolApproval

func (o AgentRunOutput) ToolApproval() ToolApprovalOutput

What happens to tool calls that docker-agent would ask a user to confirm. `deny` rejects them and tells the model; `allow` approves every tool call. Tools run on the machine executing `pulumi up`. For a Codex agent it also selects Codex's sandbox: `deny` runs its commands in Codex's `workspace-write` sandbox (writes only in `workingDir` and the temporary directories, no network, reads unrestricted), `allow` turns the sandbox off. Claude Code agents run every tool without approval either way.

func (AgentRunOutput) ToolCalls

func (o AgentRunOutput) ToolCalls() pulumi.StringArrayOutput

The names of the tools that ran, in order, including those of sub-agents the agent transferred tasks to and the tools Claude Code or Codex reports it ran. Rejected tool calls are reported as warnings instead.

func (AgentRunOutput) Triggers

func (o AgentRunOutput) Triggers() pulumi.ArrayOutput

Arbitrary values; any change runs the agent again, like a change of any other input.

func (AgentRunOutput) UpdatePrompt added in v0.1.2

func (o AgentRunOutput) UpdatePrompt() pulumi.StringPtrOutput

The user message sent when the agent runs again while `prompt` is unchanged: after a change of `triggers`, `yaml`, `reference`, `agent`, `env`, `inheritEnvironment`, `workingDir`, `toolApproval` or `allowHookApprovals`, or on every `pulumi up` with `rerun: always`. When `prompt` changes, the rerun sends `prompt`. Defaults to `prompt`. Use it to tell the agent that its earlier work exists, for example files in `workingDir`. Changing it updates the state without running the agent; the next rerun uses it.

func (AgentRunOutput) Usage

Token usage and estimated cost of the run.

func (AgentRunOutput) WorkingDir

func (o AgentRunOutput) WorkingDir() pulumi.StringPtrOutput

The agent's working directory, used by the shell, filesystem and other local tools, and the Claude Code or Codex CLI of a coding-harness agent. Defaults to a fresh temporary directory that is deleted after the run. Relative paths are resolved against the directory of the Pulumi program.

func (AgentRunOutput) Yaml

The docker-agent configuration to run, for example `AgentConfig.yaml` or the contents of an agent file. Exactly one of `yaml` and `reference` is required.

type AgentRunState

type AgentRunState struct {
}

func (AgentRunState) ElementType

func (AgentRunState) ElementType() reflect.Type

type AgentRunUsage

type AgentRunUsage struct {
	// Estimated cost in US dollars of the run's per-token billing, from the model pricing of the models.dev catalog bundled with docker-agent v1.150.0. 0 for models without known pricing, such as custom providers, `dmr` and `ollama`, and for runs billed to a subscription: `chatgpt` models, a Claude Code agent with the Claude login or `CLAUDE_CODE_OAUTH_TOKEN`, and a Codex agent with a ChatGPT login; the run summary then names the plan. A Claude Code agent that bills API usage reports the cost Claude Code reports (`total_cost_usd`), and a Codex agent that bills API usage an estimate at the catalog's API prices.
	Cost float64 `pulumi:"cost"`
	// Prompt tokens, including cached input tokens.
	InputTokens int `pulumi:"inputTokens"`
	// Completion tokens.
	OutputTokens int `pulumi:"outputTokens"`
}

Token usage and cost of an agent run, including sub-agents.

type AgentRunUsageOutput

type AgentRunUsageOutput struct{ *pulumi.OutputState }

Token usage and cost of an agent run, including sub-agents.

func (AgentRunUsageOutput) Cost

Estimated cost in US dollars of the run's per-token billing, from the model pricing of the models.dev catalog bundled with docker-agent v1.150.0. 0 for models without known pricing, such as custom providers, `dmr` and `ollama`, and for runs billed to a subscription: `chatgpt` models, a Claude Code agent with the Claude login or `CLAUDE_CODE_OAUTH_TOKEN`, and a Codex agent with a ChatGPT login; the run summary then names the plan. A Claude Code agent that bills API usage reports the cost Claude Code reports (`total_cost_usd`), and a Codex agent that bills API usage an estimate at the catalog's API prices.

func (AgentRunUsageOutput) ElementType

func (AgentRunUsageOutput) ElementType() reflect.Type

func (AgentRunUsageOutput) InputTokens

func (o AgentRunUsageOutput) InputTokens() pulumi.IntOutput

Prompt tokens, including cached input tokens.

func (AgentRunUsageOutput) OutputTokens

func (o AgentRunUsageOutput) OutputTokens() pulumi.IntOutput

Completion tokens.

func (AgentRunUsageOutput) ToAgentRunUsageOutput

func (o AgentRunUsageOutput) ToAgentRunUsageOutput() AgentRunUsageOutput

func (AgentRunUsageOutput) ToAgentRunUsageOutputWithContext

func (o AgentRunUsageOutput) ToAgentRunUsageOutputWithContext(ctx context.Context) AgentRunUsageOutput

type AgentsIgnore

type AgentsIgnore struct {
	pulumi.CustomResourceState

	// Where the `.agentsignore` that already existed was moved when the resource took it over. Deleting the resource moves it back. Unset when there was no file, and for an imported resource.
	BackupPath pulumi.StringPtrOutput `pulumi:"backupPath"`
	// A comment written at the top of the file. Each line is prefixed with ` #  `.
	Comment pulumi.StringPtrOutput `pulumi:"comment"`
	// The rendered `.agentsignore` file. After a refresh it holds the file's current content, so drift shows up in the next diff.
	Content pulumi.StringOutput `pulumi:"content"`
	// The project directory to write `.agentsignore` into. Resolved on the machine that runs Pulumi: `~` is that user's home directory and relative paths are relative to the Pulumi project directory. When unset, nothing is written and the resource only renders `content`.
	Directory pulumi.StringPtrOutput `pulumi:"directory"`
	// The absolute path of the written file. Unset when `directory` is unset.
	FilePath pulumi.StringPtrOutput `pulumi:"filePath"`
	// Replace an existing `.agentsignore` with different content when the resource is created or `directory` changes. Without it, the preview fails instead. An existing file is always moved to `.agentsignore.pulumi-backup` first and moved back when the resource is deleted.
	Overwrite pulumi.BoolOutput `pulumi:"overwrite"`
	// The patterns, in order, one per line, in `.gitignore` syntax: `secrets.env` matches that name at any depth, `/secrets.env` only next to the file, `build/` a directory and everything below it, `docs/**/*.draft.md` nested paths, and `!public.key` re-includes a path an earlier pattern excluded. Comments belong in `comment`.
	Patterns pulumi.StringArrayOutput `pulumi:"patterns"`
	// The hex-encoded SHA-256 of `content`.
	Sha256 pulumi.StringOutput `pulumi:"sha256"`
}

A Docker Agent [`.agentsignore`](https://docs.docker.com/ai/docker-agent/configuration/agentsignore/) file: paths the agent must not see.

The filesystem toolset hides matching paths from listings and searches and refuses to read, write or edit them. docker-agent uses the nearest `.agentsignore` at or above the working directory; patterns use `.gitignore` syntax and are anchored to the directory that contains the file. `.agentsignore` governs the filesystem toolset only. It is not a sandbox: an agent with the `shell` toolset can still read the files, so combine it with permissions or sandbox mode for a real boundary.

The patterns are validated with go-git's gitignore implementation, the library docker-agent uses: patterns that docker-agent would read differently (leading or trailing whitespace, a leading `#`, line breaks) or that can never match (invalid globs, `**` mixed into a path segment) fail during preview, and negations that re-include nothing are reported as warnings.

Without `directory`, the resource only renders `content`, for example to add the file to a container image. With `directory`, the provider writes `<directory>/.agentsignore` on create and update (atomically, mode 0644, creating missing directories) and reports changes made outside of Pulumi as drift on `pulumi refresh`. The directory is resolved on the machine that runs Pulumi; relative paths are relative to the Pulumi project directory. A symbolic link at `<directory>/.agentsignore` is kept: the file it points to is written.

If the project already has a `.agentsignore` with different content, the preview fails instead of replacing it. Copy its patterns into `patterns`, or set `overwrite: true`. Either way the existing file is moved to `.agentsignore.pulumi-backup` (output `backupPath`), and deleting the resource moves it back. Deleting the resource removes a file that the provider created, and leaves a file adopted with `pulumi import` in place. Set the `retainOnDelete` resource option to keep the file.

## Example Usage ### Hide secrets from the agent ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Writes /home/me/src/my-service/.agentsignore.
		ignore, err := dockeragent.NewAgentsIgnore(ctx, "ignore", &dockeragent.AgentsIgnoreArgs{
			Directory: pulumi.String("/home/me/src/my-service"),
			Comment:   pulumi.String("Managed by Pulumi. Keep secrets away from docker-agent."),
			Patterns: pulumi.StringArray{
				pulumi.String(".env"),
				pulumi.String(".env.*"),
				pulumi.String("*.pem"),
				pulumi.String("*.key"),
				pulumi.String("!public.key"),
				pulumi.String(".aws/"),
				pulumi.String("build/"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("agentsIgnore", ignore.Content)
		ctx.Export("filePath", ignore.FilePath)
		return nil
	})
}

``` ### Render the file for a container image ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// No `directory`: nothing is written, the file is only rendered.
		rendered, err := dockeragent.NewAgentsIgnore(ctx, "rendered", &dockeragent.AgentsIgnoreArgs{
			Patterns: pulumi.StringArray{
				pulumi.String(".git/"),
				pulumi.String("node_modules/"),
				pulumi.String("**/*.pem"),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("agentsIgnore", rendered.Content)
		return nil
	})
}

```

## Import

An existing `.agentsignore` can be imported with its project directory (or the file's path) as ID: the comment block at the top of the file becomes `comment` and every other line a pattern (comments between patterns are not imported). The file is adopted as for `UserSettings`: the import takes no backup, `overwrite` is not needed, and deleting the resource leaves the file in place. The resource ID is the file's absolute path.

```sh $ pulumi import docker-agent:index:AgentsIgnore project ./my-service ```

func GetAgentsIgnore

func GetAgentsIgnore(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AgentsIgnoreState, opts ...pulumi.ResourceOption) (*AgentsIgnore, error)

GetAgentsIgnore gets an existing AgentsIgnore resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAgentsIgnore

func NewAgentsIgnore(ctx *pulumi.Context,
	name string, args *AgentsIgnoreArgs, opts ...pulumi.ResourceOption) (*AgentsIgnore, error)

NewAgentsIgnore registers a new resource with the given unique name, arguments, and options.

func (*AgentsIgnore) ElementType

func (*AgentsIgnore) ElementType() reflect.Type

func (*AgentsIgnore) ToAgentsIgnoreOutput

func (i *AgentsIgnore) ToAgentsIgnoreOutput() AgentsIgnoreOutput

func (*AgentsIgnore) ToAgentsIgnoreOutputWithContext

func (i *AgentsIgnore) ToAgentsIgnoreOutputWithContext(ctx context.Context) AgentsIgnoreOutput

type AgentsIgnoreArgs

type AgentsIgnoreArgs struct {
	// A comment written at the top of the file. Each line is prefixed with ` #  `.
	Comment pulumi.StringPtrInput
	// The project directory to write `.agentsignore` into. Resolved on the machine that runs Pulumi: `~` is that user's home directory and relative paths are relative to the Pulumi project directory. When unset, nothing is written and the resource only renders `content`.
	Directory pulumi.StringPtrInput
	// Replace an existing `.agentsignore` with different content when the resource is created or `directory` changes. Without it, the preview fails instead. An existing file is always moved to `.agentsignore.pulumi-backup` first and moved back when the resource is deleted.
	Overwrite pulumi.BoolPtrInput
	// The patterns, in order, one per line, in `.gitignore` syntax: `secrets.env` matches that name at any depth, `/secrets.env` only next to the file, `build/` a directory and everything below it, `docs/**/*.draft.md` nested paths, and `!public.key` re-includes a path an earlier pattern excluded. Comments belong in `comment`.
	Patterns pulumi.StringArrayInput
}

The set of arguments for constructing a AgentsIgnore resource.

func (AgentsIgnoreArgs) ElementType

func (AgentsIgnoreArgs) ElementType() reflect.Type

type AgentsIgnoreArray

type AgentsIgnoreArray []AgentsIgnoreInput

func (AgentsIgnoreArray) ElementType

func (AgentsIgnoreArray) ElementType() reflect.Type

func (AgentsIgnoreArray) ToAgentsIgnoreArrayOutput

func (i AgentsIgnoreArray) ToAgentsIgnoreArrayOutput() AgentsIgnoreArrayOutput

func (AgentsIgnoreArray) ToAgentsIgnoreArrayOutputWithContext

func (i AgentsIgnoreArray) ToAgentsIgnoreArrayOutputWithContext(ctx context.Context) AgentsIgnoreArrayOutput

type AgentsIgnoreArrayInput

type AgentsIgnoreArrayInput interface {
	pulumi.Input

	ToAgentsIgnoreArrayOutput() AgentsIgnoreArrayOutput
	ToAgentsIgnoreArrayOutputWithContext(context.Context) AgentsIgnoreArrayOutput
}

AgentsIgnoreArrayInput is an input type that accepts AgentsIgnoreArray and AgentsIgnoreArrayOutput values. You can construct a concrete instance of `AgentsIgnoreArrayInput` via:

AgentsIgnoreArray{ AgentsIgnoreArgs{...} }

type AgentsIgnoreArrayOutput

type AgentsIgnoreArrayOutput struct{ *pulumi.OutputState }

func (AgentsIgnoreArrayOutput) ElementType

func (AgentsIgnoreArrayOutput) ElementType() reflect.Type

func (AgentsIgnoreArrayOutput) Index

func (AgentsIgnoreArrayOutput) ToAgentsIgnoreArrayOutput

func (o AgentsIgnoreArrayOutput) ToAgentsIgnoreArrayOutput() AgentsIgnoreArrayOutput

func (AgentsIgnoreArrayOutput) ToAgentsIgnoreArrayOutputWithContext

func (o AgentsIgnoreArrayOutput) ToAgentsIgnoreArrayOutputWithContext(ctx context.Context) AgentsIgnoreArrayOutput

type AgentsIgnoreInput

type AgentsIgnoreInput interface {
	pulumi.Input

	ToAgentsIgnoreOutput() AgentsIgnoreOutput
	ToAgentsIgnoreOutputWithContext(ctx context.Context) AgentsIgnoreOutput
}

type AgentsIgnoreMap

type AgentsIgnoreMap map[string]AgentsIgnoreInput

func (AgentsIgnoreMap) ElementType

func (AgentsIgnoreMap) ElementType() reflect.Type

func (AgentsIgnoreMap) ToAgentsIgnoreMapOutput

func (i AgentsIgnoreMap) ToAgentsIgnoreMapOutput() AgentsIgnoreMapOutput

func (AgentsIgnoreMap) ToAgentsIgnoreMapOutputWithContext

func (i AgentsIgnoreMap) ToAgentsIgnoreMapOutputWithContext(ctx context.Context) AgentsIgnoreMapOutput

type AgentsIgnoreMapInput

type AgentsIgnoreMapInput interface {
	pulumi.Input

	ToAgentsIgnoreMapOutput() AgentsIgnoreMapOutput
	ToAgentsIgnoreMapOutputWithContext(context.Context) AgentsIgnoreMapOutput
}

AgentsIgnoreMapInput is an input type that accepts AgentsIgnoreMap and AgentsIgnoreMapOutput values. You can construct a concrete instance of `AgentsIgnoreMapInput` via:

AgentsIgnoreMap{ "key": AgentsIgnoreArgs{...} }

type AgentsIgnoreMapOutput

type AgentsIgnoreMapOutput struct{ *pulumi.OutputState }

func (AgentsIgnoreMapOutput) ElementType

func (AgentsIgnoreMapOutput) ElementType() reflect.Type

func (AgentsIgnoreMapOutput) MapIndex

func (AgentsIgnoreMapOutput) ToAgentsIgnoreMapOutput

func (o AgentsIgnoreMapOutput) ToAgentsIgnoreMapOutput() AgentsIgnoreMapOutput

func (AgentsIgnoreMapOutput) ToAgentsIgnoreMapOutputWithContext

func (o AgentsIgnoreMapOutput) ToAgentsIgnoreMapOutputWithContext(ctx context.Context) AgentsIgnoreMapOutput

type AgentsIgnoreOutput

type AgentsIgnoreOutput struct{ *pulumi.OutputState }

func (AgentsIgnoreOutput) BackupPath

func (o AgentsIgnoreOutput) BackupPath() pulumi.StringPtrOutput

Where the `.agentsignore` that already existed was moved when the resource took it over. Deleting the resource moves it back. Unset when there was no file, and for an imported resource.

func (AgentsIgnoreOutput) Comment

A comment written at the top of the file. Each line is prefixed with ` # `.

func (AgentsIgnoreOutput) Content

The rendered `.agentsignore` file. After a refresh it holds the file's current content, so drift shows up in the next diff.

func (AgentsIgnoreOutput) Directory

The project directory to write `.agentsignore` into. Resolved on the machine that runs Pulumi: `~` is that user's home directory and relative paths are relative to the Pulumi project directory. When unset, nothing is written and the resource only renders `content`.

func (AgentsIgnoreOutput) ElementType

func (AgentsIgnoreOutput) ElementType() reflect.Type

func (AgentsIgnoreOutput) FilePath

The absolute path of the written file. Unset when `directory` is unset.

func (AgentsIgnoreOutput) Overwrite

func (o AgentsIgnoreOutput) Overwrite() pulumi.BoolOutput

Replace an existing `.agentsignore` with different content when the resource is created or `directory` changes. Without it, the preview fails instead. An existing file is always moved to `.agentsignore.pulumi-backup` first and moved back when the resource is deleted.

func (AgentsIgnoreOutput) Patterns

The patterns, in order, one per line, in `.gitignore` syntax: `secrets.env` matches that name at any depth, `/secrets.env` only next to the file, `build/` a directory and everything below it, `docs/**/*.draft.md` nested paths, and `!public.key` re-includes a path an earlier pattern excluded. Comments belong in `comment`.

func (AgentsIgnoreOutput) Sha256

The hex-encoded SHA-256 of `content`.

func (AgentsIgnoreOutput) ToAgentsIgnoreOutput

func (o AgentsIgnoreOutput) ToAgentsIgnoreOutput() AgentsIgnoreOutput

func (AgentsIgnoreOutput) ToAgentsIgnoreOutputWithContext

func (o AgentsIgnoreOutput) ToAgentsIgnoreOutputWithContext(ctx context.Context) AgentsIgnoreOutput

type AgentsIgnoreState

type AgentsIgnoreState struct {
}

func (AgentsIgnoreState) ElementType

func (AgentsIgnoreState) ElementType() reflect.Type

type ApiArg

type ApiArg struct {
	// Argument description
	Description *string `pulumi:"description"`
	// Allowed values of the argument. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Enum []string `pulumi:"enum"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Argument type
	Type *string `pulumi:"type"`
}

The `ApiConfig.args{}` object of a docker-agent configuration.

type ApiArgArgs

type ApiArgArgs struct {
	// Argument description
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Allowed values of the argument. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Enum pulumi.StringArrayInput `pulumi:"enum"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Argument type
	Type pulumi.StringPtrInput `pulumi:"type"`
}

The `ApiConfig.args{}` object of a docker-agent configuration.

func (ApiArgArgs) ElementType

func (ApiArgArgs) ElementType() reflect.Type

func (ApiArgArgs) ToApiArgOutput

func (i ApiArgArgs) ToApiArgOutput() ApiArgOutput

func (ApiArgArgs) ToApiArgOutputWithContext

func (i ApiArgArgs) ToApiArgOutputWithContext(ctx context.Context) ApiArgOutput

type ApiArgInput

type ApiArgInput interface {
	pulumi.Input

	ToApiArgOutput() ApiArgOutput
	ToApiArgOutputWithContext(context.Context) ApiArgOutput
}

ApiArgInput is an input type that accepts ApiArgArgs and ApiArgOutput values. You can construct a concrete instance of `ApiArgInput` via:

ApiArgArgs{...}

type ApiArgMap

type ApiArgMap map[string]ApiArgInput

func (ApiArgMap) ElementType

func (ApiArgMap) ElementType() reflect.Type

func (ApiArgMap) ToApiArgMapOutput

func (i ApiArgMap) ToApiArgMapOutput() ApiArgMapOutput

func (ApiArgMap) ToApiArgMapOutputWithContext

func (i ApiArgMap) ToApiArgMapOutputWithContext(ctx context.Context) ApiArgMapOutput

type ApiArgMapInput

type ApiArgMapInput interface {
	pulumi.Input

	ToApiArgMapOutput() ApiArgMapOutput
	ToApiArgMapOutputWithContext(context.Context) ApiArgMapOutput
}

ApiArgMapInput is an input type that accepts ApiArgMap and ApiArgMapOutput values. You can construct a concrete instance of `ApiArgMapInput` via:

ApiArgMap{ "key": ApiArgArgs{...} }

type ApiArgMapOutput

type ApiArgMapOutput struct{ *pulumi.OutputState }

func (ApiArgMapOutput) ElementType

func (ApiArgMapOutput) ElementType() reflect.Type

func (ApiArgMapOutput) MapIndex

func (ApiArgMapOutput) ToApiArgMapOutput

func (o ApiArgMapOutput) ToApiArgMapOutput() ApiArgMapOutput

func (ApiArgMapOutput) ToApiArgMapOutputWithContext

func (o ApiArgMapOutput) ToApiArgMapOutputWithContext(ctx context.Context) ApiArgMapOutput

type ApiArgOutput

type ApiArgOutput struct{ *pulumi.OutputState }

The `ApiConfig.args{}` object of a docker-agent configuration.

func (ApiArgOutput) Description

func (o ApiArgOutput) Description() pulumi.StringPtrOutput

Argument description

func (ApiArgOutput) ElementType

func (ApiArgOutput) ElementType() reflect.Type

func (ApiArgOutput) Enum

Allowed values of the argument. Accepted by docker-agent's loader, although agent-schema.json does not list it here.

func (ApiArgOutput) Extra

func (o ApiArgOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ApiArgOutput) ToApiArgOutput

func (o ApiArgOutput) ToApiArgOutput() ApiArgOutput

func (ApiArgOutput) ToApiArgOutputWithContext

func (o ApiArgOutput) ToApiArgOutputWithContext(ctx context.Context) ApiArgOutput

func (ApiArgOutput) Type

Argument type

type ApiConfig

type ApiConfig struct {
	// Arguments schema for the API call
	Args map[string]ApiArg `pulumi:"args"`
	// API endpoint URL
	Endpoint string `pulumi:"endpoint"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// HTTP headers for the request
	Headers map[string]string `pulumi:"headers"`
	// Instructions for using the API tool
	Instruction *string `pulumi:"instruction"`
	// HTTP method.
	Method HttpMethod `pulumi:"method"`
	// Name of the API tool
	Name string `pulumi:"name"`
	// JSON Schema describing the API tool's output. Used by MCP/Code Mode; tool responses are still returned as strings at runtime.
	OutputSchema map[string]interface{} `pulumi:"outputSchema"`
	// Required argument names
	Required []string `pulumi:"required"`
}

API tool configuration for making HTTP requests to external APIs

type ApiConfigArgs

type ApiConfigArgs struct {
	// Arguments schema for the API call
	Args ApiArgMapInput `pulumi:"args"`
	// API endpoint URL
	Endpoint pulumi.StringInput `pulumi:"endpoint"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// HTTP headers for the request
	Headers pulumi.StringMapInput `pulumi:"headers"`
	// Instructions for using the API tool
	Instruction pulumi.StringPtrInput `pulumi:"instruction"`
	// HTTP method.
	Method HttpMethodInput `pulumi:"method"`
	// Name of the API tool
	Name pulumi.StringInput `pulumi:"name"`
	// JSON Schema describing the API tool's output. Used by MCP/Code Mode; tool responses are still returned as strings at runtime.
	OutputSchema pulumi.MapInput `pulumi:"outputSchema"`
	// Required argument names
	Required pulumi.StringArrayInput `pulumi:"required"`
}

API tool configuration for making HTTP requests to external APIs

func (ApiConfigArgs) ElementType

func (ApiConfigArgs) ElementType() reflect.Type

func (ApiConfigArgs) ToApiConfigOutput

func (i ApiConfigArgs) ToApiConfigOutput() ApiConfigOutput

func (ApiConfigArgs) ToApiConfigOutputWithContext

func (i ApiConfigArgs) ToApiConfigOutputWithContext(ctx context.Context) ApiConfigOutput

func (ApiConfigArgs) ToApiConfigPtrOutput

func (i ApiConfigArgs) ToApiConfigPtrOutput() ApiConfigPtrOutput

func (ApiConfigArgs) ToApiConfigPtrOutputWithContext

func (i ApiConfigArgs) ToApiConfigPtrOutputWithContext(ctx context.Context) ApiConfigPtrOutput

type ApiConfigInput

type ApiConfigInput interface {
	pulumi.Input

	ToApiConfigOutput() ApiConfigOutput
	ToApiConfigOutputWithContext(context.Context) ApiConfigOutput
}

ApiConfigInput is an input type that accepts ApiConfigArgs and ApiConfigOutput values. You can construct a concrete instance of `ApiConfigInput` via:

ApiConfigArgs{...}

type ApiConfigOutput

type ApiConfigOutput struct{ *pulumi.OutputState }

API tool configuration for making HTTP requests to external APIs

func (ApiConfigOutput) Args

Arguments schema for the API call

func (ApiConfigOutput) ElementType

func (ApiConfigOutput) ElementType() reflect.Type

func (ApiConfigOutput) Endpoint

func (o ApiConfigOutput) Endpoint() pulumi.StringOutput

API endpoint URL

func (ApiConfigOutput) Extra

func (o ApiConfigOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ApiConfigOutput) Headers

HTTP headers for the request

func (ApiConfigOutput) Instruction

func (o ApiConfigOutput) Instruction() pulumi.StringPtrOutput

Instructions for using the API tool

func (ApiConfigOutput) Method

func (o ApiConfigOutput) Method() HttpMethodOutput

HTTP method.

func (ApiConfigOutput) Name

Name of the API tool

func (ApiConfigOutput) OutputSchema

func (o ApiConfigOutput) OutputSchema() pulumi.MapOutput

JSON Schema describing the API tool's output. Used by MCP/Code Mode; tool responses are still returned as strings at runtime.

func (ApiConfigOutput) Required

Required argument names

func (ApiConfigOutput) ToApiConfigOutput

func (o ApiConfigOutput) ToApiConfigOutput() ApiConfigOutput

func (ApiConfigOutput) ToApiConfigOutputWithContext

func (o ApiConfigOutput) ToApiConfigOutputWithContext(ctx context.Context) ApiConfigOutput

func (ApiConfigOutput) ToApiConfigPtrOutput

func (o ApiConfigOutput) ToApiConfigPtrOutput() ApiConfigPtrOutput

func (ApiConfigOutput) ToApiConfigPtrOutputWithContext

func (o ApiConfigOutput) ToApiConfigPtrOutputWithContext(ctx context.Context) ApiConfigPtrOutput

type ApiConfigPtrInput

type ApiConfigPtrInput interface {
	pulumi.Input

	ToApiConfigPtrOutput() ApiConfigPtrOutput
	ToApiConfigPtrOutputWithContext(context.Context) ApiConfigPtrOutput
}

ApiConfigPtrInput is an input type that accepts ApiConfigArgs, ApiConfigPtr and ApiConfigPtrOutput values. You can construct a concrete instance of `ApiConfigPtrInput` via:

        ApiConfigArgs{...}

or:

        nil

func ApiConfigPtr

func ApiConfigPtr(v *ApiConfigArgs) ApiConfigPtrInput

type ApiConfigPtrOutput

type ApiConfigPtrOutput struct{ *pulumi.OutputState }

func (ApiConfigPtrOutput) Args

Arguments schema for the API call

func (ApiConfigPtrOutput) Elem

func (ApiConfigPtrOutput) ElementType

func (ApiConfigPtrOutput) ElementType() reflect.Type

func (ApiConfigPtrOutput) Endpoint

API endpoint URL

func (ApiConfigPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ApiConfigPtrOutput) Headers

HTTP headers for the request

func (ApiConfigPtrOutput) Instruction

func (o ApiConfigPtrOutput) Instruction() pulumi.StringPtrOutput

Instructions for using the API tool

func (ApiConfigPtrOutput) Method

HTTP method.

func (ApiConfigPtrOutput) Name

Name of the API tool

func (ApiConfigPtrOutput) OutputSchema

func (o ApiConfigPtrOutput) OutputSchema() pulumi.MapOutput

JSON Schema describing the API tool's output. Used by MCP/Code Mode; tool responses are still returned as strings at runtime.

func (ApiConfigPtrOutput) Required

Required argument names

func (ApiConfigPtrOutput) ToApiConfigPtrOutput

func (o ApiConfigPtrOutput) ToApiConfigPtrOutput() ApiConfigPtrOutput

func (ApiConfigPtrOutput) ToApiConfigPtrOutputWithContext

func (o ApiConfigPtrOutput) ToApiConfigPtrOutputWithContext(ctx context.Context) ApiConfigPtrOutput

type ApiType

type ApiType string

func (ApiType) ElementType

func (ApiType) ElementType() reflect.Type

func (ApiType) ToApiTypeOutput

func (e ApiType) ToApiTypeOutput() ApiTypeOutput

func (ApiType) ToApiTypeOutputWithContext

func (e ApiType) ToApiTypeOutputWithContext(ctx context.Context) ApiTypeOutput

func (ApiType) ToApiTypePtrOutput

func (e ApiType) ToApiTypePtrOutput() ApiTypePtrOutput

func (ApiType) ToApiTypePtrOutputWithContext

func (e ApiType) ToApiTypePtrOutputWithContext(ctx context.Context) ApiTypePtrOutput

func (ApiType) ToStringOutput

func (e ApiType) ToStringOutput() pulumi.StringOutput

func (ApiType) ToStringOutputWithContext

func (e ApiType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (ApiType) ToStringPtrOutput

func (e ApiType) ToStringPtrOutput() pulumi.StringPtrOutput

func (ApiType) ToStringPtrOutputWithContext

func (e ApiType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ApiTypeInput

type ApiTypeInput interface {
	pulumi.Input

	ToApiTypeOutput() ApiTypeOutput
	ToApiTypeOutputWithContext(context.Context) ApiTypeOutput
}

ApiTypeInput is an input type that accepts values of the ApiType enum A concrete instance of `ApiTypeInput` can be one of the following:

ApiTypeOpenAIChatCompletions
ApiTypeOpenAIResponses

type ApiTypeOutput

type ApiTypeOutput struct{ *pulumi.OutputState }

func (ApiTypeOutput) ElementType

func (ApiTypeOutput) ElementType() reflect.Type

func (ApiTypeOutput) ToApiTypeOutput

func (o ApiTypeOutput) ToApiTypeOutput() ApiTypeOutput

func (ApiTypeOutput) ToApiTypeOutputWithContext

func (o ApiTypeOutput) ToApiTypeOutputWithContext(ctx context.Context) ApiTypeOutput

func (ApiTypeOutput) ToApiTypePtrOutput

func (o ApiTypeOutput) ToApiTypePtrOutput() ApiTypePtrOutput

func (ApiTypeOutput) ToApiTypePtrOutputWithContext

func (o ApiTypeOutput) ToApiTypePtrOutputWithContext(ctx context.Context) ApiTypePtrOutput

func (ApiTypeOutput) ToStringOutput

func (o ApiTypeOutput) ToStringOutput() pulumi.StringOutput

func (ApiTypeOutput) ToStringOutputWithContext

func (o ApiTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (ApiTypeOutput) ToStringPtrOutput

func (o ApiTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (ApiTypeOutput) ToStringPtrOutputWithContext

func (o ApiTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ApiTypePtrInput

type ApiTypePtrInput interface {
	pulumi.Input

	ToApiTypePtrOutput() ApiTypePtrOutput
	ToApiTypePtrOutputWithContext(context.Context) ApiTypePtrOutput
}

func ApiTypePtr

func ApiTypePtr(v string) ApiTypePtrInput

type ApiTypePtrOutput

type ApiTypePtrOutput struct{ *pulumi.OutputState }

func (ApiTypePtrOutput) Elem

func (ApiTypePtrOutput) ElementType

func (ApiTypePtrOutput) ElementType() reflect.Type

func (ApiTypePtrOutput) ToApiTypePtrOutput

func (o ApiTypePtrOutput) ToApiTypePtrOutput() ApiTypePtrOutput

func (ApiTypePtrOutput) ToApiTypePtrOutputWithContext

func (o ApiTypePtrOutput) ToApiTypePtrOutputWithContext(ctx context.Context) ApiTypePtrOutput

func (ApiTypePtrOutput) ToStringPtrOutput

func (o ApiTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (ApiTypePtrOutput) ToStringPtrOutputWithContext

func (o ApiTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Budget

type Budget struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Maximum spend for the run, in USD. Only responses the runtime can price count towards it: a model with no pricing data (unknown ID, or a custom endpoint without a model-level 'cost' block) contributes nothing, and such a run emits a warning rather than behaving as if the spend were free.
	MaxCost *float64 `pulumi:"maxCost"`
	// Maximum time the agents spend working, in Go duration format (e.g., '10m', '30s', '1h30m'). This is the sum of turn durations, NOT wall-clock since the session opened, so idle time while the user reads and types does not count. Checked at turn boundaries, so it will not interrupt an in-flight model call or tool.
	MaxTime *string `pulumi:"maxTime"`
	// Maximum cumulative input+output tokens for the run, counted over its whole lifetime. This is not the session's context length: compaction resets that, while this keeps counting.
	MaxTokens *int `pulumi:"maxTokens"`
}

Ceilings on what a single run may consume. Every limit is optional; an unset or zero limit is unlimited. The budget is scoped to a run and shared by every sub-session spawned inside it, so a fan-out to sub-agents spends against one budget rather than one per child. Exceeding any limit stops the run with an assistant message and a budget_exceeded event; raising a limit means editing the config, not answering a prompt.

type BudgetArgs

type BudgetArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Maximum spend for the run, in USD. Only responses the runtime can price count towards it: a model with no pricing data (unknown ID, or a custom endpoint without a model-level 'cost' block) contributes nothing, and such a run emits a warning rather than behaving as if the spend were free.
	MaxCost pulumi.Float64PtrInput `pulumi:"maxCost"`
	// Maximum time the agents spend working, in Go duration format (e.g., '10m', '30s', '1h30m'). This is the sum of turn durations, NOT wall-clock since the session opened, so idle time while the user reads and types does not count. Checked at turn boundaries, so it will not interrupt an in-flight model call or tool.
	MaxTime pulumi.StringPtrInput `pulumi:"maxTime"`
	// Maximum cumulative input+output tokens for the run, counted over its whole lifetime. This is not the session's context length: compaction resets that, while this keeps counting.
	MaxTokens pulumi.IntPtrInput `pulumi:"maxTokens"`
}

Ceilings on what a single run may consume. Every limit is optional; an unset or zero limit is unlimited. The budget is scoped to a run and shared by every sub-session spawned inside it, so a fan-out to sub-agents spends against one budget rather than one per child. Exceeding any limit stops the run with an assistant message and a budget_exceeded event; raising a limit means editing the config, not answering a prompt.

func (BudgetArgs) ElementType

func (BudgetArgs) ElementType() reflect.Type

func (BudgetArgs) ToBudgetOutput

func (i BudgetArgs) ToBudgetOutput() BudgetOutput

func (BudgetArgs) ToBudgetOutputWithContext

func (i BudgetArgs) ToBudgetOutputWithContext(ctx context.Context) BudgetOutput

func (BudgetArgs) ToBudgetPtrOutput

func (i BudgetArgs) ToBudgetPtrOutput() BudgetPtrOutput

func (BudgetArgs) ToBudgetPtrOutputWithContext

func (i BudgetArgs) ToBudgetPtrOutputWithContext(ctx context.Context) BudgetPtrOutput

type BudgetInput

type BudgetInput interface {
	pulumi.Input

	ToBudgetOutput() BudgetOutput
	ToBudgetOutputWithContext(context.Context) BudgetOutput
}

BudgetInput is an input type that accepts BudgetArgs and BudgetOutput values. You can construct a concrete instance of `BudgetInput` via:

BudgetArgs{...}

type BudgetMap

type BudgetMap map[string]BudgetInput

func (BudgetMap) ElementType

func (BudgetMap) ElementType() reflect.Type

func (BudgetMap) ToBudgetMapOutput

func (i BudgetMap) ToBudgetMapOutput() BudgetMapOutput

func (BudgetMap) ToBudgetMapOutputWithContext

func (i BudgetMap) ToBudgetMapOutputWithContext(ctx context.Context) BudgetMapOutput

type BudgetMapInput

type BudgetMapInput interface {
	pulumi.Input

	ToBudgetMapOutput() BudgetMapOutput
	ToBudgetMapOutputWithContext(context.Context) BudgetMapOutput
}

BudgetMapInput is an input type that accepts BudgetMap and BudgetMapOutput values. You can construct a concrete instance of `BudgetMapInput` via:

BudgetMap{ "key": BudgetArgs{...} }

type BudgetMapOutput

type BudgetMapOutput struct{ *pulumi.OutputState }

func (BudgetMapOutput) ElementType

func (BudgetMapOutput) ElementType() reflect.Type

func (BudgetMapOutput) MapIndex

func (BudgetMapOutput) ToBudgetMapOutput

func (o BudgetMapOutput) ToBudgetMapOutput() BudgetMapOutput

func (BudgetMapOutput) ToBudgetMapOutputWithContext

func (o BudgetMapOutput) ToBudgetMapOutputWithContext(ctx context.Context) BudgetMapOutput

type BudgetOutput

type BudgetOutput struct{ *pulumi.OutputState }

Ceilings on what a single run may consume. Every limit is optional; an unset or zero limit is unlimited. The budget is scoped to a run and shared by every sub-session spawned inside it, so a fan-out to sub-agents spends against one budget rather than one per child. Exceeding any limit stops the run with an assistant message and a budget_exceeded event; raising a limit means editing the config, not answering a prompt.

func (BudgetOutput) ElementType

func (BudgetOutput) ElementType() reflect.Type

func (BudgetOutput) Extra

func (o BudgetOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (BudgetOutput) MaxCost

func (o BudgetOutput) MaxCost() pulumi.Float64PtrOutput

Maximum spend for the run, in USD. Only responses the runtime can price count towards it: a model with no pricing data (unknown ID, or a custom endpoint without a model-level 'cost' block) contributes nothing, and such a run emits a warning rather than behaving as if the spend were free.

func (BudgetOutput) MaxTime

func (o BudgetOutput) MaxTime() pulumi.StringPtrOutput

Maximum time the agents spend working, in Go duration format (e.g., '10m', '30s', '1h30m'). This is the sum of turn durations, NOT wall-clock since the session opened, so idle time while the user reads and types does not count. Checked at turn boundaries, so it will not interrupt an in-flight model call or tool.

func (BudgetOutput) MaxTokens

func (o BudgetOutput) MaxTokens() pulumi.IntPtrOutput

Maximum cumulative input+output tokens for the run, counted over its whole lifetime. This is not the session's context length: compaction resets that, while this keeps counting.

func (BudgetOutput) ToBudgetOutput

func (o BudgetOutput) ToBudgetOutput() BudgetOutput

func (BudgetOutput) ToBudgetOutputWithContext

func (o BudgetOutput) ToBudgetOutputWithContext(ctx context.Context) BudgetOutput

func (BudgetOutput) ToBudgetPtrOutput

func (o BudgetOutput) ToBudgetPtrOutput() BudgetPtrOutput

func (BudgetOutput) ToBudgetPtrOutputWithContext

func (o BudgetOutput) ToBudgetPtrOutputWithContext(ctx context.Context) BudgetPtrOutput

type BudgetPtrInput

type BudgetPtrInput interface {
	pulumi.Input

	ToBudgetPtrOutput() BudgetPtrOutput
	ToBudgetPtrOutputWithContext(context.Context) BudgetPtrOutput
}

BudgetPtrInput is an input type that accepts BudgetArgs, BudgetPtr and BudgetPtrOutput values. You can construct a concrete instance of `BudgetPtrInput` via:

        BudgetArgs{...}

or:

        nil

func BudgetPtr

func BudgetPtr(v *BudgetArgs) BudgetPtrInput

type BudgetPtrOutput

type BudgetPtrOutput struct{ *pulumi.OutputState }

func (BudgetPtrOutput) Elem

func (o BudgetPtrOutput) Elem() BudgetOutput

func (BudgetPtrOutput) ElementType

func (BudgetPtrOutput) ElementType() reflect.Type

func (BudgetPtrOutput) Extra

func (o BudgetPtrOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (BudgetPtrOutput) MaxCost

Maximum spend for the run, in USD. Only responses the runtime can price count towards it: a model with no pricing data (unknown ID, or a custom endpoint without a model-level 'cost' block) contributes nothing, and such a run emits a warning rather than behaving as if the spend were free.

func (BudgetPtrOutput) MaxTime

Maximum time the agents spend working, in Go duration format (e.g., '10m', '30s', '1h30m'). This is the sum of turn durations, NOT wall-clock since the session opened, so idle time while the user reads and types does not count. Checked at turn boundaries, so it will not interrupt an in-flight model call or tool.

func (BudgetPtrOutput) MaxTokens

func (o BudgetPtrOutput) MaxTokens() pulumi.IntPtrOutput

Maximum cumulative input+output tokens for the run, counted over its whole lifetime. This is not the session's context length: compaction resets that, while this keeps counting.

func (BudgetPtrOutput) ToBudgetPtrOutput

func (o BudgetPtrOutput) ToBudgetPtrOutput() BudgetPtrOutput

func (BudgetPtrOutput) ToBudgetPtrOutputWithContext

func (o BudgetPtrOutput) ToBudgetPtrOutputWithContext(ctx context.Context) BudgetPtrOutput

type BusySendMode

type BusySendMode string

func (BusySendMode) ElementType

func (BusySendMode) ElementType() reflect.Type

func (BusySendMode) ToBusySendModeOutput

func (e BusySendMode) ToBusySendModeOutput() BusySendModeOutput

func (BusySendMode) ToBusySendModeOutputWithContext

func (e BusySendMode) ToBusySendModeOutputWithContext(ctx context.Context) BusySendModeOutput

func (BusySendMode) ToBusySendModePtrOutput

func (e BusySendMode) ToBusySendModePtrOutput() BusySendModePtrOutput

func (BusySendMode) ToBusySendModePtrOutputWithContext

func (e BusySendMode) ToBusySendModePtrOutputWithContext(ctx context.Context) BusySendModePtrOutput

func (BusySendMode) ToStringOutput

func (e BusySendMode) ToStringOutput() pulumi.StringOutput

func (BusySendMode) ToStringOutputWithContext

func (e BusySendMode) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (BusySendMode) ToStringPtrOutput

func (e BusySendMode) ToStringPtrOutput() pulumi.StringPtrOutput

func (BusySendMode) ToStringPtrOutputWithContext

func (e BusySendMode) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type BusySendModeInput

type BusySendModeInput interface {
	pulumi.Input

	ToBusySendModeOutput() BusySendModeOutput
	ToBusySendModeOutputWithContext(context.Context) BusySendModeOutput
}

BusySendModeInput is an input type that accepts values of the BusySendMode enum A concrete instance of `BusySendModeInput` can be one of the following:

BusySendModeSteer
BusySendModeQueue

type BusySendModeOutput

type BusySendModeOutput struct{ *pulumi.OutputState }

func (BusySendModeOutput) ElementType

func (BusySendModeOutput) ElementType() reflect.Type

func (BusySendModeOutput) ToBusySendModeOutput

func (o BusySendModeOutput) ToBusySendModeOutput() BusySendModeOutput

func (BusySendModeOutput) ToBusySendModeOutputWithContext

func (o BusySendModeOutput) ToBusySendModeOutputWithContext(ctx context.Context) BusySendModeOutput

func (BusySendModeOutput) ToBusySendModePtrOutput

func (o BusySendModeOutput) ToBusySendModePtrOutput() BusySendModePtrOutput

func (BusySendModeOutput) ToBusySendModePtrOutputWithContext

func (o BusySendModeOutput) ToBusySendModePtrOutputWithContext(ctx context.Context) BusySendModePtrOutput

func (BusySendModeOutput) ToStringOutput

func (o BusySendModeOutput) ToStringOutput() pulumi.StringOutput

func (BusySendModeOutput) ToStringOutputWithContext

func (o BusySendModeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (BusySendModeOutput) ToStringPtrOutput

func (o BusySendModeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (BusySendModeOutput) ToStringPtrOutputWithContext

func (o BusySendModeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type BusySendModePtrInput

type BusySendModePtrInput interface {
	pulumi.Input

	ToBusySendModePtrOutput() BusySendModePtrOutput
	ToBusySendModePtrOutputWithContext(context.Context) BusySendModePtrOutput
}

func BusySendModePtr

func BusySendModePtr(v string) BusySendModePtrInput

type BusySendModePtrOutput

type BusySendModePtrOutput struct{ *pulumi.OutputState }

func (BusySendModePtrOutput) Elem

func (BusySendModePtrOutput) ElementType

func (BusySendModePtrOutput) ElementType() reflect.Type

func (BusySendModePtrOutput) ToBusySendModePtrOutput

func (o BusySendModePtrOutput) ToBusySendModePtrOutput() BusySendModePtrOutput

func (BusySendModePtrOutput) ToBusySendModePtrOutputWithContext

func (o BusySendModePtrOutput) ToBusySendModePtrOutputWithContext(ctx context.Context) BusySendModePtrOutput

func (BusySendModePtrOutput) ToStringPtrOutput

func (o BusySendModePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (BusySendModePtrOutput) ToStringPtrOutputWithContext

func (o BusySendModePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Command

type Command struct {
	// Name of a sub-agent to switch to when this command is invoked. The agent must be defined in the team configuration. When set without 'instruction', any text typed after the slash command is forwarded as a prompt to the target agent.
	Agent *string `pulumi:"agent"`
	// Description shown in completion dialogs and help text
	Description *string `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// The prompt sent to the agent. Supports bang commands (!`command`) and positional arguments ($1, $2, etc.)
	Instruction *string `pulumi:"instruction"`
	// URL to open in the user's default browser when this command is invoked, instead of sending a prompt to the agent. Any URI scheme the OS knows how to handle works (e.g. https:// or a custom scheme like docker-desktop:// to deep-link into Docker Desktop). The token {{session_id}} is replaced at invocation time with the current session ID (URL-query-escaped).
	Url *string `pulumi:"url"`
}

Advanced command configuration. Set 'instruction' to send a prompt to the current agent. Set 'agent' to switch the active agent to a sub-agent (e.g. /plan -> the 'planner' sub-agent). Both fields can be combined: the agent is switched first, then the instruction is sent to the new agent. Set 'url' to open a URL in the user's browser instead of messaging the agent.

type CommandArgs

type CommandArgs struct {
	// Name of a sub-agent to switch to when this command is invoked. The agent must be defined in the team configuration. When set without 'instruction', any text typed after the slash command is forwarded as a prompt to the target agent.
	Agent pulumi.StringPtrInput `pulumi:"agent"`
	// Description shown in completion dialogs and help text
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// The prompt sent to the agent. Supports bang commands (!`command`) and positional arguments ($1, $2, etc.)
	Instruction pulumi.StringPtrInput `pulumi:"instruction"`
	// URL to open in the user's default browser when this command is invoked, instead of sending a prompt to the agent. Any URI scheme the OS knows how to handle works (e.g. https:// or a custom scheme like docker-desktop:// to deep-link into Docker Desktop). The token {{session_id}} is replaced at invocation time with the current session ID (URL-query-escaped).
	Url pulumi.StringPtrInput `pulumi:"url"`
}

Advanced command configuration. Set 'instruction' to send a prompt to the current agent. Set 'agent' to switch the active agent to a sub-agent (e.g. /plan -> the 'planner' sub-agent). Both fields can be combined: the agent is switched first, then the instruction is sent to the new agent. Set 'url' to open a URL in the user's browser instead of messaging the agent.

func (CommandArgs) ElementType

func (CommandArgs) ElementType() reflect.Type

func (CommandArgs) ToCommandOutput

func (i CommandArgs) ToCommandOutput() CommandOutput

func (CommandArgs) ToCommandOutputWithContext

func (i CommandArgs) ToCommandOutputWithContext(ctx context.Context) CommandOutput

type CommandGroup

type CommandGroup struct {
	// Commands in the object form: `description`, `instruction`, `agent` or `url`.
	Commands map[string]Command `pulumi:"commands"`
	// Commands in the short form `name: instruction`. A name must not appear in both maps.
	SimpleCommands map[string]string `pulumi:"simpleCommands"`
}

A named group of commands (a value of the top-level `commands` map), merged into the agents that list the group in `useCommands`. Set `commands` and/or `simpleCommands`; they are rendered together into one value.

type CommandGroupArgs

type CommandGroupArgs struct {
	// Commands in the object form: `description`, `instruction`, `agent` or `url`.
	Commands CommandMapInput `pulumi:"commands"`
	// Commands in the short form `name: instruction`. A name must not appear in both maps.
	SimpleCommands pulumi.StringMapInput `pulumi:"simpleCommands"`
}

A named group of commands (a value of the top-level `commands` map), merged into the agents that list the group in `useCommands`. Set `commands` and/or `simpleCommands`; they are rendered together into one value.

func (CommandGroupArgs) ElementType

func (CommandGroupArgs) ElementType() reflect.Type

func (CommandGroupArgs) ToCommandGroupOutput

func (i CommandGroupArgs) ToCommandGroupOutput() CommandGroupOutput

func (CommandGroupArgs) ToCommandGroupOutputWithContext

func (i CommandGroupArgs) ToCommandGroupOutputWithContext(ctx context.Context) CommandGroupOutput

type CommandGroupInput

type CommandGroupInput interface {
	pulumi.Input

	ToCommandGroupOutput() CommandGroupOutput
	ToCommandGroupOutputWithContext(context.Context) CommandGroupOutput
}

CommandGroupInput is an input type that accepts CommandGroupArgs and CommandGroupOutput values. You can construct a concrete instance of `CommandGroupInput` via:

CommandGroupArgs{...}

type CommandGroupMap

type CommandGroupMap map[string]CommandGroupInput

func (CommandGroupMap) ElementType

func (CommandGroupMap) ElementType() reflect.Type

func (CommandGroupMap) ToCommandGroupMapOutput

func (i CommandGroupMap) ToCommandGroupMapOutput() CommandGroupMapOutput

func (CommandGroupMap) ToCommandGroupMapOutputWithContext

func (i CommandGroupMap) ToCommandGroupMapOutputWithContext(ctx context.Context) CommandGroupMapOutput

type CommandGroupMapInput

type CommandGroupMapInput interface {
	pulumi.Input

	ToCommandGroupMapOutput() CommandGroupMapOutput
	ToCommandGroupMapOutputWithContext(context.Context) CommandGroupMapOutput
}

CommandGroupMapInput is an input type that accepts CommandGroupMap and CommandGroupMapOutput values. You can construct a concrete instance of `CommandGroupMapInput` via:

CommandGroupMap{ "key": CommandGroupArgs{...} }

type CommandGroupMapOutput

type CommandGroupMapOutput struct{ *pulumi.OutputState }

func (CommandGroupMapOutput) ElementType

func (CommandGroupMapOutput) ElementType() reflect.Type

func (CommandGroupMapOutput) MapIndex

func (CommandGroupMapOutput) ToCommandGroupMapOutput

func (o CommandGroupMapOutput) ToCommandGroupMapOutput() CommandGroupMapOutput

func (CommandGroupMapOutput) ToCommandGroupMapOutputWithContext

func (o CommandGroupMapOutput) ToCommandGroupMapOutputWithContext(ctx context.Context) CommandGroupMapOutput

type CommandGroupOutput

type CommandGroupOutput struct{ *pulumi.OutputState }

A named group of commands (a value of the top-level `commands` map), merged into the agents that list the group in `useCommands`. Set `commands` and/or `simpleCommands`; they are rendered together into one value.

func (CommandGroupOutput) Commands

func (o CommandGroupOutput) Commands() CommandMapOutput

Commands in the object form: `description`, `instruction`, `agent` or `url`.

func (CommandGroupOutput) ElementType

func (CommandGroupOutput) ElementType() reflect.Type

func (CommandGroupOutput) SimpleCommands

func (o CommandGroupOutput) SimpleCommands() pulumi.StringMapOutput

Commands in the short form `name: instruction`. A name must not appear in both maps.

func (CommandGroupOutput) ToCommandGroupOutput

func (o CommandGroupOutput) ToCommandGroupOutput() CommandGroupOutput

func (CommandGroupOutput) ToCommandGroupOutputWithContext

func (o CommandGroupOutput) ToCommandGroupOutputWithContext(ctx context.Context) CommandGroupOutput

type CommandInput

type CommandInput interface {
	pulumi.Input

	ToCommandOutput() CommandOutput
	ToCommandOutputWithContext(context.Context) CommandOutput
}

CommandInput is an input type that accepts CommandArgs and CommandOutput values. You can construct a concrete instance of `CommandInput` via:

CommandArgs{...}

type CommandMap

type CommandMap map[string]CommandInput

func (CommandMap) ElementType

func (CommandMap) ElementType() reflect.Type

func (CommandMap) ToCommandMapOutput

func (i CommandMap) ToCommandMapOutput() CommandMapOutput

func (CommandMap) ToCommandMapOutputWithContext

func (i CommandMap) ToCommandMapOutputWithContext(ctx context.Context) CommandMapOutput

type CommandMapInput

type CommandMapInput interface {
	pulumi.Input

	ToCommandMapOutput() CommandMapOutput
	ToCommandMapOutputWithContext(context.Context) CommandMapOutput
}

CommandMapInput is an input type that accepts CommandMap and CommandMapOutput values. You can construct a concrete instance of `CommandMapInput` via:

CommandMap{ "key": CommandArgs{...} }

type CommandMapOutput

type CommandMapOutput struct{ *pulumi.OutputState }

func (CommandMapOutput) ElementType

func (CommandMapOutput) ElementType() reflect.Type

func (CommandMapOutput) MapIndex

func (CommandMapOutput) ToCommandMapOutput

func (o CommandMapOutput) ToCommandMapOutput() CommandMapOutput

func (CommandMapOutput) ToCommandMapOutputWithContext

func (o CommandMapOutput) ToCommandMapOutputWithContext(ctx context.Context) CommandMapOutput

type CommandOutput

type CommandOutput struct{ *pulumi.OutputState }

Advanced command configuration. Set 'instruction' to send a prompt to the current agent. Set 'agent' to switch the active agent to a sub-agent (e.g. /plan -> the 'planner' sub-agent). Both fields can be combined: the agent is switched first, then the instruction is sent to the new agent. Set 'url' to open a URL in the user's browser instead of messaging the agent.

func (CommandOutput) Agent

Name of a sub-agent to switch to when this command is invoked. The agent must be defined in the team configuration. When set without 'instruction', any text typed after the slash command is forwarded as a prompt to the target agent.

func (CommandOutput) Description

func (o CommandOutput) Description() pulumi.StringPtrOutput

Description shown in completion dialogs and help text

func (CommandOutput) ElementType

func (CommandOutput) ElementType() reflect.Type

func (CommandOutput) Extra

func (o CommandOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (CommandOutput) Instruction

func (o CommandOutput) Instruction() pulumi.StringPtrOutput

The prompt sent to the agent. Supports bang commands (!`command`) and positional arguments ($1, $2, etc.)

func (CommandOutput) ToCommandOutput

func (o CommandOutput) ToCommandOutput() CommandOutput

func (CommandOutput) ToCommandOutputWithContext

func (o CommandOutput) ToCommandOutputWithContext(ctx context.Context) CommandOutput

func (CommandOutput) Url

URL to open in the user's default browser when this command is invoked, instead of sending a prompt to the agent. Any URI scheme the OS knows how to handle works (e.g. https:// or a custom scheme like docker-desktop:// to deep-link into Docker Desktop). The token {{session_id}} is replaced at invocation time with the current session ID (URL-query-escaped).

type Cost

type Cost struct {
	// USD price per 1M cached input tokens
	CacheRead *float64 `pulumi:"cacheRead"`
	// USD price per 1M cache-write tokens
	CacheWrite *float64 `pulumi:"cacheWrite"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// USD price per 1M input tokens
	Input *float64 `pulumi:"input"`
	// USD price per 1M output tokens
	Output *float64 `pulumi:"output"`
}

Explicit token pricing for a model, in USD per one million tokens. Takes precedence over the models.dev catalogue and prices models the catalogue does not know.

type CostArgs

type CostArgs struct {
	// USD price per 1M cached input tokens
	CacheRead pulumi.Float64PtrInput `pulumi:"cacheRead"`
	// USD price per 1M cache-write tokens
	CacheWrite pulumi.Float64PtrInput `pulumi:"cacheWrite"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// USD price per 1M input tokens
	Input pulumi.Float64PtrInput `pulumi:"input"`
	// USD price per 1M output tokens
	Output pulumi.Float64PtrInput `pulumi:"output"`
}

Explicit token pricing for a model, in USD per one million tokens. Takes precedence over the models.dev catalogue and prices models the catalogue does not know.

func (CostArgs) ElementType

func (CostArgs) ElementType() reflect.Type

func (CostArgs) ToCostOutput

func (i CostArgs) ToCostOutput() CostOutput

func (CostArgs) ToCostOutputWithContext

func (i CostArgs) ToCostOutputWithContext(ctx context.Context) CostOutput

func (CostArgs) ToCostPtrOutput

func (i CostArgs) ToCostPtrOutput() CostPtrOutput

func (CostArgs) ToCostPtrOutputWithContext

func (i CostArgs) ToCostPtrOutputWithContext(ctx context.Context) CostPtrOutput

type CostInput

type CostInput interface {
	pulumi.Input

	ToCostOutput() CostOutput
	ToCostOutputWithContext(context.Context) CostOutput
}

CostInput is an input type that accepts CostArgs and CostOutput values. You can construct a concrete instance of `CostInput` via:

CostArgs{...}

type CostOutput

type CostOutput struct{ *pulumi.OutputState }

Explicit token pricing for a model, in USD per one million tokens. Takes precedence over the models.dev catalogue and prices models the catalogue does not know.

func (CostOutput) CacheRead

func (o CostOutput) CacheRead() pulumi.Float64PtrOutput

USD price per 1M cached input tokens

func (CostOutput) CacheWrite

func (o CostOutput) CacheWrite() pulumi.Float64PtrOutput

USD price per 1M cache-write tokens

func (CostOutput) ElementType

func (CostOutput) ElementType() reflect.Type

func (CostOutput) Extra

func (o CostOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (CostOutput) Input

USD price per 1M input tokens

func (CostOutput) Output

func (o CostOutput) Output() pulumi.Float64PtrOutput

USD price per 1M output tokens

func (CostOutput) ToCostOutput

func (o CostOutput) ToCostOutput() CostOutput

func (CostOutput) ToCostOutputWithContext

func (o CostOutput) ToCostOutputWithContext(ctx context.Context) CostOutput

func (CostOutput) ToCostPtrOutput

func (o CostOutput) ToCostPtrOutput() CostPtrOutput

func (CostOutput) ToCostPtrOutputWithContext

func (o CostOutput) ToCostPtrOutputWithContext(ctx context.Context) CostPtrOutput

type CostPtrInput

type CostPtrInput interface {
	pulumi.Input

	ToCostPtrOutput() CostPtrOutput
	ToCostPtrOutputWithContext(context.Context) CostPtrOutput
}

CostPtrInput is an input type that accepts CostArgs, CostPtr and CostPtrOutput values. You can construct a concrete instance of `CostPtrInput` via:

        CostArgs{...}

or:

        nil

func CostPtr

func CostPtr(v *CostArgs) CostPtrInput

type CostPtrOutput

type CostPtrOutput struct{ *pulumi.OutputState }

func (CostPtrOutput) CacheRead

func (o CostPtrOutput) CacheRead() pulumi.Float64PtrOutput

USD price per 1M cached input tokens

func (CostPtrOutput) CacheWrite

func (o CostPtrOutput) CacheWrite() pulumi.Float64PtrOutput

USD price per 1M cache-write tokens

func (CostPtrOutput) Elem

func (o CostPtrOutput) Elem() CostOutput

func (CostPtrOutput) ElementType

func (CostPtrOutput) ElementType() reflect.Type

func (CostPtrOutput) Extra

func (o CostPtrOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (CostPtrOutput) Input

USD price per 1M input tokens

func (CostPtrOutput) Output

USD price per 1M output tokens

func (CostPtrOutput) ToCostPtrOutput

func (o CostPtrOutput) ToCostPtrOutput() CostPtrOutput

func (CostPtrOutput) ToCostPtrOutputWithContext

func (o CostPtrOutput) ToCostPtrOutputWithContext(ctx context.Context) CostPtrOutput

type DeleteBehavior

type DeleteBehavior string

func (DeleteBehavior) ElementType

func (DeleteBehavior) ElementType() reflect.Type

func (DeleteBehavior) ToDeleteBehaviorOutput

func (e DeleteBehavior) ToDeleteBehaviorOutput() DeleteBehaviorOutput

func (DeleteBehavior) ToDeleteBehaviorOutputWithContext

func (e DeleteBehavior) ToDeleteBehaviorOutputWithContext(ctx context.Context) DeleteBehaviorOutput

func (DeleteBehavior) ToDeleteBehaviorPtrOutput

func (e DeleteBehavior) ToDeleteBehaviorPtrOutput() DeleteBehaviorPtrOutput

func (DeleteBehavior) ToDeleteBehaviorPtrOutputWithContext

func (e DeleteBehavior) ToDeleteBehaviorPtrOutputWithContext(ctx context.Context) DeleteBehaviorPtrOutput

func (DeleteBehavior) ToStringOutput

func (e DeleteBehavior) ToStringOutput() pulumi.StringOutput

func (DeleteBehavior) ToStringOutputWithContext

func (e DeleteBehavior) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DeleteBehavior) ToStringPtrOutput

func (e DeleteBehavior) ToStringPtrOutput() pulumi.StringPtrOutput

func (DeleteBehavior) ToStringPtrOutputWithContext

func (e DeleteBehavior) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DeleteBehaviorInput

type DeleteBehaviorInput interface {
	pulumi.Input

	ToDeleteBehaviorOutput() DeleteBehaviorOutput
	ToDeleteBehaviorOutputWithContext(context.Context) DeleteBehaviorOutput
}

DeleteBehaviorInput is an input type that accepts values of the DeleteBehavior enum A concrete instance of `DeleteBehaviorInput` can be one of the following:

DeleteBehaviorRetain
DeleteBehaviorDelete

type DeleteBehaviorOutput

type DeleteBehaviorOutput struct{ *pulumi.OutputState }

func (DeleteBehaviorOutput) ElementType

func (DeleteBehaviorOutput) ElementType() reflect.Type

func (DeleteBehaviorOutput) ToDeleteBehaviorOutput

func (o DeleteBehaviorOutput) ToDeleteBehaviorOutput() DeleteBehaviorOutput

func (DeleteBehaviorOutput) ToDeleteBehaviorOutputWithContext

func (o DeleteBehaviorOutput) ToDeleteBehaviorOutputWithContext(ctx context.Context) DeleteBehaviorOutput

func (DeleteBehaviorOutput) ToDeleteBehaviorPtrOutput

func (o DeleteBehaviorOutput) ToDeleteBehaviorPtrOutput() DeleteBehaviorPtrOutput

func (DeleteBehaviorOutput) ToDeleteBehaviorPtrOutputWithContext

func (o DeleteBehaviorOutput) ToDeleteBehaviorPtrOutputWithContext(ctx context.Context) DeleteBehaviorPtrOutput

func (DeleteBehaviorOutput) ToStringOutput

func (o DeleteBehaviorOutput) ToStringOutput() pulumi.StringOutput

func (DeleteBehaviorOutput) ToStringOutputWithContext

func (o DeleteBehaviorOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DeleteBehaviorOutput) ToStringPtrOutput

func (o DeleteBehaviorOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DeleteBehaviorOutput) ToStringPtrOutputWithContext

func (o DeleteBehaviorOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DeleteBehaviorPtrInput

type DeleteBehaviorPtrInput interface {
	pulumi.Input

	ToDeleteBehaviorPtrOutput() DeleteBehaviorPtrOutput
	ToDeleteBehaviorPtrOutputWithContext(context.Context) DeleteBehaviorPtrOutput
}

func DeleteBehaviorPtr

func DeleteBehaviorPtr(v string) DeleteBehaviorPtrInput

type DeleteBehaviorPtrOutput

type DeleteBehaviorPtrOutput struct{ *pulumi.OutputState }

func (DeleteBehaviorPtrOutput) Elem

func (DeleteBehaviorPtrOutput) ElementType

func (DeleteBehaviorPtrOutput) ElementType() reflect.Type

func (DeleteBehaviorPtrOutput) ToDeleteBehaviorPtrOutput

func (o DeleteBehaviorPtrOutput) ToDeleteBehaviorPtrOutput() DeleteBehaviorPtrOutput

func (DeleteBehaviorPtrOutput) ToDeleteBehaviorPtrOutputWithContext

func (o DeleteBehaviorPtrOutput) ToDeleteBehaviorPtrOutputWithContext(ctx context.Context) DeleteBehaviorPtrOutput

func (DeleteBehaviorPtrOutput) ToStringPtrOutput

func (o DeleteBehaviorPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DeleteBehaviorPtrOutput) ToStringPtrOutputWithContext

func (o DeleteBehaviorPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Evaluator

type Evaluator struct {
	// API base URL. TypeSafe defaults to https://api.typesafe.ai with /v1/systemone; OpenAI defaults to https://api.openai.com/v1 with /decisions.
	BaseUrl *string `pulumi:"baseUrl"`
	// Connect directly even when a models gateway is configured. Custom base_url and endpoint do not implicitly bypass the gateway.
	BypassModelsGateway *bool `pulumi:"bypassModelsGateway"`
	// For `type: choice`: the possible outcomes, keyed by name, with a description of when each applies (2 to 255).
	Choices map[string]string `pulumi:"choices"`
	// Explicit USD pricing per one million evaluator input/output tokens. Overrides built-in evaluator pricing, including on custom endpoints. An empty object declares free evaluations; cache rates are unused.
	Cost *Cost `pulumi:"cost"`
	// Exact HTTP(S) evaluator URL, overriding base_url and its default path. No credentials, query, or fragment.
	Endpoint *string `pulumi:"endpoint"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// The instructions the evaluator assesses the input with.
	Instructions string `pulumi:"instructions"`
	// For `type: score`: the ordered score levels.
	Levels []string `pulumi:"levels"`
	// The evaluator model of the provider.
	Model string `pulumi:"model"`
	// Evaluator backend (typesafe or openai Decisions), or a named provider.
	Provider string `pulumi:"provider"`
	// Timeout for one evaluator call, as a duration such as `30s` or `2m` (a number of seconds `N` is written as `Ns`).
	Timeout *string `pulumi:"timeout"`
	// API key environment variable for direct calls (TYPESAFE_API_KEY or OPENAI_API_KEY). Never put the secret itself in the configuration.
	TokenKey *string `pulumi:"tokenKey"`
	// The kind of assessment: a yes/no decision, one of `choices`, or one of the score `levels`.
	Type EvaluatorType `pulumi:"type"`
}

The `EvaluatorConfig` object of a docker-agent configuration.

type EvaluatorArgs

type EvaluatorArgs struct {
	// API base URL. TypeSafe defaults to https://api.typesafe.ai with /v1/systemone; OpenAI defaults to https://api.openai.com/v1 with /decisions.
	BaseUrl pulumi.StringPtrInput `pulumi:"baseUrl"`
	// Connect directly even when a models gateway is configured. Custom base_url and endpoint do not implicitly bypass the gateway.
	BypassModelsGateway pulumi.BoolPtrInput `pulumi:"bypassModelsGateway"`
	// For `type: choice`: the possible outcomes, keyed by name, with a description of when each applies (2 to 255).
	Choices pulumi.StringMapInput `pulumi:"choices"`
	// Explicit USD pricing per one million evaluator input/output tokens. Overrides built-in evaluator pricing, including on custom endpoints. An empty object declares free evaluations; cache rates are unused.
	Cost CostPtrInput `pulumi:"cost"`
	// Exact HTTP(S) evaluator URL, overriding base_url and its default path. No credentials, query, or fragment.
	Endpoint pulumi.StringPtrInput `pulumi:"endpoint"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// The instructions the evaluator assesses the input with.
	Instructions pulumi.StringInput `pulumi:"instructions"`
	// For `type: score`: the ordered score levels.
	Levels pulumi.StringArrayInput `pulumi:"levels"`
	// The evaluator model of the provider.
	Model pulumi.StringInput `pulumi:"model"`
	// Evaluator backend (typesafe or openai Decisions), or a named provider.
	Provider pulumi.StringInput `pulumi:"provider"`
	// Timeout for one evaluator call, as a duration such as `30s` or `2m` (a number of seconds `N` is written as `Ns`).
	Timeout pulumi.StringPtrInput `pulumi:"timeout"`
	// API key environment variable for direct calls (TYPESAFE_API_KEY or OPENAI_API_KEY). Never put the secret itself in the configuration.
	TokenKey pulumi.StringPtrInput `pulumi:"tokenKey"`
	// The kind of assessment: a yes/no decision, one of `choices`, or one of the score `levels`.
	Type EvaluatorTypeInput `pulumi:"type"`
}

The `EvaluatorConfig` object of a docker-agent configuration.

func (EvaluatorArgs) ElementType

func (EvaluatorArgs) ElementType() reflect.Type

func (EvaluatorArgs) ToEvaluatorOutput

func (i EvaluatorArgs) ToEvaluatorOutput() EvaluatorOutput

func (EvaluatorArgs) ToEvaluatorOutputWithContext

func (i EvaluatorArgs) ToEvaluatorOutputWithContext(ctx context.Context) EvaluatorOutput

type EvaluatorDecision

type EvaluatorDecision string

func (EvaluatorDecision) ElementType

func (EvaluatorDecision) ElementType() reflect.Type

func (EvaluatorDecision) ToEvaluatorDecisionOutput

func (e EvaluatorDecision) ToEvaluatorDecisionOutput() EvaluatorDecisionOutput

func (EvaluatorDecision) ToEvaluatorDecisionOutputWithContext

func (e EvaluatorDecision) ToEvaluatorDecisionOutputWithContext(ctx context.Context) EvaluatorDecisionOutput

func (EvaluatorDecision) ToEvaluatorDecisionPtrOutput

func (e EvaluatorDecision) ToEvaluatorDecisionPtrOutput() EvaluatorDecisionPtrOutput

func (EvaluatorDecision) ToEvaluatorDecisionPtrOutputWithContext

func (e EvaluatorDecision) ToEvaluatorDecisionPtrOutputWithContext(ctx context.Context) EvaluatorDecisionPtrOutput

func (EvaluatorDecision) ToStringOutput

func (e EvaluatorDecision) ToStringOutput() pulumi.StringOutput

func (EvaluatorDecision) ToStringOutputWithContext

func (e EvaluatorDecision) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (EvaluatorDecision) ToStringPtrOutput

func (e EvaluatorDecision) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorDecision) ToStringPtrOutputWithContext

func (e EvaluatorDecision) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EvaluatorDecisionInput

type EvaluatorDecisionInput interface {
	pulumi.Input

	ToEvaluatorDecisionOutput() EvaluatorDecisionOutput
	ToEvaluatorDecisionOutputWithContext(context.Context) EvaluatorDecisionOutput
}

EvaluatorDecisionInput is an input type that accepts values of the EvaluatorDecision enum A concrete instance of `EvaluatorDecisionInput` can be one of the following:

EvaluatorDecisionAllow
EvaluatorDecisionAsk
EvaluatorDecisionDeny

type EvaluatorDecisionMap

type EvaluatorDecisionMap map[string]EvaluatorDecision

func (EvaluatorDecisionMap) ElementType

func (EvaluatorDecisionMap) ElementType() reflect.Type

func (EvaluatorDecisionMap) ToEvaluatorDecisionMapOutput

func (i EvaluatorDecisionMap) ToEvaluatorDecisionMapOutput() EvaluatorDecisionMapOutput

func (EvaluatorDecisionMap) ToEvaluatorDecisionMapOutputWithContext

func (i EvaluatorDecisionMap) ToEvaluatorDecisionMapOutputWithContext(ctx context.Context) EvaluatorDecisionMapOutput

type EvaluatorDecisionMapInput

type EvaluatorDecisionMapInput interface {
	pulumi.Input

	ToEvaluatorDecisionMapOutput() EvaluatorDecisionMapOutput
	ToEvaluatorDecisionMapOutputWithContext(context.Context) EvaluatorDecisionMapOutput
}

EvaluatorDecisionMapInput is an input type that accepts EvaluatorDecisionMap and EvaluatorDecisionMapOutput values. You can construct a concrete instance of `EvaluatorDecisionMapInput` via:

EvaluatorDecisionMap{ "key": EvaluatorDecisionArgs{...} }

type EvaluatorDecisionMapOutput

type EvaluatorDecisionMapOutput struct{ *pulumi.OutputState }

func (EvaluatorDecisionMapOutput) ElementType

func (EvaluatorDecisionMapOutput) ElementType() reflect.Type

func (EvaluatorDecisionMapOutput) MapIndex

func (EvaluatorDecisionMapOutput) ToEvaluatorDecisionMapOutput

func (o EvaluatorDecisionMapOutput) ToEvaluatorDecisionMapOutput() EvaluatorDecisionMapOutput

func (EvaluatorDecisionMapOutput) ToEvaluatorDecisionMapOutputWithContext

func (o EvaluatorDecisionMapOutput) ToEvaluatorDecisionMapOutputWithContext(ctx context.Context) EvaluatorDecisionMapOutput

type EvaluatorDecisionOutput

type EvaluatorDecisionOutput struct{ *pulumi.OutputState }

func (EvaluatorDecisionOutput) ElementType

func (EvaluatorDecisionOutput) ElementType() reflect.Type

func (EvaluatorDecisionOutput) ToEvaluatorDecisionOutput

func (o EvaluatorDecisionOutput) ToEvaluatorDecisionOutput() EvaluatorDecisionOutput

func (EvaluatorDecisionOutput) ToEvaluatorDecisionOutputWithContext

func (o EvaluatorDecisionOutput) ToEvaluatorDecisionOutputWithContext(ctx context.Context) EvaluatorDecisionOutput

func (EvaluatorDecisionOutput) ToEvaluatorDecisionPtrOutput

func (o EvaluatorDecisionOutput) ToEvaluatorDecisionPtrOutput() EvaluatorDecisionPtrOutput

func (EvaluatorDecisionOutput) ToEvaluatorDecisionPtrOutputWithContext

func (o EvaluatorDecisionOutput) ToEvaluatorDecisionPtrOutputWithContext(ctx context.Context) EvaluatorDecisionPtrOutput

func (EvaluatorDecisionOutput) ToStringOutput

func (o EvaluatorDecisionOutput) ToStringOutput() pulumi.StringOutput

func (EvaluatorDecisionOutput) ToStringOutputWithContext

func (o EvaluatorDecisionOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (EvaluatorDecisionOutput) ToStringPtrOutput

func (o EvaluatorDecisionOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorDecisionOutput) ToStringPtrOutputWithContext

func (o EvaluatorDecisionOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EvaluatorDecisionPtrInput

type EvaluatorDecisionPtrInput interface {
	pulumi.Input

	ToEvaluatorDecisionPtrOutput() EvaluatorDecisionPtrOutput
	ToEvaluatorDecisionPtrOutputWithContext(context.Context) EvaluatorDecisionPtrOutput
}

func EvaluatorDecisionPtr

func EvaluatorDecisionPtr(v string) EvaluatorDecisionPtrInput

type EvaluatorDecisionPtrOutput

type EvaluatorDecisionPtrOutput struct{ *pulumi.OutputState }

func (EvaluatorDecisionPtrOutput) Elem

func (EvaluatorDecisionPtrOutput) ElementType

func (EvaluatorDecisionPtrOutput) ElementType() reflect.Type

func (EvaluatorDecisionPtrOutput) ToEvaluatorDecisionPtrOutput

func (o EvaluatorDecisionPtrOutput) ToEvaluatorDecisionPtrOutput() EvaluatorDecisionPtrOutput

func (EvaluatorDecisionPtrOutput) ToEvaluatorDecisionPtrOutputWithContext

func (o EvaluatorDecisionPtrOutput) ToEvaluatorDecisionPtrOutputWithContext(ctx context.Context) EvaluatorDecisionPtrOutput

func (EvaluatorDecisionPtrOutput) ToStringPtrOutput

func (o EvaluatorDecisionPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorDecisionPtrOutput) ToStringPtrOutputWithContext

func (o EvaluatorDecisionPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EvaluatorFallback

type EvaluatorFallback string

func (EvaluatorFallback) ElementType

func (EvaluatorFallback) ElementType() reflect.Type

func (EvaluatorFallback) ToEvaluatorFallbackOutput

func (e EvaluatorFallback) ToEvaluatorFallbackOutput() EvaluatorFallbackOutput

func (EvaluatorFallback) ToEvaluatorFallbackOutputWithContext

func (e EvaluatorFallback) ToEvaluatorFallbackOutputWithContext(ctx context.Context) EvaluatorFallbackOutput

func (EvaluatorFallback) ToEvaluatorFallbackPtrOutput

func (e EvaluatorFallback) ToEvaluatorFallbackPtrOutput() EvaluatorFallbackPtrOutput

func (EvaluatorFallback) ToEvaluatorFallbackPtrOutputWithContext

func (e EvaluatorFallback) ToEvaluatorFallbackPtrOutputWithContext(ctx context.Context) EvaluatorFallbackPtrOutput

func (EvaluatorFallback) ToStringOutput

func (e EvaluatorFallback) ToStringOutput() pulumi.StringOutput

func (EvaluatorFallback) ToStringOutputWithContext

func (e EvaluatorFallback) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (EvaluatorFallback) ToStringPtrOutput

func (e EvaluatorFallback) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorFallback) ToStringPtrOutputWithContext

func (e EvaluatorFallback) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EvaluatorFallbackInput

type EvaluatorFallbackInput interface {
	pulumi.Input

	ToEvaluatorFallbackOutput() EvaluatorFallbackOutput
	ToEvaluatorFallbackOutputWithContext(context.Context) EvaluatorFallbackOutput
}

EvaluatorFallbackInput is an input type that accepts values of the EvaluatorFallback enum A concrete instance of `EvaluatorFallbackInput` can be one of the following:

EvaluatorFallbackAsk
EvaluatorFallbackDeny

type EvaluatorFallbackOutput

type EvaluatorFallbackOutput struct{ *pulumi.OutputState }

func (EvaluatorFallbackOutput) ElementType

func (EvaluatorFallbackOutput) ElementType() reflect.Type

func (EvaluatorFallbackOutput) ToEvaluatorFallbackOutput

func (o EvaluatorFallbackOutput) ToEvaluatorFallbackOutput() EvaluatorFallbackOutput

func (EvaluatorFallbackOutput) ToEvaluatorFallbackOutputWithContext

func (o EvaluatorFallbackOutput) ToEvaluatorFallbackOutputWithContext(ctx context.Context) EvaluatorFallbackOutput

func (EvaluatorFallbackOutput) ToEvaluatorFallbackPtrOutput

func (o EvaluatorFallbackOutput) ToEvaluatorFallbackPtrOutput() EvaluatorFallbackPtrOutput

func (EvaluatorFallbackOutput) ToEvaluatorFallbackPtrOutputWithContext

func (o EvaluatorFallbackOutput) ToEvaluatorFallbackPtrOutputWithContext(ctx context.Context) EvaluatorFallbackPtrOutput

func (EvaluatorFallbackOutput) ToStringOutput

func (o EvaluatorFallbackOutput) ToStringOutput() pulumi.StringOutput

func (EvaluatorFallbackOutput) ToStringOutputWithContext

func (o EvaluatorFallbackOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (EvaluatorFallbackOutput) ToStringPtrOutput

func (o EvaluatorFallbackOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorFallbackOutput) ToStringPtrOutputWithContext

func (o EvaluatorFallbackOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EvaluatorFallbackPtrInput

type EvaluatorFallbackPtrInput interface {
	pulumi.Input

	ToEvaluatorFallbackPtrOutput() EvaluatorFallbackPtrOutput
	ToEvaluatorFallbackPtrOutputWithContext(context.Context) EvaluatorFallbackPtrOutput
}

func EvaluatorFallbackPtr

func EvaluatorFallbackPtr(v string) EvaluatorFallbackPtrInput

type EvaluatorFallbackPtrOutput

type EvaluatorFallbackPtrOutput struct{ *pulumi.OutputState }

func (EvaluatorFallbackPtrOutput) Elem

func (EvaluatorFallbackPtrOutput) ElementType

func (EvaluatorFallbackPtrOutput) ElementType() reflect.Type

func (EvaluatorFallbackPtrOutput) ToEvaluatorFallbackPtrOutput

func (o EvaluatorFallbackPtrOutput) ToEvaluatorFallbackPtrOutput() EvaluatorFallbackPtrOutput

func (EvaluatorFallbackPtrOutput) ToEvaluatorFallbackPtrOutputWithContext

func (o EvaluatorFallbackPtrOutput) ToEvaluatorFallbackPtrOutputWithContext(ctx context.Context) EvaluatorFallbackPtrOutput

func (EvaluatorFallbackPtrOutput) ToStringPtrOutput

func (o EvaluatorFallbackPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorFallbackPtrOutput) ToStringPtrOutputWithContext

func (o EvaluatorFallbackPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EvaluatorInput

type EvaluatorInput interface {
	pulumi.Input

	ToEvaluatorOutput() EvaluatorOutput
	ToEvaluatorOutputWithContext(context.Context) EvaluatorOutput
}

EvaluatorInput is an input type that accepts EvaluatorArgs and EvaluatorOutput values. You can construct a concrete instance of `EvaluatorInput` via:

EvaluatorArgs{...}

type EvaluatorMap

type EvaluatorMap map[string]EvaluatorInput

func (EvaluatorMap) ElementType

func (EvaluatorMap) ElementType() reflect.Type

func (EvaluatorMap) ToEvaluatorMapOutput

func (i EvaluatorMap) ToEvaluatorMapOutput() EvaluatorMapOutput

func (EvaluatorMap) ToEvaluatorMapOutputWithContext

func (i EvaluatorMap) ToEvaluatorMapOutputWithContext(ctx context.Context) EvaluatorMapOutput

type EvaluatorMapInput

type EvaluatorMapInput interface {
	pulumi.Input

	ToEvaluatorMapOutput() EvaluatorMapOutput
	ToEvaluatorMapOutputWithContext(context.Context) EvaluatorMapOutput
}

EvaluatorMapInput is an input type that accepts EvaluatorMap and EvaluatorMapOutput values. You can construct a concrete instance of `EvaluatorMapInput` via:

EvaluatorMap{ "key": EvaluatorArgs{...} }

type EvaluatorMapOutput

type EvaluatorMapOutput struct{ *pulumi.OutputState }

func (EvaluatorMapOutput) ElementType

func (EvaluatorMapOutput) ElementType() reflect.Type

func (EvaluatorMapOutput) MapIndex

func (EvaluatorMapOutput) ToEvaluatorMapOutput

func (o EvaluatorMapOutput) ToEvaluatorMapOutput() EvaluatorMapOutput

func (EvaluatorMapOutput) ToEvaluatorMapOutputWithContext

func (o EvaluatorMapOutput) ToEvaluatorMapOutputWithContext(ctx context.Context) EvaluatorMapOutput

type EvaluatorOutput

type EvaluatorOutput struct{ *pulumi.OutputState }

The `EvaluatorConfig` object of a docker-agent configuration.

func (EvaluatorOutput) BaseUrl

API base URL. TypeSafe defaults to https://api.typesafe.ai with /v1/systemone; OpenAI defaults to https://api.openai.com/v1 with /decisions.

func (EvaluatorOutput) BypassModelsGateway

func (o EvaluatorOutput) BypassModelsGateway() pulumi.BoolPtrOutput

Connect directly even when a models gateway is configured. Custom base_url and endpoint do not implicitly bypass the gateway.

func (EvaluatorOutput) Choices

For `type: choice`: the possible outcomes, keyed by name, with a description of when each applies (2 to 255).

func (EvaluatorOutput) Cost

func (o EvaluatorOutput) Cost() CostPtrOutput

Explicit USD pricing per one million evaluator input/output tokens. Overrides built-in evaluator pricing, including on custom endpoints. An empty object declares free evaluations; cache rates are unused.

func (EvaluatorOutput) ElementType

func (EvaluatorOutput) ElementType() reflect.Type

func (EvaluatorOutput) Endpoint

func (o EvaluatorOutput) Endpoint() pulumi.StringPtrOutput

Exact HTTP(S) evaluator URL, overriding base_url and its default path. No credentials, query, or fragment.

func (EvaluatorOutput) Extra

func (o EvaluatorOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (EvaluatorOutput) Instructions

func (o EvaluatorOutput) Instructions() pulumi.StringOutput

The instructions the evaluator assesses the input with.

func (EvaluatorOutput) Levels

For `type: score`: the ordered score levels.

func (EvaluatorOutput) Model

The evaluator model of the provider.

func (EvaluatorOutput) Provider

func (o EvaluatorOutput) Provider() pulumi.StringOutput

Evaluator backend (typesafe or openai Decisions), or a named provider.

func (EvaluatorOutput) Timeout

Timeout for one evaluator call, as a duration such as `30s` or `2m` (a number of seconds `N` is written as `Ns`).

func (EvaluatorOutput) ToEvaluatorOutput

func (o EvaluatorOutput) ToEvaluatorOutput() EvaluatorOutput

func (EvaluatorOutput) ToEvaluatorOutputWithContext

func (o EvaluatorOutput) ToEvaluatorOutputWithContext(ctx context.Context) EvaluatorOutput

func (EvaluatorOutput) TokenKey

func (o EvaluatorOutput) TokenKey() pulumi.StringPtrOutput

API key environment variable for direct calls (TYPESAFE_API_KEY or OPENAI_API_KEY). Never put the secret itself in the configuration.

func (EvaluatorOutput) Type

The kind of assessment: a yes/no decision, one of `choices`, or one of the score `levels`.

type EvaluatorPolicy

type EvaluatorPolicy struct {
	// Choice keys (or true/false for booleans) mapped to guard decisions.
	Decisions map[string]EvaluatorDecision `pulumi:"decisions"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Decision for uncertainty or unmapped outcomes; provider failures always block.
	Fallback EvaluatorFallback `pulumi:"fallback"`
	// Minimum selected-outcome probability to apply its mapping; not the confidence metric.
	MinProbability float64 `pulumi:"minProbability"`
}

Maps an evaluator's decisions to tool approval outcomes (`allow`, `ask`, `deny`) for `tool_guard` hooks.

type EvaluatorPolicyArgs

type EvaluatorPolicyArgs struct {
	// Choice keys (or true/false for booleans) mapped to guard decisions.
	Decisions EvaluatorDecisionMapInput `pulumi:"decisions"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Decision for uncertainty or unmapped outcomes; provider failures always block.
	Fallback EvaluatorFallbackInput `pulumi:"fallback"`
	// Minimum selected-outcome probability to apply its mapping; not the confidence metric.
	MinProbability pulumi.Float64Input `pulumi:"minProbability"`
}

Maps an evaluator's decisions to tool approval outcomes (`allow`, `ask`, `deny`) for `tool_guard` hooks.

func (EvaluatorPolicyArgs) ElementType

func (EvaluatorPolicyArgs) ElementType() reflect.Type

func (EvaluatorPolicyArgs) ToEvaluatorPolicyOutput

func (i EvaluatorPolicyArgs) ToEvaluatorPolicyOutput() EvaluatorPolicyOutput

func (EvaluatorPolicyArgs) ToEvaluatorPolicyOutputWithContext

func (i EvaluatorPolicyArgs) ToEvaluatorPolicyOutputWithContext(ctx context.Context) EvaluatorPolicyOutput

func (EvaluatorPolicyArgs) ToEvaluatorPolicyPtrOutput

func (i EvaluatorPolicyArgs) ToEvaluatorPolicyPtrOutput() EvaluatorPolicyPtrOutput

func (EvaluatorPolicyArgs) ToEvaluatorPolicyPtrOutputWithContext

func (i EvaluatorPolicyArgs) ToEvaluatorPolicyPtrOutputWithContext(ctx context.Context) EvaluatorPolicyPtrOutput

type EvaluatorPolicyInput

type EvaluatorPolicyInput interface {
	pulumi.Input

	ToEvaluatorPolicyOutput() EvaluatorPolicyOutput
	ToEvaluatorPolicyOutputWithContext(context.Context) EvaluatorPolicyOutput
}

EvaluatorPolicyInput is an input type that accepts EvaluatorPolicyArgs and EvaluatorPolicyOutput values. You can construct a concrete instance of `EvaluatorPolicyInput` via:

EvaluatorPolicyArgs{...}

type EvaluatorPolicyOutput

type EvaluatorPolicyOutput struct{ *pulumi.OutputState }

Maps an evaluator's decisions to tool approval outcomes (`allow`, `ask`, `deny`) for `tool_guard` hooks.

func (EvaluatorPolicyOutput) Decisions

Choice keys (or true/false for booleans) mapped to guard decisions.

func (EvaluatorPolicyOutput) ElementType

func (EvaluatorPolicyOutput) ElementType() reflect.Type

func (EvaluatorPolicyOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (EvaluatorPolicyOutput) Fallback

Decision for uncertainty or unmapped outcomes; provider failures always block.

func (EvaluatorPolicyOutput) MinProbability

func (o EvaluatorPolicyOutput) MinProbability() pulumi.Float64Output

Minimum selected-outcome probability to apply its mapping; not the confidence metric.

func (EvaluatorPolicyOutput) ToEvaluatorPolicyOutput

func (o EvaluatorPolicyOutput) ToEvaluatorPolicyOutput() EvaluatorPolicyOutput

func (EvaluatorPolicyOutput) ToEvaluatorPolicyOutputWithContext

func (o EvaluatorPolicyOutput) ToEvaluatorPolicyOutputWithContext(ctx context.Context) EvaluatorPolicyOutput

func (EvaluatorPolicyOutput) ToEvaluatorPolicyPtrOutput

func (o EvaluatorPolicyOutput) ToEvaluatorPolicyPtrOutput() EvaluatorPolicyPtrOutput

func (EvaluatorPolicyOutput) ToEvaluatorPolicyPtrOutputWithContext

func (o EvaluatorPolicyOutput) ToEvaluatorPolicyPtrOutputWithContext(ctx context.Context) EvaluatorPolicyPtrOutput

type EvaluatorPolicyPtrInput

type EvaluatorPolicyPtrInput interface {
	pulumi.Input

	ToEvaluatorPolicyPtrOutput() EvaluatorPolicyPtrOutput
	ToEvaluatorPolicyPtrOutputWithContext(context.Context) EvaluatorPolicyPtrOutput
}

EvaluatorPolicyPtrInput is an input type that accepts EvaluatorPolicyArgs, EvaluatorPolicyPtr and EvaluatorPolicyPtrOutput values. You can construct a concrete instance of `EvaluatorPolicyPtrInput` via:

        EvaluatorPolicyArgs{...}

or:

        nil

type EvaluatorPolicyPtrOutput

type EvaluatorPolicyPtrOutput struct{ *pulumi.OutputState }

func (EvaluatorPolicyPtrOutput) Decisions

Choice keys (or true/false for booleans) mapped to guard decisions.

func (EvaluatorPolicyPtrOutput) Elem

func (EvaluatorPolicyPtrOutput) ElementType

func (EvaluatorPolicyPtrOutput) ElementType() reflect.Type

func (EvaluatorPolicyPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (EvaluatorPolicyPtrOutput) Fallback

Decision for uncertainty or unmapped outcomes; provider failures always block.

func (EvaluatorPolicyPtrOutput) MinProbability

Minimum selected-outcome probability to apply its mapping; not the confidence metric.

func (EvaluatorPolicyPtrOutput) ToEvaluatorPolicyPtrOutput

func (o EvaluatorPolicyPtrOutput) ToEvaluatorPolicyPtrOutput() EvaluatorPolicyPtrOutput

func (EvaluatorPolicyPtrOutput) ToEvaluatorPolicyPtrOutputWithContext

func (o EvaluatorPolicyPtrOutput) ToEvaluatorPolicyPtrOutputWithContext(ctx context.Context) EvaluatorPolicyPtrOutput

type EvaluatorType

type EvaluatorType string

func (EvaluatorType) ElementType

func (EvaluatorType) ElementType() reflect.Type

func (EvaluatorType) ToEvaluatorTypeOutput

func (e EvaluatorType) ToEvaluatorTypeOutput() EvaluatorTypeOutput

func (EvaluatorType) ToEvaluatorTypeOutputWithContext

func (e EvaluatorType) ToEvaluatorTypeOutputWithContext(ctx context.Context) EvaluatorTypeOutput

func (EvaluatorType) ToEvaluatorTypePtrOutput

func (e EvaluatorType) ToEvaluatorTypePtrOutput() EvaluatorTypePtrOutput

func (EvaluatorType) ToEvaluatorTypePtrOutputWithContext

func (e EvaluatorType) ToEvaluatorTypePtrOutputWithContext(ctx context.Context) EvaluatorTypePtrOutput

func (EvaluatorType) ToStringOutput

func (e EvaluatorType) ToStringOutput() pulumi.StringOutput

func (EvaluatorType) ToStringOutputWithContext

func (e EvaluatorType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (EvaluatorType) ToStringPtrOutput

func (e EvaluatorType) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorType) ToStringPtrOutputWithContext

func (e EvaluatorType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EvaluatorTypeInput

type EvaluatorTypeInput interface {
	pulumi.Input

	ToEvaluatorTypeOutput() EvaluatorTypeOutput
	ToEvaluatorTypeOutputWithContext(context.Context) EvaluatorTypeOutput
}

EvaluatorTypeInput is an input type that accepts values of the EvaluatorType enum A concrete instance of `EvaluatorTypeInput` can be one of the following:

EvaluatorTypeBoolean
EvaluatorTypeChoice
EvaluatorTypeScore

type EvaluatorTypeOutput

type EvaluatorTypeOutput struct{ *pulumi.OutputState }

func (EvaluatorTypeOutput) ElementType

func (EvaluatorTypeOutput) ElementType() reflect.Type

func (EvaluatorTypeOutput) ToEvaluatorTypeOutput

func (o EvaluatorTypeOutput) ToEvaluatorTypeOutput() EvaluatorTypeOutput

func (EvaluatorTypeOutput) ToEvaluatorTypeOutputWithContext

func (o EvaluatorTypeOutput) ToEvaluatorTypeOutputWithContext(ctx context.Context) EvaluatorTypeOutput

func (EvaluatorTypeOutput) ToEvaluatorTypePtrOutput

func (o EvaluatorTypeOutput) ToEvaluatorTypePtrOutput() EvaluatorTypePtrOutput

func (EvaluatorTypeOutput) ToEvaluatorTypePtrOutputWithContext

func (o EvaluatorTypeOutput) ToEvaluatorTypePtrOutputWithContext(ctx context.Context) EvaluatorTypePtrOutput

func (EvaluatorTypeOutput) ToStringOutput

func (o EvaluatorTypeOutput) ToStringOutput() pulumi.StringOutput

func (EvaluatorTypeOutput) ToStringOutputWithContext

func (o EvaluatorTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (EvaluatorTypeOutput) ToStringPtrOutput

func (o EvaluatorTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorTypeOutput) ToStringPtrOutputWithContext

func (o EvaluatorTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type EvaluatorTypePtrInput

type EvaluatorTypePtrInput interface {
	pulumi.Input

	ToEvaluatorTypePtrOutput() EvaluatorTypePtrOutput
	ToEvaluatorTypePtrOutputWithContext(context.Context) EvaluatorTypePtrOutput
}

func EvaluatorTypePtr

func EvaluatorTypePtr(v string) EvaluatorTypePtrInput

type EvaluatorTypePtrOutput

type EvaluatorTypePtrOutput struct{ *pulumi.OutputState }

func (EvaluatorTypePtrOutput) Elem

func (EvaluatorTypePtrOutput) ElementType

func (EvaluatorTypePtrOutput) ElementType() reflect.Type

func (EvaluatorTypePtrOutput) ToEvaluatorTypePtrOutput

func (o EvaluatorTypePtrOutput) ToEvaluatorTypePtrOutput() EvaluatorTypePtrOutput

func (EvaluatorTypePtrOutput) ToEvaluatorTypePtrOutputWithContext

func (o EvaluatorTypePtrOutput) ToEvaluatorTypePtrOutputWithContext(ctx context.Context) EvaluatorTypePtrOutput

func (EvaluatorTypePtrOutput) ToStringPtrOutput

func (o EvaluatorTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (EvaluatorTypePtrOutput) ToStringPtrOutputWithContext

func (o EvaluatorTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Fallback

type Fallback struct {
	// Duration to stick with a successful fallback model before retrying the primary. Only applies after a non-retryable error (e.g., 429 rate limit). Use Go duration format (e.g., '1m', '30s', '2m30s'). Default is '1m'.
	Cooldown *string `pulumi:"cooldown"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// List of fallback models to try in order if the primary model fails. Each entry can be a model name from the models section or an inline provider/model format (e.g., 'openai/gpt-4o').
	Models []string `pulumi:"models"`
	// Number of retries per model with exponential backoff for retryable errors (5xx, timeouts). Use 0 or omit for default (2 retries = 3 total attempts per model). Use -1 to disable retries entirely (try each model only once).
	Retries *int `pulumi:"retries"`
}

Configuration for fallback model behavior when the primary model fails

type FallbackArgs

type FallbackArgs struct {
	// Duration to stick with a successful fallback model before retrying the primary. Only applies after a non-retryable error (e.g., 429 rate limit). Use Go duration format (e.g., '1m', '30s', '2m30s'). Default is '1m'.
	Cooldown pulumi.StringPtrInput `pulumi:"cooldown"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// List of fallback models to try in order if the primary model fails. Each entry can be a model name from the models section or an inline provider/model format (e.g., 'openai/gpt-4o').
	Models pulumi.StringArrayInput `pulumi:"models"`
	// Number of retries per model with exponential backoff for retryable errors (5xx, timeouts). Use 0 or omit for default (2 retries = 3 total attempts per model). Use -1 to disable retries entirely (try each model only once).
	Retries pulumi.IntPtrInput `pulumi:"retries"`
}

Configuration for fallback model behavior when the primary model fails

func (FallbackArgs) ElementType

func (FallbackArgs) ElementType() reflect.Type

func (FallbackArgs) ToFallbackOutput

func (i FallbackArgs) ToFallbackOutput() FallbackOutput

func (FallbackArgs) ToFallbackOutputWithContext

func (i FallbackArgs) ToFallbackOutputWithContext(ctx context.Context) FallbackOutput

func (FallbackArgs) ToFallbackPtrOutput

func (i FallbackArgs) ToFallbackPtrOutput() FallbackPtrOutput

func (FallbackArgs) ToFallbackPtrOutputWithContext

func (i FallbackArgs) ToFallbackPtrOutputWithContext(ctx context.Context) FallbackPtrOutput

type FallbackInput

type FallbackInput interface {
	pulumi.Input

	ToFallbackOutput() FallbackOutput
	ToFallbackOutputWithContext(context.Context) FallbackOutput
}

FallbackInput is an input type that accepts FallbackArgs and FallbackOutput values. You can construct a concrete instance of `FallbackInput` via:

FallbackArgs{...}

type FallbackOutput

type FallbackOutput struct{ *pulumi.OutputState }

Configuration for fallback model behavior when the primary model fails

func (FallbackOutput) Cooldown

func (o FallbackOutput) Cooldown() pulumi.StringPtrOutput

Duration to stick with a successful fallback model before retrying the primary. Only applies after a non-retryable error (e.g., 429 rate limit). Use Go duration format (e.g., '1m', '30s', '2m30s'). Default is '1m'.

func (FallbackOutput) ElementType

func (FallbackOutput) ElementType() reflect.Type

func (FallbackOutput) Extra

func (o FallbackOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (FallbackOutput) Models

List of fallback models to try in order if the primary model fails. Each entry can be a model name from the models section or an inline provider/model format (e.g., 'openai/gpt-4o').

func (FallbackOutput) Retries

func (o FallbackOutput) Retries() pulumi.IntPtrOutput

Number of retries per model with exponential backoff for retryable errors (5xx, timeouts). Use 0 or omit for default (2 retries = 3 total attempts per model). Use -1 to disable retries entirely (try each model only once).

func (FallbackOutput) ToFallbackOutput

func (o FallbackOutput) ToFallbackOutput() FallbackOutput

func (FallbackOutput) ToFallbackOutputWithContext

func (o FallbackOutput) ToFallbackOutputWithContext(ctx context.Context) FallbackOutput

func (FallbackOutput) ToFallbackPtrOutput

func (o FallbackOutput) ToFallbackPtrOutput() FallbackPtrOutput

func (FallbackOutput) ToFallbackPtrOutputWithContext

func (o FallbackOutput) ToFallbackPtrOutputWithContext(ctx context.Context) FallbackPtrOutput

type FallbackPtrInput

type FallbackPtrInput interface {
	pulumi.Input

	ToFallbackPtrOutput() FallbackPtrOutput
	ToFallbackPtrOutputWithContext(context.Context) FallbackPtrOutput
}

FallbackPtrInput is an input type that accepts FallbackArgs, FallbackPtr and FallbackPtrOutput values. You can construct a concrete instance of `FallbackPtrInput` via:

        FallbackArgs{...}

or:

        nil

func FallbackPtr

func FallbackPtr(v *FallbackArgs) FallbackPtrInput

type FallbackPtrOutput

type FallbackPtrOutput struct{ *pulumi.OutputState }

func (FallbackPtrOutput) Cooldown

Duration to stick with a successful fallback model before retrying the primary. Only applies after a non-retryable error (e.g., 429 rate limit). Use Go duration format (e.g., '1m', '30s', '2m30s'). Default is '1m'.

func (FallbackPtrOutput) Elem

func (FallbackPtrOutput) ElementType

func (FallbackPtrOutput) ElementType() reflect.Type

func (FallbackPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (FallbackPtrOutput) Models

List of fallback models to try in order if the primary model fails. Each entry can be a model name from the models section or an inline provider/model format (e.g., 'openai/gpt-4o').

func (FallbackPtrOutput) Retries

Number of retries per model with exponential backoff for retryable errors (5xx, timeouts). Use 0 or omit for default (2 retries = 3 total attempts per model). Use -1 to disable retries entirely (try each model only once).

func (FallbackPtrOutput) ToFallbackPtrOutput

func (o FallbackPtrOutput) ToFallbackPtrOutput() FallbackPtrOutput

func (FallbackPtrOutput) ToFallbackPtrOutputWithContext

func (o FallbackPtrOutput) ToFallbackPtrOutputWithContext(ctx context.Context) FallbackPtrOutput

type GetAgentArgs

type GetAgentArgs struct {
	// Allow a plain-HTTP or self-signed registry. Without it, plain HTTP is only used as a fallback when HTTPS fails for `localhost`, `*.localhost`, loopback and private (RFC 1918) addresses, the same as the `docker agent` CLI.
	Insecure *bool `pulumi:"insecure"`
	// The artifact to read: `registry/repository:tag` (the tag defaults to `latest`) or `registry/repository@sha256:...`.
	Reference string `pulumi:"reference"`
}

type GetAgentOutputArgs

type GetAgentOutputArgs struct {
	// Allow a plain-HTTP or self-signed registry. Without it, plain HTTP is only used as a fallback when HTTPS fails for `localhost`, `*.localhost`, loopback and private (RFC 1918) addresses, the same as the `docker agent` CLI.
	Insecure pulumi.BoolPtrInput `pulumi:"insecure"`
	// The artifact to read: `registry/repository:tag` (the tag defaults to `latest`) or `registry/repository@sha256:...`.
	Reference pulumi.StringInput `pulumi:"reference"`
}

func (GetAgentOutputArgs) ElementType

func (GetAgentOutputArgs) ElementType() reflect.Type

type GetAgentResult

type GetAgentResult struct {
	// The agent names, in order.
	AgentNames []string `pulumi:"agentNames"`
	// The manifest annotations.
	Annotations map[string]string `pulumi:"annotations"`
	// The agent docker-agent starts by default: `root` if an agent has that name, else the first agent.
	DefaultAgent string `pulumi:"defaultAgent"`
	// The manifest digest (`sha256:...`).
	Digest string `pulumi:"digest"`
	// The `metadata` block of the configuration. Fields missing from the YAML are filled from the matching manifest annotations.
	Metadata Metadata `pulumi:"metadata"`
	// The artifact pinned by digest, `registry/repository@sha256:...`.
	PinnedReference string `pulumi:"pinnedReference"`
	// The agent configuration, exactly as stored in the artifact.
	Yaml string `pulumi:"yaml"`
}

func GetAgent

func GetAgent(ctx *pulumi.Context, args *GetAgentArgs, opts ...pulumi.InvokeOption) (*GetAgentResult, error)

Reads a Docker Agent configuration from an OCI registry, like `docker agent share pull`, without writing anything to disk.

The reference can be a tag or a digest. When the provider's `registryAuth` has credentials for the registry, they are used right away. Otherwise the function first tries anonymous access and retries with the Docker credential store when the registry answers 401, 403, 404 or 429. It accepts artifacts pushed by `docker agent share push` and by `AgentArtifact`, and rejects manifests without the `io.docker.agent.version` annotation.

## Example Usage ### Read a shared agent ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Reads the artifact like `docker agent share pull`, without writing a file.
		agent := dockeragent.GetAgentOutput(ctx, dockeragent.GetAgentOutputArgs{
			Reference: pulumi.String("docker.io/my-org/assistant:latest"),
		}, nil)
		ctx.Export("agentYaml", agent.Yaml())
		ctx.Export("agentNames", agent.AgentNames())
		ctx.Export("pinnedReference", agent.PinnedReference())
		return nil
	})
}

``` ### Read back an agent pushed by the same program ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		assistant, err := dockeragent.NewAgentConfig(ctx, "assistant", &dockeragent.AgentConfigArgs{
			Metadata: &dockeragent.MetadataArgs{
				Author:  pulumi.String("platform-team"),
				Version: pulumi.String("1.0.0"),
			},
			Agents: dockeragent.AgentArray{
				&dockeragent.AgentArgs{
					Name:        pulumi.String("root"),
					Model:       pulumi.String("openai/gpt-5-mini"),
					Instruction: pulumi.String("You are a helpful assistant. Answer briefly."),
				},
			},
		})
		if err != nil {
			return err
		}
		artifact, err := dockeragent.NewAgentArtifact(ctx, "artifact", &dockeragent.AgentArtifactArgs{
			Reference: pulumi.String("localhost:5000/agents/assistant:v1"),
			Yaml:      assistant.Yaml,
		})
		if err != nil {
			return err
		}

		// Reads the pushed artifact by digest once the push is done.
		pulled := dockeragent.GetAgentOutput(ctx, dockeragent.GetAgentOutputArgs{
			Reference: artifact.PinnedReference,
		}, nil)
		ctx.Export("digest", pulled.Digest())
		ctx.Export("defaultAgent", pulled.DefaultAgent())
		ctx.Export("annotations", pulled.Annotations())
		return nil
	})
}

```

type GetAgentResultOutput

type GetAgentResultOutput struct{ *pulumi.OutputState }

func (GetAgentResultOutput) AgentNames

The agent names, in order.

func (GetAgentResultOutput) Annotations

The manifest annotations.

func (GetAgentResultOutput) DefaultAgent

func (o GetAgentResultOutput) DefaultAgent() pulumi.StringOutput

The agent docker-agent starts by default: `root` if an agent has that name, else the first agent.

func (GetAgentResultOutput) Digest

The manifest digest (`sha256:...`).

func (GetAgentResultOutput) ElementType

func (GetAgentResultOutput) ElementType() reflect.Type

func (GetAgentResultOutput) Metadata

func (o GetAgentResultOutput) Metadata() MetadataOutput

The `metadata` block of the configuration. Fields missing from the YAML are filled from the matching manifest annotations.

func (GetAgentResultOutput) PinnedReference

func (o GetAgentResultOutput) PinnedReference() pulumi.StringOutput

The artifact pinned by digest, `registry/repository@sha256:...`.

func (GetAgentResultOutput) ToGetAgentResultOutput

func (o GetAgentResultOutput) ToGetAgentResultOutput() GetAgentResultOutput

func (GetAgentResultOutput) ToGetAgentResultOutputWithContext

func (o GetAgentResultOutput) ToGetAgentResultOutputWithContext(ctx context.Context) GetAgentResultOutput

func (GetAgentResultOutput) Yaml

The agent configuration, exactly as stored in the artifact.

type Harness

type Harness struct {
	// opencode agent name forwarded as --agent
	Agent *string `pulumi:"agent"`
	// Claude Code effort level forwarded as --effort.
	Effort *HarnessEffort `pulumi:"effort"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Optional model name passed to the external harness. When omitted, the external CLI uses its own default model.
	Model *string `pulumi:"model"`
	// Enable opencode thinking output
	Thinking *bool `pulumi:"thinking"`
	// External coding harness provider to use.
	Type HarnessType `pulumi:"type"`
}

Configuration for running an agent through an external coding-agent CLI via github.com/rumpl/harness

type HarnessArgs

type HarnessArgs struct {
	// opencode agent name forwarded as --agent
	Agent pulumi.StringPtrInput `pulumi:"agent"`
	// Claude Code effort level forwarded as --effort.
	Effort HarnessEffortPtrInput `pulumi:"effort"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Optional model name passed to the external harness. When omitted, the external CLI uses its own default model.
	Model pulumi.StringPtrInput `pulumi:"model"`
	// Enable opencode thinking output
	Thinking pulumi.BoolPtrInput `pulumi:"thinking"`
	// External coding harness provider to use.
	Type HarnessTypeInput `pulumi:"type"`
}

Configuration for running an agent through an external coding-agent CLI via github.com/rumpl/harness

func (HarnessArgs) ElementType

func (HarnessArgs) ElementType() reflect.Type

func (HarnessArgs) ToHarnessOutput

func (i HarnessArgs) ToHarnessOutput() HarnessOutput

func (HarnessArgs) ToHarnessOutputWithContext

func (i HarnessArgs) ToHarnessOutputWithContext(ctx context.Context) HarnessOutput

func (HarnessArgs) ToHarnessPtrOutput

func (i HarnessArgs) ToHarnessPtrOutput() HarnessPtrOutput

func (HarnessArgs) ToHarnessPtrOutputWithContext

func (i HarnessArgs) ToHarnessPtrOutputWithContext(ctx context.Context) HarnessPtrOutput

type HarnessEffort

type HarnessEffort string

func (HarnessEffort) ElementType

func (HarnessEffort) ElementType() reflect.Type

func (HarnessEffort) ToHarnessEffortOutput

func (e HarnessEffort) ToHarnessEffortOutput() HarnessEffortOutput

func (HarnessEffort) ToHarnessEffortOutputWithContext

func (e HarnessEffort) ToHarnessEffortOutputWithContext(ctx context.Context) HarnessEffortOutput

func (HarnessEffort) ToHarnessEffortPtrOutput

func (e HarnessEffort) ToHarnessEffortPtrOutput() HarnessEffortPtrOutput

func (HarnessEffort) ToHarnessEffortPtrOutputWithContext

func (e HarnessEffort) ToHarnessEffortPtrOutputWithContext(ctx context.Context) HarnessEffortPtrOutput

func (HarnessEffort) ToStringOutput

func (e HarnessEffort) ToStringOutput() pulumi.StringOutput

func (HarnessEffort) ToStringOutputWithContext

func (e HarnessEffort) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HarnessEffort) ToStringPtrOutput

func (e HarnessEffort) ToStringPtrOutput() pulumi.StringPtrOutput

func (HarnessEffort) ToStringPtrOutputWithContext

func (e HarnessEffort) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HarnessEffortInput

type HarnessEffortInput interface {
	pulumi.Input

	ToHarnessEffortOutput() HarnessEffortOutput
	ToHarnessEffortOutputWithContext(context.Context) HarnessEffortOutput
}

HarnessEffortInput is an input type that accepts values of the HarnessEffort enum A concrete instance of `HarnessEffortInput` can be one of the following:

HarnessEffortLow
HarnessEffortMedium
HarnessEffortHigh
HarnessEffortXHigh
HarnessEffortMax

type HarnessEffortOutput

type HarnessEffortOutput struct{ *pulumi.OutputState }

func (HarnessEffortOutput) ElementType

func (HarnessEffortOutput) ElementType() reflect.Type

func (HarnessEffortOutput) ToHarnessEffortOutput

func (o HarnessEffortOutput) ToHarnessEffortOutput() HarnessEffortOutput

func (HarnessEffortOutput) ToHarnessEffortOutputWithContext

func (o HarnessEffortOutput) ToHarnessEffortOutputWithContext(ctx context.Context) HarnessEffortOutput

func (HarnessEffortOutput) ToHarnessEffortPtrOutput

func (o HarnessEffortOutput) ToHarnessEffortPtrOutput() HarnessEffortPtrOutput

func (HarnessEffortOutput) ToHarnessEffortPtrOutputWithContext

func (o HarnessEffortOutput) ToHarnessEffortPtrOutputWithContext(ctx context.Context) HarnessEffortPtrOutput

func (HarnessEffortOutput) ToStringOutput

func (o HarnessEffortOutput) ToStringOutput() pulumi.StringOutput

func (HarnessEffortOutput) ToStringOutputWithContext

func (o HarnessEffortOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HarnessEffortOutput) ToStringPtrOutput

func (o HarnessEffortOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HarnessEffortOutput) ToStringPtrOutputWithContext

func (o HarnessEffortOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HarnessEffortPtrInput

type HarnessEffortPtrInput interface {
	pulumi.Input

	ToHarnessEffortPtrOutput() HarnessEffortPtrOutput
	ToHarnessEffortPtrOutputWithContext(context.Context) HarnessEffortPtrOutput
}

func HarnessEffortPtr

func HarnessEffortPtr(v string) HarnessEffortPtrInput

type HarnessEffortPtrOutput

type HarnessEffortPtrOutput struct{ *pulumi.OutputState }

func (HarnessEffortPtrOutput) Elem

func (HarnessEffortPtrOutput) ElementType

func (HarnessEffortPtrOutput) ElementType() reflect.Type

func (HarnessEffortPtrOutput) ToHarnessEffortPtrOutput

func (o HarnessEffortPtrOutput) ToHarnessEffortPtrOutput() HarnessEffortPtrOutput

func (HarnessEffortPtrOutput) ToHarnessEffortPtrOutputWithContext

func (o HarnessEffortPtrOutput) ToHarnessEffortPtrOutputWithContext(ctx context.Context) HarnessEffortPtrOutput

func (HarnessEffortPtrOutput) ToStringPtrOutput

func (o HarnessEffortPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HarnessEffortPtrOutput) ToStringPtrOutputWithContext

func (o HarnessEffortPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HarnessInput

type HarnessInput interface {
	pulumi.Input

	ToHarnessOutput() HarnessOutput
	ToHarnessOutputWithContext(context.Context) HarnessOutput
}

HarnessInput is an input type that accepts HarnessArgs and HarnessOutput values. You can construct a concrete instance of `HarnessInput` via:

HarnessArgs{...}

type HarnessOutput

type HarnessOutput struct{ *pulumi.OutputState }

Configuration for running an agent through an external coding-agent CLI via github.com/rumpl/harness

func (HarnessOutput) Agent

opencode agent name forwarded as --agent

func (HarnessOutput) Effort

Claude Code effort level forwarded as --effort.

func (HarnessOutput) ElementType

func (HarnessOutput) ElementType() reflect.Type

func (HarnessOutput) Extra

func (o HarnessOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (HarnessOutput) Model

Optional model name passed to the external harness. When omitted, the external CLI uses its own default model.

func (HarnessOutput) Thinking

func (o HarnessOutput) Thinking() pulumi.BoolPtrOutput

Enable opencode thinking output

func (HarnessOutput) ToHarnessOutput

func (o HarnessOutput) ToHarnessOutput() HarnessOutput

func (HarnessOutput) ToHarnessOutputWithContext

func (o HarnessOutput) ToHarnessOutputWithContext(ctx context.Context) HarnessOutput

func (HarnessOutput) ToHarnessPtrOutput

func (o HarnessOutput) ToHarnessPtrOutput() HarnessPtrOutput

func (HarnessOutput) ToHarnessPtrOutputWithContext

func (o HarnessOutput) ToHarnessPtrOutputWithContext(ctx context.Context) HarnessPtrOutput

func (HarnessOutput) Type

External coding harness provider to use.

type HarnessPtrInput

type HarnessPtrInput interface {
	pulumi.Input

	ToHarnessPtrOutput() HarnessPtrOutput
	ToHarnessPtrOutputWithContext(context.Context) HarnessPtrOutput
}

HarnessPtrInput is an input type that accepts HarnessArgs, HarnessPtr and HarnessPtrOutput values. You can construct a concrete instance of `HarnessPtrInput` via:

        HarnessArgs{...}

or:

        nil

func HarnessPtr

func HarnessPtr(v *HarnessArgs) HarnessPtrInput

type HarnessPtrOutput

type HarnessPtrOutput struct{ *pulumi.OutputState }

func (HarnessPtrOutput) Agent

opencode agent name forwarded as --agent

func (HarnessPtrOutput) Effort

Claude Code effort level forwarded as --effort.

func (HarnessPtrOutput) Elem

func (HarnessPtrOutput) ElementType

func (HarnessPtrOutput) ElementType() reflect.Type

func (HarnessPtrOutput) Extra

func (o HarnessPtrOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (HarnessPtrOutput) Model

Optional model name passed to the external harness. When omitted, the external CLI uses its own default model.

func (HarnessPtrOutput) Thinking

func (o HarnessPtrOutput) Thinking() pulumi.BoolPtrOutput

Enable opencode thinking output

func (HarnessPtrOutput) ToHarnessPtrOutput

func (o HarnessPtrOutput) ToHarnessPtrOutput() HarnessPtrOutput

func (HarnessPtrOutput) ToHarnessPtrOutputWithContext

func (o HarnessPtrOutput) ToHarnessPtrOutputWithContext(ctx context.Context) HarnessPtrOutput

func (HarnessPtrOutput) Type

External coding harness provider to use.

type HarnessType

type HarnessType string

func (HarnessType) ElementType

func (HarnessType) ElementType() reflect.Type

func (HarnessType) ToHarnessTypeOutput

func (e HarnessType) ToHarnessTypeOutput() HarnessTypeOutput

func (HarnessType) ToHarnessTypeOutputWithContext

func (e HarnessType) ToHarnessTypeOutputWithContext(ctx context.Context) HarnessTypeOutput

func (HarnessType) ToHarnessTypePtrOutput

func (e HarnessType) ToHarnessTypePtrOutput() HarnessTypePtrOutput

func (HarnessType) ToHarnessTypePtrOutputWithContext

func (e HarnessType) ToHarnessTypePtrOutputWithContext(ctx context.Context) HarnessTypePtrOutput

func (HarnessType) ToStringOutput

func (e HarnessType) ToStringOutput() pulumi.StringOutput

func (HarnessType) ToStringOutputWithContext

func (e HarnessType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HarnessType) ToStringPtrOutput

func (e HarnessType) ToStringPtrOutput() pulumi.StringPtrOutput

func (HarnessType) ToStringPtrOutputWithContext

func (e HarnessType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HarnessTypeInput

type HarnessTypeInput interface {
	pulumi.Input

	ToHarnessTypeOutput() HarnessTypeOutput
	ToHarnessTypeOutputWithContext(context.Context) HarnessTypeOutput
}

HarnessTypeInput is an input type that accepts values of the HarnessType enum A concrete instance of `HarnessTypeInput` can be one of the following:

HarnessTypeClaudeCode
HarnessTypeCodex
HarnessTypePi
HarnessTypeOpenCode

type HarnessTypeOutput

type HarnessTypeOutput struct{ *pulumi.OutputState }

func (HarnessTypeOutput) ElementType

func (HarnessTypeOutput) ElementType() reflect.Type

func (HarnessTypeOutput) ToHarnessTypeOutput

func (o HarnessTypeOutput) ToHarnessTypeOutput() HarnessTypeOutput

func (HarnessTypeOutput) ToHarnessTypeOutputWithContext

func (o HarnessTypeOutput) ToHarnessTypeOutputWithContext(ctx context.Context) HarnessTypeOutput

func (HarnessTypeOutput) ToHarnessTypePtrOutput

func (o HarnessTypeOutput) ToHarnessTypePtrOutput() HarnessTypePtrOutput

func (HarnessTypeOutput) ToHarnessTypePtrOutputWithContext

func (o HarnessTypeOutput) ToHarnessTypePtrOutputWithContext(ctx context.Context) HarnessTypePtrOutput

func (HarnessTypeOutput) ToStringOutput

func (o HarnessTypeOutput) ToStringOutput() pulumi.StringOutput

func (HarnessTypeOutput) ToStringOutputWithContext

func (o HarnessTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HarnessTypeOutput) ToStringPtrOutput

func (o HarnessTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HarnessTypeOutput) ToStringPtrOutputWithContext

func (o HarnessTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HarnessTypePtrInput

type HarnessTypePtrInput interface {
	pulumi.Input

	ToHarnessTypePtrOutput() HarnessTypePtrOutput
	ToHarnessTypePtrOutputWithContext(context.Context) HarnessTypePtrOutput
}

func HarnessTypePtr

func HarnessTypePtr(v string) HarnessTypePtrInput

type HarnessTypePtrOutput

type HarnessTypePtrOutput struct{ *pulumi.OutputState }

func (HarnessTypePtrOutput) Elem

func (HarnessTypePtrOutput) ElementType

func (HarnessTypePtrOutput) ElementType() reflect.Type

func (HarnessTypePtrOutput) ToHarnessTypePtrOutput

func (o HarnessTypePtrOutput) ToHarnessTypePtrOutput() HarnessTypePtrOutput

func (HarnessTypePtrOutput) ToHarnessTypePtrOutputWithContext

func (o HarnessTypePtrOutput) ToHarnessTypePtrOutputWithContext(ctx context.Context) HarnessTypePtrOutput

func (HarnessTypePtrOutput) ToStringPtrOutput

func (o HarnessTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HarnessTypePtrOutput) ToStringPtrOutputWithContext

func (o HarnessTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HookDefinition

type HookDefinition struct {
	// Arbitrary string arguments passed to the hook handler. Builtin handlers receive them as a typed parameter; e.g. 'add_context' takes Go text/template strings using hook input fields such as {{ .SessionID }}, 'add_prompt_files' takes the list of prompt files to load, 'add_recent_commits' optionally takes a positive integer commit limit, 'add_git_diff' accepts 'full' to emit the full unified diff, and 'max_iterations' takes a positive integer call limit.
	Args []string `pulumi:"args"`
	// Shell command (type=command) or builtin name (type=builtin) to invoke. Command hooks receive JSON input via stdin with tool/session information. Ignored when type=model.
	Command *string `pulumi:"command"`
	// Environment variables to add or override for this hook only. Values expand the plain ${env.VAR} form from the OS environment; any other $ is kept literal.
	Env map[string]string `pulumi:"env"`
	// Top-level evaluator referenced by type=evaluator hooks: tool_guard hooks use evaluator_policy, before_agent_run and after_agent_complete hooks use routing_policy.
	Evaluator *string `pulumi:"evaluator"`
	// Maps an evaluator's decisions to tool approval outcomes (`allow`, `ask`, `deny`) for `tool_guard` hooks.
	EvaluatorPolicy *EvaluatorPolicy `pulumi:"evaluatorPolicy"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Model spec ('provider/model', e.g. 'openai/gpt-4o-mini') invoked by type=model hooks. Required for that type, ignored otherwise.
	Model *string `pulumi:"model"`
	// Optional friendly hook name used in logs and runtime hook events.
	Name *string `pulumi:"name"`
	// Policy for execution errors, timeouts, unexpected nonzero exits and invalid output. 'warn' reports and continues (default), 'ignore' continues silently, and 'block' denies block-capable events. pre_tool_use and tool_guard always fail closed. on_error=block is rejected on observational events.
	OnError *HookErrorPolicy `pulumi:"onError"`
	// User-message template rendered for each invocation of a type=model hook. Parsed as a Go text/template with the hook Input as the data context: {{ .ToolName }}, {{ .ToolInput }}, {{ .StopResponse }}, etc. Required for type=model.
	Prompt *string `pulumi:"prompt"`
	// Maps a choice evaluator's outcomes to agents. Kept apart from the evaluator so the same assessment can drive different actions.
	RoutingPolicy *RoutingPolicy `pulumi:"routingPolicy"`
	// Well-known response interpretation for type=model hooks. Empty: return the model's reply as additional_context. 'pre_tool_use_decision': ask the model for {decision, reason} JSON and produce a permission_decision verdict (allow|ask|deny).
	Schema *string `pulumi:"schema"`
	// Require a single JSON output object (or empty stdout), reject unknown fields and outputs unsupported by the hook event. Failures follow on_error; pre_tool_use and tool_guard fail closed. Defaults to `false`.
	StrictOutput *bool `pulumi:"strictOutput"`
	// Literal system message for a model hook. Overrides the default; not templated.
	SystemPrompt *string `pulumi:"systemPrompt"`
	// Execution timeout in seconds (default: 60)
	Timeout *int `pulumi:"timeout"`
	// Type of hook. 'command' executes a shell command; 'builtin' invokes a named in-process Go function registered by the runtime; 'model' asks an LLM and translates its reply into the hook's native output (used for LLM-as-a-judge pre_tool_use, summarizers, etc., with no Go code). The docker-agent runtime ships these builtins: 'add_context' (context-contributing events: renders Go templates in args against hook input and joins non-empty results with newlines as additional context), 'add_date' (turn_start: today's date), 'add_environment_info' (session_start: cwd, git, OS, arch), 'add_prompt_files' (turn_start: contents of named files looked up in the workdir hierarchy and the home directory; args may include '--depth=<N>' to additionally list, by path only, the same filenames found up to N levels below the working directory), 'add_git_status' (turn_start: `git status --short --branch`), 'add_git_diff' (turn_start: `git diff --stat`, or full diff with args=['full']), 'add_directory_listing' (session_start: top-level entries of cwd), 'add_user_info' (session_start: current OS user and hostname), 'add_recent_commits' (session_start: `git log --oneline -n N`, default N=10, override via args=['<N>']), 'max_iterations' (before_llm_call: hard stop after N model calls; args=['<N>'] required), 'redact_secrets' (tool_input_transform or pre_tool_use / before_llm_call / tool_response_transform: scrubs detected secrets from tool arguments, outgoing chat content, and tool output — the same builtin handles all three legs and dispatches on the event; the matching agent-level 'redact_secrets: true' flag auto-injects the entries on tool_input_transform, before_llm_call, and tool_response_transform), 'transform_json' (tool_response_transform: keeps the top-level JSON fields named in args), 'limit_large_tool_results' (tool_response_transform and session_end: stores oversized tool output in a per-session temp file and replaces it with a bounded excerpt; always injected by the runtime), 'safer_shell' (pre_tool_use: deprecated compatibility shim that attaches shell safety classification metadata), 'http_post' (any event: POSTs args[1] to the URL in args[0]), 'snapshot' (session_start, turn_start, turn_end, pre_tool_use, post_tool_use, and session_end: records filesystem snapshots in a shadow git repository), 'unload' (on_agent_switch: POSTs `{"model": "<id>"}` to the previous agent's DMR model endpoints — e.g. asks Docker Model Runner to release the GPU/RAM held by the just-departing model so the next agent's model can claim it. Pure HTTP, no provider-specific runtime coupling; non-DMR providers are silently skipped. Opt in by adding the entry to the agent's hooks.on_agent_switch list). 'evaluator' assesses tool input through a named evaluator and applies a separate policy (tool_guard only).
	Type HookType `pulumi:"type"`
	// Working directory for this hook. Accepts ~, $VAR, ${VAR} and ${env.VAR}. Relative paths are resolved from the agent working directory.
	WorkingDir *string `pulumi:"workingDir"`
}

Definition of a lifecycle hook

type HookDefinitionArgs

type HookDefinitionArgs struct {
	// Arbitrary string arguments passed to the hook handler. Builtin handlers receive them as a typed parameter; e.g. 'add_context' takes Go text/template strings using hook input fields such as {{ .SessionID }}, 'add_prompt_files' takes the list of prompt files to load, 'add_recent_commits' optionally takes a positive integer commit limit, 'add_git_diff' accepts 'full' to emit the full unified diff, and 'max_iterations' takes a positive integer call limit.
	Args pulumi.StringArrayInput `pulumi:"args"`
	// Shell command (type=command) or builtin name (type=builtin) to invoke. Command hooks receive JSON input via stdin with tool/session information. Ignored when type=model.
	Command pulumi.StringPtrInput `pulumi:"command"`
	// Environment variables to add or override for this hook only. Values expand the plain ${env.VAR} form from the OS environment; any other $ is kept literal.
	Env pulumi.StringMapInput `pulumi:"env"`
	// Top-level evaluator referenced by type=evaluator hooks: tool_guard hooks use evaluator_policy, before_agent_run and after_agent_complete hooks use routing_policy.
	Evaluator pulumi.StringPtrInput `pulumi:"evaluator"`
	// Maps an evaluator's decisions to tool approval outcomes (`allow`, `ask`, `deny`) for `tool_guard` hooks.
	EvaluatorPolicy EvaluatorPolicyPtrInput `pulumi:"evaluatorPolicy"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Model spec ('provider/model', e.g. 'openai/gpt-4o-mini') invoked by type=model hooks. Required for that type, ignored otherwise.
	Model pulumi.StringPtrInput `pulumi:"model"`
	// Optional friendly hook name used in logs and runtime hook events.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Policy for execution errors, timeouts, unexpected nonzero exits and invalid output. 'warn' reports and continues (default), 'ignore' continues silently, and 'block' denies block-capable events. pre_tool_use and tool_guard always fail closed. on_error=block is rejected on observational events.
	OnError HookErrorPolicyPtrInput `pulumi:"onError"`
	// User-message template rendered for each invocation of a type=model hook. Parsed as a Go text/template with the hook Input as the data context: {{ .ToolName }}, {{ .ToolInput }}, {{ .StopResponse }}, etc. Required for type=model.
	Prompt pulumi.StringPtrInput `pulumi:"prompt"`
	// Maps a choice evaluator's outcomes to agents. Kept apart from the evaluator so the same assessment can drive different actions.
	RoutingPolicy RoutingPolicyPtrInput `pulumi:"routingPolicy"`
	// Well-known response interpretation for type=model hooks. Empty: return the model's reply as additional_context. 'pre_tool_use_decision': ask the model for {decision, reason} JSON and produce a permission_decision verdict (allow|ask|deny).
	Schema pulumi.StringPtrInput `pulumi:"schema"`
	// Require a single JSON output object (or empty stdout), reject unknown fields and outputs unsupported by the hook event. Failures follow on_error; pre_tool_use and tool_guard fail closed. Defaults to `false`.
	StrictOutput pulumi.BoolPtrInput `pulumi:"strictOutput"`
	// Literal system message for a model hook. Overrides the default; not templated.
	SystemPrompt pulumi.StringPtrInput `pulumi:"systemPrompt"`
	// Execution timeout in seconds (default: 60)
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// Type of hook. 'command' executes a shell command; 'builtin' invokes a named in-process Go function registered by the runtime; 'model' asks an LLM and translates its reply into the hook's native output (used for LLM-as-a-judge pre_tool_use, summarizers, etc., with no Go code). The docker-agent runtime ships these builtins: 'add_context' (context-contributing events: renders Go templates in args against hook input and joins non-empty results with newlines as additional context), 'add_date' (turn_start: today's date), 'add_environment_info' (session_start: cwd, git, OS, arch), 'add_prompt_files' (turn_start: contents of named files looked up in the workdir hierarchy and the home directory; args may include '--depth=<N>' to additionally list, by path only, the same filenames found up to N levels below the working directory), 'add_git_status' (turn_start: `git status --short --branch`), 'add_git_diff' (turn_start: `git diff --stat`, or full diff with args=['full']), 'add_directory_listing' (session_start: top-level entries of cwd), 'add_user_info' (session_start: current OS user and hostname), 'add_recent_commits' (session_start: `git log --oneline -n N`, default N=10, override via args=['<N>']), 'max_iterations' (before_llm_call: hard stop after N model calls; args=['<N>'] required), 'redact_secrets' (tool_input_transform or pre_tool_use / before_llm_call / tool_response_transform: scrubs detected secrets from tool arguments, outgoing chat content, and tool output — the same builtin handles all three legs and dispatches on the event; the matching agent-level 'redact_secrets: true' flag auto-injects the entries on tool_input_transform, before_llm_call, and tool_response_transform), 'transform_json' (tool_response_transform: keeps the top-level JSON fields named in args), 'limit_large_tool_results' (tool_response_transform and session_end: stores oversized tool output in a per-session temp file and replaces it with a bounded excerpt; always injected by the runtime), 'safer_shell' (pre_tool_use: deprecated compatibility shim that attaches shell safety classification metadata), 'http_post' (any event: POSTs args[1] to the URL in args[0]), 'snapshot' (session_start, turn_start, turn_end, pre_tool_use, post_tool_use, and session_end: records filesystem snapshots in a shadow git repository), 'unload' (on_agent_switch: POSTs `{"model": "<id>"}` to the previous agent's DMR model endpoints — e.g. asks Docker Model Runner to release the GPU/RAM held by the just-departing model so the next agent's model can claim it. Pure HTTP, no provider-specific runtime coupling; non-DMR providers are silently skipped. Opt in by adding the entry to the agent's hooks.on_agent_switch list). 'evaluator' assesses tool input through a named evaluator and applies a separate policy (tool_guard only).
	Type HookTypeInput `pulumi:"type"`
	// Working directory for this hook. Accepts ~, $VAR, ${VAR} and ${env.VAR}. Relative paths are resolved from the agent working directory.
	WorkingDir pulumi.StringPtrInput `pulumi:"workingDir"`
}

Definition of a lifecycle hook

func (HookDefinitionArgs) ElementType

func (HookDefinitionArgs) ElementType() reflect.Type

func (HookDefinitionArgs) ToHookDefinitionOutput

func (i HookDefinitionArgs) ToHookDefinitionOutput() HookDefinitionOutput

func (HookDefinitionArgs) ToHookDefinitionOutputWithContext

func (i HookDefinitionArgs) ToHookDefinitionOutputWithContext(ctx context.Context) HookDefinitionOutput

type HookDefinitionArray

type HookDefinitionArray []HookDefinitionInput

func (HookDefinitionArray) ElementType

func (HookDefinitionArray) ElementType() reflect.Type

func (HookDefinitionArray) ToHookDefinitionArrayOutput

func (i HookDefinitionArray) ToHookDefinitionArrayOutput() HookDefinitionArrayOutput

func (HookDefinitionArray) ToHookDefinitionArrayOutputWithContext

func (i HookDefinitionArray) ToHookDefinitionArrayOutputWithContext(ctx context.Context) HookDefinitionArrayOutput

type HookDefinitionArrayInput

type HookDefinitionArrayInput interface {
	pulumi.Input

	ToHookDefinitionArrayOutput() HookDefinitionArrayOutput
	ToHookDefinitionArrayOutputWithContext(context.Context) HookDefinitionArrayOutput
}

HookDefinitionArrayInput is an input type that accepts HookDefinitionArray and HookDefinitionArrayOutput values. You can construct a concrete instance of `HookDefinitionArrayInput` via:

HookDefinitionArray{ HookDefinitionArgs{...} }

type HookDefinitionArrayOutput

type HookDefinitionArrayOutput struct{ *pulumi.OutputState }

func (HookDefinitionArrayOutput) ElementType

func (HookDefinitionArrayOutput) ElementType() reflect.Type

func (HookDefinitionArrayOutput) Index

func (HookDefinitionArrayOutput) ToHookDefinitionArrayOutput

func (o HookDefinitionArrayOutput) ToHookDefinitionArrayOutput() HookDefinitionArrayOutput

func (HookDefinitionArrayOutput) ToHookDefinitionArrayOutputWithContext

func (o HookDefinitionArrayOutput) ToHookDefinitionArrayOutputWithContext(ctx context.Context) HookDefinitionArrayOutput

type HookDefinitionInput

type HookDefinitionInput interface {
	pulumi.Input

	ToHookDefinitionOutput() HookDefinitionOutput
	ToHookDefinitionOutputWithContext(context.Context) HookDefinitionOutput
}

HookDefinitionInput is an input type that accepts HookDefinitionArgs and HookDefinitionOutput values. You can construct a concrete instance of `HookDefinitionInput` via:

HookDefinitionArgs{...}

type HookDefinitionOutput

type HookDefinitionOutput struct{ *pulumi.OutputState }

Definition of a lifecycle hook

func (HookDefinitionOutput) Args

Arbitrary string arguments passed to the hook handler. Builtin handlers receive them as a typed parameter; e.g. 'add_context' takes Go text/template strings using hook input fields such as {{ .SessionID }}, 'add_prompt_files' takes the list of prompt files to load, 'add_recent_commits' optionally takes a positive integer commit limit, 'add_git_diff' accepts 'full' to emit the full unified diff, and 'max_iterations' takes a positive integer call limit.

func (HookDefinitionOutput) Command

Shell command (type=command) or builtin name (type=builtin) to invoke. Command hooks receive JSON input via stdin with tool/session information. Ignored when type=model.

func (HookDefinitionOutput) ElementType

func (HookDefinitionOutput) ElementType() reflect.Type

func (HookDefinitionOutput) Env

Environment variables to add or override for this hook only. Values expand the plain ${env.VAR} form from the OS environment; any other $ is kept literal.

func (HookDefinitionOutput) Evaluator

Top-level evaluator referenced by type=evaluator hooks: tool_guard hooks use evaluator_policy, before_agent_run and after_agent_complete hooks use routing_policy.

func (HookDefinitionOutput) EvaluatorPolicy

func (o HookDefinitionOutput) EvaluatorPolicy() EvaluatorPolicyPtrOutput

Maps an evaluator's decisions to tool approval outcomes (`allow`, `ask`, `deny`) for `tool_guard` hooks.

func (HookDefinitionOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (HookDefinitionOutput) Model

Model spec ('provider/model', e.g. 'openai/gpt-4o-mini') invoked by type=model hooks. Required for that type, ignored otherwise.

func (HookDefinitionOutput) Name

Optional friendly hook name used in logs and runtime hook events.

func (HookDefinitionOutput) OnError

Policy for execution errors, timeouts, unexpected nonzero exits and invalid output. 'warn' reports and continues (default), 'ignore' continues silently, and 'block' denies block-capable events. pre_tool_use and tool_guard always fail closed. on_error=block is rejected on observational events.

func (HookDefinitionOutput) Prompt

User-message template rendered for each invocation of a type=model hook. Parsed as a Go text/template with the hook Input as the data context: {{ .ToolName }}, {{ .ToolInput }}, {{ .StopResponse }}, etc. Required for type=model.

func (HookDefinitionOutput) RoutingPolicy

func (o HookDefinitionOutput) RoutingPolicy() RoutingPolicyPtrOutput

Maps a choice evaluator's outcomes to agents. Kept apart from the evaluator so the same assessment can drive different actions.

func (HookDefinitionOutput) Schema

Well-known response interpretation for type=model hooks. Empty: return the model's reply as additional_context. 'pre_tool_use_decision': ask the model for {decision, reason} JSON and produce a permission_decision verdict (allow|ask|deny).

func (HookDefinitionOutput) StrictOutput

func (o HookDefinitionOutput) StrictOutput() pulumi.BoolPtrOutput

Require a single JSON output object (or empty stdout), reject unknown fields and outputs unsupported by the hook event. Failures follow on_error; pre_tool_use and tool_guard fail closed. Defaults to `false`.

func (HookDefinitionOutput) SystemPrompt

func (o HookDefinitionOutput) SystemPrompt() pulumi.StringPtrOutput

Literal system message for a model hook. Overrides the default; not templated.

func (HookDefinitionOutput) Timeout

Execution timeout in seconds (default: 60)

func (HookDefinitionOutput) ToHookDefinitionOutput

func (o HookDefinitionOutput) ToHookDefinitionOutput() HookDefinitionOutput

func (HookDefinitionOutput) ToHookDefinitionOutputWithContext

func (o HookDefinitionOutput) ToHookDefinitionOutputWithContext(ctx context.Context) HookDefinitionOutput

func (HookDefinitionOutput) Type

Type of hook. 'command' executes a shell command; 'builtin' invokes a named in-process Go function registered by the runtime; 'model' asks an LLM and translates its reply into the hook's native output (used for LLM-as-a-judge pre_tool_use, summarizers, etc., with no Go code). The docker-agent runtime ships these builtins: 'add_context' (context-contributing events: renders Go templates in args against hook input and joins non-empty results with newlines as additional context), 'add_date' (turn_start: today's date), 'add_environment_info' (session_start: cwd, git, OS, arch), 'add_prompt_files' (turn_start: contents of named files looked up in the workdir hierarchy and the home directory; args may include '--depth=<N>' to additionally list, by path only, the same filenames found up to N levels below the working directory), 'add_git_status' (turn_start: `git status --short --branch`), 'add_git_diff' (turn_start: `git diff --stat`, or full diff with args=['full']), 'add_directory_listing' (session_start: top-level entries of cwd), 'add_user_info' (session_start: current OS user and hostname), 'add_recent_commits' (session_start: `git log --oneline -n N`, default N=10, override via args=['<N>']), 'max_iterations' (before_llm_call: hard stop after N model calls; args=['<N>'] required), 'redact_secrets' (tool_input_transform or pre_tool_use / before_llm_call / tool_response_transform: scrubs detected secrets from tool arguments, outgoing chat content, and tool output — the same builtin handles all three legs and dispatches on the event; the matching agent-level 'redact_secrets: true' flag auto-injects the entries on tool_input_transform, before_llm_call, and tool_response_transform), 'transform_json' (tool_response_transform: keeps the top-level JSON fields named in args), 'limit_large_tool_results' (tool_response_transform and session_end: stores oversized tool output in a per-session temp file and replaces it with a bounded excerpt; always injected by the runtime), 'safer_shell' (pre_tool_use: deprecated compatibility shim that attaches shell safety classification metadata), 'http_post' (any event: POSTs args[1] to the URL in args[0]), 'snapshot' (session_start, turn_start, turn_end, pre_tool_use, post_tool_use, and session_end: records filesystem snapshots in a shadow git repository), 'unload' (on_agent_switch: POSTs `{"model": "<id>"}` to the previous agent's DMR model endpoints — e.g. asks Docker Model Runner to release the GPU/RAM held by the just-departing model so the next agent's model can claim it. Pure HTTP, no provider-specific runtime coupling; non-DMR providers are silently skipped. Opt in by adding the entry to the agent's hooks.on_agent_switch list). 'evaluator' assesses tool input through a named evaluator and applies a separate policy (tool_guard only).

func (HookDefinitionOutput) WorkingDir

Working directory for this hook. Accepts ~, $VAR, ${VAR} and ${env.VAR}. Relative paths are resolved from the agent working directory.

type HookErrorPolicy

type HookErrorPolicy string

func (HookErrorPolicy) ElementType

func (HookErrorPolicy) ElementType() reflect.Type

func (HookErrorPolicy) ToHookErrorPolicyOutput

func (e HookErrorPolicy) ToHookErrorPolicyOutput() HookErrorPolicyOutput

func (HookErrorPolicy) ToHookErrorPolicyOutputWithContext

func (e HookErrorPolicy) ToHookErrorPolicyOutputWithContext(ctx context.Context) HookErrorPolicyOutput

func (HookErrorPolicy) ToHookErrorPolicyPtrOutput

func (e HookErrorPolicy) ToHookErrorPolicyPtrOutput() HookErrorPolicyPtrOutput

func (HookErrorPolicy) ToHookErrorPolicyPtrOutputWithContext

func (e HookErrorPolicy) ToHookErrorPolicyPtrOutputWithContext(ctx context.Context) HookErrorPolicyPtrOutput

func (HookErrorPolicy) ToStringOutput

func (e HookErrorPolicy) ToStringOutput() pulumi.StringOutput

func (HookErrorPolicy) ToStringOutputWithContext

func (e HookErrorPolicy) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HookErrorPolicy) ToStringPtrOutput

func (e HookErrorPolicy) ToStringPtrOutput() pulumi.StringPtrOutput

func (HookErrorPolicy) ToStringPtrOutputWithContext

func (e HookErrorPolicy) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HookErrorPolicyInput

type HookErrorPolicyInput interface {
	pulumi.Input

	ToHookErrorPolicyOutput() HookErrorPolicyOutput
	ToHookErrorPolicyOutputWithContext(context.Context) HookErrorPolicyOutput
}

HookErrorPolicyInput is an input type that accepts values of the HookErrorPolicy enum A concrete instance of `HookErrorPolicyInput` can be one of the following:

HookErrorPolicyWarn
HookErrorPolicyIgnore
HookErrorPolicyBlock

type HookErrorPolicyOutput

type HookErrorPolicyOutput struct{ *pulumi.OutputState }

func (HookErrorPolicyOutput) ElementType

func (HookErrorPolicyOutput) ElementType() reflect.Type

func (HookErrorPolicyOutput) ToHookErrorPolicyOutput

func (o HookErrorPolicyOutput) ToHookErrorPolicyOutput() HookErrorPolicyOutput

func (HookErrorPolicyOutput) ToHookErrorPolicyOutputWithContext

func (o HookErrorPolicyOutput) ToHookErrorPolicyOutputWithContext(ctx context.Context) HookErrorPolicyOutput

func (HookErrorPolicyOutput) ToHookErrorPolicyPtrOutput

func (o HookErrorPolicyOutput) ToHookErrorPolicyPtrOutput() HookErrorPolicyPtrOutput

func (HookErrorPolicyOutput) ToHookErrorPolicyPtrOutputWithContext

func (o HookErrorPolicyOutput) ToHookErrorPolicyPtrOutputWithContext(ctx context.Context) HookErrorPolicyPtrOutput

func (HookErrorPolicyOutput) ToStringOutput

func (o HookErrorPolicyOutput) ToStringOutput() pulumi.StringOutput

func (HookErrorPolicyOutput) ToStringOutputWithContext

func (o HookErrorPolicyOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HookErrorPolicyOutput) ToStringPtrOutput

func (o HookErrorPolicyOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HookErrorPolicyOutput) ToStringPtrOutputWithContext

func (o HookErrorPolicyOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HookErrorPolicyPtrInput

type HookErrorPolicyPtrInput interface {
	pulumi.Input

	ToHookErrorPolicyPtrOutput() HookErrorPolicyPtrOutput
	ToHookErrorPolicyPtrOutputWithContext(context.Context) HookErrorPolicyPtrOutput
}

func HookErrorPolicyPtr

func HookErrorPolicyPtr(v string) HookErrorPolicyPtrInput

type HookErrorPolicyPtrOutput

type HookErrorPolicyPtrOutput struct{ *pulumi.OutputState }

func (HookErrorPolicyPtrOutput) Elem

func (HookErrorPolicyPtrOutput) ElementType

func (HookErrorPolicyPtrOutput) ElementType() reflect.Type

func (HookErrorPolicyPtrOutput) ToHookErrorPolicyPtrOutput

func (o HookErrorPolicyPtrOutput) ToHookErrorPolicyPtrOutput() HookErrorPolicyPtrOutput

func (HookErrorPolicyPtrOutput) ToHookErrorPolicyPtrOutputWithContext

func (o HookErrorPolicyPtrOutput) ToHookErrorPolicyPtrOutputWithContext(ctx context.Context) HookErrorPolicyPtrOutput

func (HookErrorPolicyPtrOutput) ToStringPtrOutput

func (o HookErrorPolicyPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HookErrorPolicyPtrOutput) ToStringPtrOutputWithContext

func (o HookErrorPolicyPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HookMatcher

type HookMatcher struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Hooks to execute when the matcher matches
	Hooks []HookDefinition `pulumi:"hooks"`
	// Regex pattern to match tool names (e.g., 'shell|edit_file'). Use '*' to match all tools. Case-sensitive.
	Matcher *string `pulumi:"matcher"`
	// Opt a pre_tool_use entry into firing BEFORE the deterministic approval pipeline (custom allow/ask/deny rules + safety mode). A deny/ask verdict from a preempting hook cannot be bypassed by any safety mode (including autonomous) or permission allow-rules; an allow verdict is advisory (the pipeline still runs Decide() and the rest of pre_tool_use). Default pre_tool_use entries fire AFTER Decide(). Only valid on pre_tool_use; rejected on every other event. Set it on hooks that implement a security-critical check that must not be bypassed by auto-approval.
	PreemptYolo *bool `pulumi:"preemptYolo"`
}

Configuration for matching tools and their associated hooks

type HookMatcherArgs

type HookMatcherArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Hooks to execute when the matcher matches
	Hooks HookDefinitionArrayInput `pulumi:"hooks"`
	// Regex pattern to match tool names (e.g., 'shell|edit_file'). Use '*' to match all tools. Case-sensitive.
	Matcher pulumi.StringPtrInput `pulumi:"matcher"`
	// Opt a pre_tool_use entry into firing BEFORE the deterministic approval pipeline (custom allow/ask/deny rules + safety mode). A deny/ask verdict from a preempting hook cannot be bypassed by any safety mode (including autonomous) or permission allow-rules; an allow verdict is advisory (the pipeline still runs Decide() and the rest of pre_tool_use). Default pre_tool_use entries fire AFTER Decide(). Only valid on pre_tool_use; rejected on every other event. Set it on hooks that implement a security-critical check that must not be bypassed by auto-approval.
	PreemptYolo pulumi.BoolPtrInput `pulumi:"preemptYolo"`
}

Configuration for matching tools and their associated hooks

func (HookMatcherArgs) ElementType

func (HookMatcherArgs) ElementType() reflect.Type

func (HookMatcherArgs) ToHookMatcherOutput

func (i HookMatcherArgs) ToHookMatcherOutput() HookMatcherOutput

func (HookMatcherArgs) ToHookMatcherOutputWithContext

func (i HookMatcherArgs) ToHookMatcherOutputWithContext(ctx context.Context) HookMatcherOutput

type HookMatcherArray

type HookMatcherArray []HookMatcherInput

func (HookMatcherArray) ElementType

func (HookMatcherArray) ElementType() reflect.Type

func (HookMatcherArray) ToHookMatcherArrayOutput

func (i HookMatcherArray) ToHookMatcherArrayOutput() HookMatcherArrayOutput

func (HookMatcherArray) ToHookMatcherArrayOutputWithContext

func (i HookMatcherArray) ToHookMatcherArrayOutputWithContext(ctx context.Context) HookMatcherArrayOutput

type HookMatcherArrayInput

type HookMatcherArrayInput interface {
	pulumi.Input

	ToHookMatcherArrayOutput() HookMatcherArrayOutput
	ToHookMatcherArrayOutputWithContext(context.Context) HookMatcherArrayOutput
}

HookMatcherArrayInput is an input type that accepts HookMatcherArray and HookMatcherArrayOutput values. You can construct a concrete instance of `HookMatcherArrayInput` via:

HookMatcherArray{ HookMatcherArgs{...} }

type HookMatcherArrayOutput

type HookMatcherArrayOutput struct{ *pulumi.OutputState }

func (HookMatcherArrayOutput) ElementType

func (HookMatcherArrayOutput) ElementType() reflect.Type

func (HookMatcherArrayOutput) Index

func (HookMatcherArrayOutput) ToHookMatcherArrayOutput

func (o HookMatcherArrayOutput) ToHookMatcherArrayOutput() HookMatcherArrayOutput

func (HookMatcherArrayOutput) ToHookMatcherArrayOutputWithContext

func (o HookMatcherArrayOutput) ToHookMatcherArrayOutputWithContext(ctx context.Context) HookMatcherArrayOutput

type HookMatcherInput

type HookMatcherInput interface {
	pulumi.Input

	ToHookMatcherOutput() HookMatcherOutput
	ToHookMatcherOutputWithContext(context.Context) HookMatcherOutput
}

HookMatcherInput is an input type that accepts HookMatcherArgs and HookMatcherOutput values. You can construct a concrete instance of `HookMatcherInput` via:

HookMatcherArgs{...}

type HookMatcherOutput

type HookMatcherOutput struct{ *pulumi.OutputState }

Configuration for matching tools and their associated hooks

func (HookMatcherOutput) ElementType

func (HookMatcherOutput) ElementType() reflect.Type

func (HookMatcherOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (HookMatcherOutput) Hooks

Hooks to execute when the matcher matches

func (HookMatcherOutput) Matcher

Regex pattern to match tool names (e.g., 'shell|edit_file'). Use '*' to match all tools. Case-sensitive.

func (HookMatcherOutput) PreemptYolo

func (o HookMatcherOutput) PreemptYolo() pulumi.BoolPtrOutput

Opt a pre_tool_use entry into firing BEFORE the deterministic approval pipeline (custom allow/ask/deny rules + safety mode). A deny/ask verdict from a preempting hook cannot be bypassed by any safety mode (including autonomous) or permission allow-rules; an allow verdict is advisory (the pipeline still runs Decide() and the rest of pre_tool_use). Default pre_tool_use entries fire AFTER Decide(). Only valid on pre_tool_use; rejected on every other event. Set it on hooks that implement a security-critical check that must not be bypassed by auto-approval.

func (HookMatcherOutput) ToHookMatcherOutput

func (o HookMatcherOutput) ToHookMatcherOutput() HookMatcherOutput

func (HookMatcherOutput) ToHookMatcherOutputWithContext

func (o HookMatcherOutput) ToHookMatcherOutputWithContext(ctx context.Context) HookMatcherOutput

type HookType

type HookType string

func (HookType) ElementType

func (HookType) ElementType() reflect.Type

func (HookType) ToHookTypeOutput

func (e HookType) ToHookTypeOutput() HookTypeOutput

func (HookType) ToHookTypeOutputWithContext

func (e HookType) ToHookTypeOutputWithContext(ctx context.Context) HookTypeOutput

func (HookType) ToHookTypePtrOutput

func (e HookType) ToHookTypePtrOutput() HookTypePtrOutput

func (HookType) ToHookTypePtrOutputWithContext

func (e HookType) ToHookTypePtrOutputWithContext(ctx context.Context) HookTypePtrOutput

func (HookType) ToStringOutput

func (e HookType) ToStringOutput() pulumi.StringOutput

func (HookType) ToStringOutputWithContext

func (e HookType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HookType) ToStringPtrOutput

func (e HookType) ToStringPtrOutput() pulumi.StringPtrOutput

func (HookType) ToStringPtrOutputWithContext

func (e HookType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HookTypeInput

type HookTypeInput interface {
	pulumi.Input

	ToHookTypeOutput() HookTypeOutput
	ToHookTypeOutputWithContext(context.Context) HookTypeOutput
}

HookTypeInput is an input type that accepts values of the HookType enum A concrete instance of `HookTypeInput` can be one of the following:

HookTypeCommand
HookTypeBuiltin
HookTypeModel
HookTypeEvaluator

type HookTypeOutput

type HookTypeOutput struct{ *pulumi.OutputState }

func (HookTypeOutput) ElementType

func (HookTypeOutput) ElementType() reflect.Type

func (HookTypeOutput) ToHookTypeOutput

func (o HookTypeOutput) ToHookTypeOutput() HookTypeOutput

func (HookTypeOutput) ToHookTypeOutputWithContext

func (o HookTypeOutput) ToHookTypeOutputWithContext(ctx context.Context) HookTypeOutput

func (HookTypeOutput) ToHookTypePtrOutput

func (o HookTypeOutput) ToHookTypePtrOutput() HookTypePtrOutput

func (HookTypeOutput) ToHookTypePtrOutputWithContext

func (o HookTypeOutput) ToHookTypePtrOutputWithContext(ctx context.Context) HookTypePtrOutput

func (HookTypeOutput) ToStringOutput

func (o HookTypeOutput) ToStringOutput() pulumi.StringOutput

func (HookTypeOutput) ToStringOutputWithContext

func (o HookTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HookTypeOutput) ToStringPtrOutput

func (o HookTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HookTypeOutput) ToStringPtrOutputWithContext

func (o HookTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HookTypePtrInput

type HookTypePtrInput interface {
	pulumi.Input

	ToHookTypePtrOutput() HookTypePtrOutput
	ToHookTypePtrOutputWithContext(context.Context) HookTypePtrOutput
}

func HookTypePtr

func HookTypePtr(v string) HookTypePtrInput

type HookTypePtrOutput

type HookTypePtrOutput struct{ *pulumi.OutputState }

func (HookTypePtrOutput) Elem

func (HookTypePtrOutput) ElementType

func (HookTypePtrOutput) ElementType() reflect.Type

func (HookTypePtrOutput) ToHookTypePtrOutput

func (o HookTypePtrOutput) ToHookTypePtrOutput() HookTypePtrOutput

func (HookTypePtrOutput) ToHookTypePtrOutputWithContext

func (o HookTypePtrOutput) ToHookTypePtrOutputWithContext(ctx context.Context) HookTypePtrOutput

func (HookTypePtrOutput) ToStringPtrOutput

func (o HookTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HookTypePtrOutput) ToStringPtrOutputWithContext

func (o HookTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Hooks

type Hooks struct {
	// Hooks that run once after an agent completes successfully (natural completion, accepted structured output, or a cached answer), before the run decides whether it is finished. A hook may return hookSpecificOutput.transition {action: route, agent} to continue the same conversation with another agent from routing.allowed_agents. Not fired on errors, cancellation, budget stops, iteration-limit pauses, or empty completions. At most one hook is allowed per agent; cannot be combined with force_handoff. Output is always validated strictly and failures block the run.
	AfterAgentComplete []HookDefinition `pulumi:"afterAgentComplete"`
	// Hooks that run after a successful compaction (a summary was applied to the session). Receives the final summary text in Input.summary alongside input_tokens, output_tokens, context_limit and compaction_reason. Purely observational — hook output is ignored.
	AfterCompaction []HookDefinition `pulumi:"afterCompaction"`
	// Hooks that run just after each successful model call, before the response is recorded into the session and tool calls are dispatched. Receives the assistant text content in stop_response. Failed calls fire on_error instead.
	AfterLlmCall []HookDefinition `pulumi:"afterLlmCall"`
	// Hooks that run once per agent activation, before the agent's model is selected or its response cache is consulted. A hook may return hookSpecificOutput.transition {action: route, agent} to replace the activation with another agent from the agent's routing.allowed_agents; the skipped agent never calls its model. Each destination has its own activation. At most one hook is allowed per agent after merging identical definitions; requires the agent's routing declaration. Output is always validated strictly and failures block the run; blocking beats any transition.
	BeforeAgentRun []HookDefinition `pulumi:"beforeAgentRun"`
	// Hooks that run immediately before a session compaction. The Input carries input_tokens, output_tokens, context_limit, and compaction_reason ('threshold', 'overflow', 'manual'). A hook may veto compaction by setting decision='block' (or exiting with code 2), or supply a custom summary via hookSpecificOutput.summary, in which case the runtime applies that summary verbatim and skips the LLM-based summarization. Be cautious about denying when compaction_reason='overflow': the runtime is recovering from a context-overflow error and a denial there will leave the session unable to make progress.
	BeforeCompaction []HookDefinition `pulumi:"beforeCompaction"`
	// Hooks that run just before each model call (after turn_start has assembled the messages). Use for observability, cost guardrails, or auditing without contributing system messages — turn_start is the right event for the latter.
	BeforeLlmCall []HookDefinition `pulumi:"beforeLlmCall"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Hooks that run when the agent sends a notification (error, warning) to the user. Can send external notifications or log events.
	Notification []HookDefinition `pulumi:"notification"`
	// Hooks that run whenever the runtime moves the active agent to a new one (transfer_task, handoff, or the return after a transferred task completes). Receives from_agent, to_agent, and agent_switch_kind in the input. Observational; useful for audit, transcript, and metrics pipelines that track which agent ran which tools.
	OnAgentSwitch []HookDefinition `pulumi:"onAgentSwitch"`
	// Hooks that run when the runtime hits an error during a turn (model failures, repetitive tool-call loops). Fires alongside notification (level=error); use this for structured error-only handlers without parsing notification_level.
	OnError []HookDefinition `pulumi:"onError"`
	// Hooks that run when the runtime reaches its configured max_iterations limit. Fires alongside notification (level=warning); use this for structured handlers (e.g. log to a metrics pipeline) without parsing notification_message.
	OnMaxIterations []HookDefinition `pulumi:"onMaxIterations"`
	// Hooks that run when the user explicitly approves the runtime to continue past its configured max_iterations limit. Receives previous_max_iterations and new_max_iterations in the input. Observational; useful for alerting on extended-runtime sessions or for billing/quota pipelines that meter resumes.
	OnSessionResume []HookDefinition `pulumi:"onSessionResume"`
	// Hooks that run after the runtime's tool approval chain (custom rules / safety mode / hooks / ask) resolves a verdict for a tool call, before the call is executed (allow) or its error response is recorded (deny / canceled). Receives approval_decision ("allow" | "deny" | "canceled"), approval_source (a stable classifier of which step decided), and safety_label (the runtime classifier's safe / destructive / unknown verdict). Observational; gives audit pipelines a single "who approved what" record without re-implementing the chain.
	OnToolApprovalDecision []HookDefinition `pulumi:"onToolApprovalDecision"`
	// Hooks that run when the agent needs user input. Can send notifications or log events.
	OnUserInput []HookDefinition `pulumi:"onUserInput"`
	// Hooks that run just before the runtime prompts the user to approve a tool call (i.e. when the safety mode and permission rules did not short-circuit the decision). Hooks may auto-allow or auto-deny via hook_specific_output.permission_decision; otherwise control falls through to the interactive confirmation. Tool-matched, like pre_tool_use.
	PermissionRequest []HookMatcher `pulumi:"permissionRequest"`
	// Hooks that run after a tool completes (both success and failure). The result is delivered in tool_response (failed calls carry an is_error flag and any error text). Returning decision=block or exit code 2 stops the run loop after the current tool batch — useful for circuit-breaker patterns.
	PostToolUse []HookMatcher `pulumi:"postToolUse"`
	// Hooks that run just before the runtime compacts the session transcript into a summary. The trigger is reported in source: 'manual' (user-initiated /compact), 'auto' (proactive threshold), 'overflow' (context-overflow recovery), or 'tool_overflow' (proactive after tool results pushed past the threshold). Hooks may block compaction (decision=block / continue=false / exit code 2) or contribute additional_context that is appended to the compaction prompt — useful for steering the summary without modifying the agent's instruction.
	PreCompact []HookDefinition `pulumi:"preCompact"`
	// Hooks that run before a tool is executed. Can allow/deny/modify tool calls.
	PreToolUse []HookMatcher `pulumi:"preToolUse"`
	// Checks loaded and retained prompt-file instructions before storage or use. Every hook must explicitly approve; failures stop the turn in every safety mode.
	PromptFileGuard []HookDefinition `pulumi:"promptFileGuard"`
	// Hooks that run when a session ends. Can perform cleanup or logging.
	SessionEnd []HookDefinition `pulumi:"sessionEnd"`
	// Hooks that run when a session begins. Can load context or setup environment.
	SessionStart []HookDefinition `pulumi:"sessionStart"`
	// Checks raw skill text before expansion or delivery. Every hook must explicitly approve; denials and failures reject the load in every safety mode.
	SkillContentGuard []HookDefinition `pulumi:"skillContentGuard"`
	// Hooks that run when the model finishes responding and is about to hand control back to the user. Can perform post-response validation or logging.
	Stop []HookDefinition `pulumi:"stop"`
	// Hooks that run when a sub-agent (transferred task, background agent, skill sub-session) finishes. Fires against the parent agent's executor so handlers configured on the orchestrator see every child completion. The sub-agent's name is in agent_name and its final assistant message in stop_response.
	SubagentStop []HookDefinition `pulumi:"subagentStop"`
	// Hooks that run after tool_input_transform and before the deterministic approval pipeline, so their verdict cannot be bypassed by any safety mode (including autonomous / --yolo) or permission allow-rule. Hooks run concurrently; hookSpecificOutput.permission_decision verdicts aggregate to the most restrictive (deny > ask > allow). deny rejects the call; ask forces the interactive prompt even when the session already allowed the tool; allow is advisory (the pipeline still runs). hookSpecificOutput.metadata is merged into the confirmation prompt. updated_input is ignored — use tool_input_transform to rewrite arguments. Hook execution failures fail closed (deny), like pre_tool_use. Tool-matched; preempt_yolo is rejected because the event always preempts approval.
	ToolGuard []HookMatcher `pulumi:"toolGuard"`
	// Hooks that run before every tool call, ahead of the deterministic approval pipeline (safety mode, permission rules, --yolo) and of tool_guard. Hooks run sequentially, each seeing the preceding rewrite, and may patch tool arguments via hookSpecificOutput.updated_input exactly like pre_tool_use; the approval pipeline and every later hook see the rewritten arguments. Rewrite-only: verdicts belong on tool_guard. Failures follow the hook's on_error policy (default warn; block denies the call). The redact_secrets builtin's argument-scrubbing leg is auto-injected here. Tool-matched, like pre_tool_use; preempt_yolo is rejected because the event always preempts approval.
	ToolInputTransform []HookMatcher `pulumi:"toolInputTransform"`
	// Hooks that fire between a tool's execution and the runtime's emission/record of the response, with the rewrite reaching event consumers, the persisted session, the post_tool_use hook input, and the next LLM call. A hook may rewrite the tool's textual output by setting hookSpecificOutput.updated_tool_response — the symmetric counterpart of pre_tool_use's updated_input, applied to tool RESULTS instead of tool ARGUMENTS. The redact_secrets builtin uses this event for the third leg of the redact_secrets feature; custom rewriters can also truncate excessive output, scrub PII, or normalise tool dialects. Tool-matched, like pre_tool_use / post_tool_use.
	ToolResponseTransform []HookMatcher `pulumi:"toolResponseTransform"`
	// Hooks that run once per agent turn when the turn finishes — the symmetric counterpart of turn_start. Fires no matter why the turn ended: a normal stop, an error, a hook-driven shutdown, the loop detector, or context cancellation. The reason is reported via the hook input's reason field ('normal', 'continue', 'steered', 'error', 'canceled', 'hook_blocked', 'loop_detected'). Observational; output is ignored.
	TurnEnd []HookDefinition `pulumi:"turnEnd"`
	// Hooks that run at the start of every agent turn (each model call). Their AdditionalContext is appended as transient system messages for that turn only — it is NOT persisted to the session, so per-turn signals (date, prompt files) are recomputed every turn instead of bloating message history on every resume.
	TurnStart []HookDefinition `pulumi:"turnStart"`
	// Hooks that run each time the runtime dequeues a follow-up message at the end of a turn and starts a fresh turn for it. Follow-ups are user messages queued for end-of-turn processing (the FollowUp API / queue), distinct from mid-turn steering — the model sees them as fresh input. The follow-up text is passed in the prompt field. Like user_prompt_submit, hooks can block the run (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for the follow-up turn only — it is NOT persisted to the session.
	UserFollowupSubmit []HookDefinition `pulumi:"userFollowupSubmit"`
	// Hooks that run once per user message, after the user has submitted their prompt and before the first model call of the turn. The submitted text is passed in the prompt field. Hooks can block submission (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for that turn only. Sub-sessions (transferred tasks, background agents) do NOT fire this event because their kick-off message is synthesised by the runtime.
	UserPromptSubmit []HookDefinition `pulumi:"userPromptSubmit"`
	// Hooks that run each time the runtime drains the steering queue and appends the queued user messages to the session — messages the user submitted while the agent was already working (mid-turn, after the model stopped, or while idle before the first model call). The drained messages are passed in the steering_messages field. Like user_prompt_submit, hooks can block the run (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for the steered turn only — it is NOT persisted to the session.
	UserSteeringMessagesSubmit []HookDefinition `pulumi:"userSteeringMessagesSubmit"`
	// Hooks that run once, just after `docker agent run --worktree` creates a git worktree and before the session starts. They execute inside the new worktree (their working directory is the fresh checkout), and the worktree path, branch, and source repository root are passed in worktree_path / worktree_branch / worktree_source_dir. Use them to prepare the checkout: copy untracked files like .env, install dependencies, warm caches, before the agent begins. A hook may abort the run by blocking (decision=block / continue=false / exit code 2); stdout is surfaced as additional context. Dispatched from the CLI rather than the run loop because the worktree (and the working directory every downstream component captures) must be settled before the runtime and session exist.
	WorktreeCreate []HookDefinition `pulumi:"worktreeCreate"`
}

Lifecycle hooks configuration for an agent. Hooks allow running shell commands at various points in the agent's execution lifecycle.

type HooksArgs

type HooksArgs struct {
	// Hooks that run once after an agent completes successfully (natural completion, accepted structured output, or a cached answer), before the run decides whether it is finished. A hook may return hookSpecificOutput.transition {action: route, agent} to continue the same conversation with another agent from routing.allowed_agents. Not fired on errors, cancellation, budget stops, iteration-limit pauses, or empty completions. At most one hook is allowed per agent; cannot be combined with force_handoff. Output is always validated strictly and failures block the run.
	AfterAgentComplete HookDefinitionArrayInput `pulumi:"afterAgentComplete"`
	// Hooks that run after a successful compaction (a summary was applied to the session). Receives the final summary text in Input.summary alongside input_tokens, output_tokens, context_limit and compaction_reason. Purely observational — hook output is ignored.
	AfterCompaction HookDefinitionArrayInput `pulumi:"afterCompaction"`
	// Hooks that run just after each successful model call, before the response is recorded into the session and tool calls are dispatched. Receives the assistant text content in stop_response. Failed calls fire on_error instead.
	AfterLlmCall HookDefinitionArrayInput `pulumi:"afterLlmCall"`
	// Hooks that run once per agent activation, before the agent's model is selected or its response cache is consulted. A hook may return hookSpecificOutput.transition {action: route, agent} to replace the activation with another agent from the agent's routing.allowed_agents; the skipped agent never calls its model. Each destination has its own activation. At most one hook is allowed per agent after merging identical definitions; requires the agent's routing declaration. Output is always validated strictly and failures block the run; blocking beats any transition.
	BeforeAgentRun HookDefinitionArrayInput `pulumi:"beforeAgentRun"`
	// Hooks that run immediately before a session compaction. The Input carries input_tokens, output_tokens, context_limit, and compaction_reason ('threshold', 'overflow', 'manual'). A hook may veto compaction by setting decision='block' (or exiting with code 2), or supply a custom summary via hookSpecificOutput.summary, in which case the runtime applies that summary verbatim and skips the LLM-based summarization. Be cautious about denying when compaction_reason='overflow': the runtime is recovering from a context-overflow error and a denial there will leave the session unable to make progress.
	BeforeCompaction HookDefinitionArrayInput `pulumi:"beforeCompaction"`
	// Hooks that run just before each model call (after turn_start has assembled the messages). Use for observability, cost guardrails, or auditing without contributing system messages — turn_start is the right event for the latter.
	BeforeLlmCall HookDefinitionArrayInput `pulumi:"beforeLlmCall"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Hooks that run when the agent sends a notification (error, warning) to the user. Can send external notifications or log events.
	Notification HookDefinitionArrayInput `pulumi:"notification"`
	// Hooks that run whenever the runtime moves the active agent to a new one (transfer_task, handoff, or the return after a transferred task completes). Receives from_agent, to_agent, and agent_switch_kind in the input. Observational; useful for audit, transcript, and metrics pipelines that track which agent ran which tools.
	OnAgentSwitch HookDefinitionArrayInput `pulumi:"onAgentSwitch"`
	// Hooks that run when the runtime hits an error during a turn (model failures, repetitive tool-call loops). Fires alongside notification (level=error); use this for structured error-only handlers without parsing notification_level.
	OnError HookDefinitionArrayInput `pulumi:"onError"`
	// Hooks that run when the runtime reaches its configured max_iterations limit. Fires alongside notification (level=warning); use this for structured handlers (e.g. log to a metrics pipeline) without parsing notification_message.
	OnMaxIterations HookDefinitionArrayInput `pulumi:"onMaxIterations"`
	// Hooks that run when the user explicitly approves the runtime to continue past its configured max_iterations limit. Receives previous_max_iterations and new_max_iterations in the input. Observational; useful for alerting on extended-runtime sessions or for billing/quota pipelines that meter resumes.
	OnSessionResume HookDefinitionArrayInput `pulumi:"onSessionResume"`
	// Hooks that run after the runtime's tool approval chain (custom rules / safety mode / hooks / ask) resolves a verdict for a tool call, before the call is executed (allow) or its error response is recorded (deny / canceled). Receives approval_decision ("allow" | "deny" | "canceled"), approval_source (a stable classifier of which step decided), and safety_label (the runtime classifier's safe / destructive / unknown verdict). Observational; gives audit pipelines a single "who approved what" record without re-implementing the chain.
	OnToolApprovalDecision HookDefinitionArrayInput `pulumi:"onToolApprovalDecision"`
	// Hooks that run when the agent needs user input. Can send notifications or log events.
	OnUserInput HookDefinitionArrayInput `pulumi:"onUserInput"`
	// Hooks that run just before the runtime prompts the user to approve a tool call (i.e. when the safety mode and permission rules did not short-circuit the decision). Hooks may auto-allow or auto-deny via hook_specific_output.permission_decision; otherwise control falls through to the interactive confirmation. Tool-matched, like pre_tool_use.
	PermissionRequest HookMatcherArrayInput `pulumi:"permissionRequest"`
	// Hooks that run after a tool completes (both success and failure). The result is delivered in tool_response (failed calls carry an is_error flag and any error text). Returning decision=block or exit code 2 stops the run loop after the current tool batch — useful for circuit-breaker patterns.
	PostToolUse HookMatcherArrayInput `pulumi:"postToolUse"`
	// Hooks that run just before the runtime compacts the session transcript into a summary. The trigger is reported in source: 'manual' (user-initiated /compact), 'auto' (proactive threshold), 'overflow' (context-overflow recovery), or 'tool_overflow' (proactive after tool results pushed past the threshold). Hooks may block compaction (decision=block / continue=false / exit code 2) or contribute additional_context that is appended to the compaction prompt — useful for steering the summary without modifying the agent's instruction.
	PreCompact HookDefinitionArrayInput `pulumi:"preCompact"`
	// Hooks that run before a tool is executed. Can allow/deny/modify tool calls.
	PreToolUse HookMatcherArrayInput `pulumi:"preToolUse"`
	// Checks loaded and retained prompt-file instructions before storage or use. Every hook must explicitly approve; failures stop the turn in every safety mode.
	PromptFileGuard HookDefinitionArrayInput `pulumi:"promptFileGuard"`
	// Hooks that run when a session ends. Can perform cleanup or logging.
	SessionEnd HookDefinitionArrayInput `pulumi:"sessionEnd"`
	// Hooks that run when a session begins. Can load context or setup environment.
	SessionStart HookDefinitionArrayInput `pulumi:"sessionStart"`
	// Checks raw skill text before expansion or delivery. Every hook must explicitly approve; denials and failures reject the load in every safety mode.
	SkillContentGuard HookDefinitionArrayInput `pulumi:"skillContentGuard"`
	// Hooks that run when the model finishes responding and is about to hand control back to the user. Can perform post-response validation or logging.
	Stop HookDefinitionArrayInput `pulumi:"stop"`
	// Hooks that run when a sub-agent (transferred task, background agent, skill sub-session) finishes. Fires against the parent agent's executor so handlers configured on the orchestrator see every child completion. The sub-agent's name is in agent_name and its final assistant message in stop_response.
	SubagentStop HookDefinitionArrayInput `pulumi:"subagentStop"`
	// Hooks that run after tool_input_transform and before the deterministic approval pipeline, so their verdict cannot be bypassed by any safety mode (including autonomous / --yolo) or permission allow-rule. Hooks run concurrently; hookSpecificOutput.permission_decision verdicts aggregate to the most restrictive (deny > ask > allow). deny rejects the call; ask forces the interactive prompt even when the session already allowed the tool; allow is advisory (the pipeline still runs). hookSpecificOutput.metadata is merged into the confirmation prompt. updated_input is ignored — use tool_input_transform to rewrite arguments. Hook execution failures fail closed (deny), like pre_tool_use. Tool-matched; preempt_yolo is rejected because the event always preempts approval.
	ToolGuard HookMatcherArrayInput `pulumi:"toolGuard"`
	// Hooks that run before every tool call, ahead of the deterministic approval pipeline (safety mode, permission rules, --yolo) and of tool_guard. Hooks run sequentially, each seeing the preceding rewrite, and may patch tool arguments via hookSpecificOutput.updated_input exactly like pre_tool_use; the approval pipeline and every later hook see the rewritten arguments. Rewrite-only: verdicts belong on tool_guard. Failures follow the hook's on_error policy (default warn; block denies the call). The redact_secrets builtin's argument-scrubbing leg is auto-injected here. Tool-matched, like pre_tool_use; preempt_yolo is rejected because the event always preempts approval.
	ToolInputTransform HookMatcherArrayInput `pulumi:"toolInputTransform"`
	// Hooks that fire between a tool's execution and the runtime's emission/record of the response, with the rewrite reaching event consumers, the persisted session, the post_tool_use hook input, and the next LLM call. A hook may rewrite the tool's textual output by setting hookSpecificOutput.updated_tool_response — the symmetric counterpart of pre_tool_use's updated_input, applied to tool RESULTS instead of tool ARGUMENTS. The redact_secrets builtin uses this event for the third leg of the redact_secrets feature; custom rewriters can also truncate excessive output, scrub PII, or normalise tool dialects. Tool-matched, like pre_tool_use / post_tool_use.
	ToolResponseTransform HookMatcherArrayInput `pulumi:"toolResponseTransform"`
	// Hooks that run once per agent turn when the turn finishes — the symmetric counterpart of turn_start. Fires no matter why the turn ended: a normal stop, an error, a hook-driven shutdown, the loop detector, or context cancellation. The reason is reported via the hook input's reason field ('normal', 'continue', 'steered', 'error', 'canceled', 'hook_blocked', 'loop_detected'). Observational; output is ignored.
	TurnEnd HookDefinitionArrayInput `pulumi:"turnEnd"`
	// Hooks that run at the start of every agent turn (each model call). Their AdditionalContext is appended as transient system messages for that turn only — it is NOT persisted to the session, so per-turn signals (date, prompt files) are recomputed every turn instead of bloating message history on every resume.
	TurnStart HookDefinitionArrayInput `pulumi:"turnStart"`
	// Hooks that run each time the runtime dequeues a follow-up message at the end of a turn and starts a fresh turn for it. Follow-ups are user messages queued for end-of-turn processing (the FollowUp API / queue), distinct from mid-turn steering — the model sees them as fresh input. The follow-up text is passed in the prompt field. Like user_prompt_submit, hooks can block the run (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for the follow-up turn only — it is NOT persisted to the session.
	UserFollowupSubmit HookDefinitionArrayInput `pulumi:"userFollowupSubmit"`
	// Hooks that run once per user message, after the user has submitted their prompt and before the first model call of the turn. The submitted text is passed in the prompt field. Hooks can block submission (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for that turn only. Sub-sessions (transferred tasks, background agents) do NOT fire this event because their kick-off message is synthesised by the runtime.
	UserPromptSubmit HookDefinitionArrayInput `pulumi:"userPromptSubmit"`
	// Hooks that run each time the runtime drains the steering queue and appends the queued user messages to the session — messages the user submitted while the agent was already working (mid-turn, after the model stopped, or while idle before the first model call). The drained messages are passed in the steering_messages field. Like user_prompt_submit, hooks can block the run (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for the steered turn only — it is NOT persisted to the session.
	UserSteeringMessagesSubmit HookDefinitionArrayInput `pulumi:"userSteeringMessagesSubmit"`
	// Hooks that run once, just after `docker agent run --worktree` creates a git worktree and before the session starts. They execute inside the new worktree (their working directory is the fresh checkout), and the worktree path, branch, and source repository root are passed in worktree_path / worktree_branch / worktree_source_dir. Use them to prepare the checkout: copy untracked files like .env, install dependencies, warm caches, before the agent begins. A hook may abort the run by blocking (decision=block / continue=false / exit code 2); stdout is surfaced as additional context. Dispatched from the CLI rather than the run loop because the worktree (and the working directory every downstream component captures) must be settled before the runtime and session exist.
	WorktreeCreate HookDefinitionArrayInput `pulumi:"worktreeCreate"`
}

Lifecycle hooks configuration for an agent. Hooks allow running shell commands at various points in the agent's execution lifecycle.

func (HooksArgs) ElementType

func (HooksArgs) ElementType() reflect.Type

func (HooksArgs) ToHooksOutput

func (i HooksArgs) ToHooksOutput() HooksOutput

func (HooksArgs) ToHooksOutputWithContext

func (i HooksArgs) ToHooksOutputWithContext(ctx context.Context) HooksOutput

func (HooksArgs) ToHooksPtrOutput

func (i HooksArgs) ToHooksPtrOutput() HooksPtrOutput

func (HooksArgs) ToHooksPtrOutputWithContext

func (i HooksArgs) ToHooksPtrOutputWithContext(ctx context.Context) HooksPtrOutput

type HooksInput

type HooksInput interface {
	pulumi.Input

	ToHooksOutput() HooksOutput
	ToHooksOutputWithContext(context.Context) HooksOutput
}

HooksInput is an input type that accepts HooksArgs and HooksOutput values. You can construct a concrete instance of `HooksInput` via:

HooksArgs{...}

type HooksOutput

type HooksOutput struct{ *pulumi.OutputState }

Lifecycle hooks configuration for an agent. Hooks allow running shell commands at various points in the agent's execution lifecycle.

func (HooksOutput) AfterAgentComplete

func (o HooksOutput) AfterAgentComplete() HookDefinitionArrayOutput

Hooks that run once after an agent completes successfully (natural completion, accepted structured output, or a cached answer), before the run decides whether it is finished. A hook may return hookSpecificOutput.transition {action: route, agent} to continue the same conversation with another agent from routing.allowed_agents. Not fired on errors, cancellation, budget stops, iteration-limit pauses, or empty completions. At most one hook is allowed per agent; cannot be combined with force_handoff. Output is always validated strictly and failures block the run.

func (HooksOutput) AfterCompaction

func (o HooksOutput) AfterCompaction() HookDefinitionArrayOutput

Hooks that run after a successful compaction (a summary was applied to the session). Receives the final summary text in Input.summary alongside input_tokens, output_tokens, context_limit and compaction_reason. Purely observational — hook output is ignored.

func (HooksOutput) AfterLlmCall

func (o HooksOutput) AfterLlmCall() HookDefinitionArrayOutput

Hooks that run just after each successful model call, before the response is recorded into the session and tool calls are dispatched. Receives the assistant text content in stop_response. Failed calls fire on_error instead.

func (HooksOutput) BeforeAgentRun

func (o HooksOutput) BeforeAgentRun() HookDefinitionArrayOutput

Hooks that run once per agent activation, before the agent's model is selected or its response cache is consulted. A hook may return hookSpecificOutput.transition {action: route, agent} to replace the activation with another agent from the agent's routing.allowed_agents; the skipped agent never calls its model. Each destination has its own activation. At most one hook is allowed per agent after merging identical definitions; requires the agent's routing declaration. Output is always validated strictly and failures block the run; blocking beats any transition.

func (HooksOutput) BeforeCompaction

func (o HooksOutput) BeforeCompaction() HookDefinitionArrayOutput

Hooks that run immediately before a session compaction. The Input carries input_tokens, output_tokens, context_limit, and compaction_reason ('threshold', 'overflow', 'manual'). A hook may veto compaction by setting decision='block' (or exiting with code 2), or supply a custom summary via hookSpecificOutput.summary, in which case the runtime applies that summary verbatim and skips the LLM-based summarization. Be cautious about denying when compaction_reason='overflow': the runtime is recovering from a context-overflow error and a denial there will leave the session unable to make progress.

func (HooksOutput) BeforeLlmCall

func (o HooksOutput) BeforeLlmCall() HookDefinitionArrayOutput

Hooks that run just before each model call (after turn_start has assembled the messages). Use for observability, cost guardrails, or auditing without contributing system messages — turn_start is the right event for the latter.

func (HooksOutput) ElementType

func (HooksOutput) ElementType() reflect.Type

func (HooksOutput) Extra

func (o HooksOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (HooksOutput) Notification

func (o HooksOutput) Notification() HookDefinitionArrayOutput

Hooks that run when the agent sends a notification (error, warning) to the user. Can send external notifications or log events.

func (HooksOutput) OnAgentSwitch

func (o HooksOutput) OnAgentSwitch() HookDefinitionArrayOutput

Hooks that run whenever the runtime moves the active agent to a new one (transfer_task, handoff, or the return after a transferred task completes). Receives from_agent, to_agent, and agent_switch_kind in the input. Observational; useful for audit, transcript, and metrics pipelines that track which agent ran which tools.

func (HooksOutput) OnError

Hooks that run when the runtime hits an error during a turn (model failures, repetitive tool-call loops). Fires alongside notification (level=error); use this for structured error-only handlers without parsing notification_level.

func (HooksOutput) OnMaxIterations

func (o HooksOutput) OnMaxIterations() HookDefinitionArrayOutput

Hooks that run when the runtime reaches its configured max_iterations limit. Fires alongside notification (level=warning); use this for structured handlers (e.g. log to a metrics pipeline) without parsing notification_message.

func (HooksOutput) OnSessionResume

func (o HooksOutput) OnSessionResume() HookDefinitionArrayOutput

Hooks that run when the user explicitly approves the runtime to continue past its configured max_iterations limit. Receives previous_max_iterations and new_max_iterations in the input. Observational; useful for alerting on extended-runtime sessions or for billing/quota pipelines that meter resumes.

func (HooksOutput) OnToolApprovalDecision

func (o HooksOutput) OnToolApprovalDecision() HookDefinitionArrayOutput

Hooks that run after the runtime's tool approval chain (custom rules / safety mode / hooks / ask) resolves a verdict for a tool call, before the call is executed (allow) or its error response is recorded (deny / canceled). Receives approval_decision ("allow" | "deny" | "canceled"), approval_source (a stable classifier of which step decided), and safety_label (the runtime classifier's safe / destructive / unknown verdict). Observational; gives audit pipelines a single "who approved what" record without re-implementing the chain.

func (HooksOutput) OnUserInput

func (o HooksOutput) OnUserInput() HookDefinitionArrayOutput

Hooks that run when the agent needs user input. Can send notifications or log events.

func (HooksOutput) PermissionRequest

func (o HooksOutput) PermissionRequest() HookMatcherArrayOutput

Hooks that run just before the runtime prompts the user to approve a tool call (i.e. when the safety mode and permission rules did not short-circuit the decision). Hooks may auto-allow or auto-deny via hook_specific_output.permission_decision; otherwise control falls through to the interactive confirmation. Tool-matched, like pre_tool_use.

func (HooksOutput) PostToolUse

func (o HooksOutput) PostToolUse() HookMatcherArrayOutput

Hooks that run after a tool completes (both success and failure). The result is delivered in tool_response (failed calls carry an is_error flag and any error text). Returning decision=block or exit code 2 stops the run loop after the current tool batch — useful for circuit-breaker patterns.

func (HooksOutput) PreCompact

func (o HooksOutput) PreCompact() HookDefinitionArrayOutput

Hooks that run just before the runtime compacts the session transcript into a summary. The trigger is reported in source: 'manual' (user-initiated /compact), 'auto' (proactive threshold), 'overflow' (context-overflow recovery), or 'tool_overflow' (proactive after tool results pushed past the threshold). Hooks may block compaction (decision=block / continue=false / exit code 2) or contribute additional_context that is appended to the compaction prompt — useful for steering the summary without modifying the agent's instruction.

func (HooksOutput) PreToolUse

func (o HooksOutput) PreToolUse() HookMatcherArrayOutput

Hooks that run before a tool is executed. Can allow/deny/modify tool calls.

func (HooksOutput) PromptFileGuard

func (o HooksOutput) PromptFileGuard() HookDefinitionArrayOutput

Checks loaded and retained prompt-file instructions before storage or use. Every hook must explicitly approve; failures stop the turn in every safety mode.

func (HooksOutput) SessionEnd

func (o HooksOutput) SessionEnd() HookDefinitionArrayOutput

Hooks that run when a session ends. Can perform cleanup or logging.

func (HooksOutput) SessionStart

func (o HooksOutput) SessionStart() HookDefinitionArrayOutput

Hooks that run when a session begins. Can load context or setup environment.

func (HooksOutput) SkillContentGuard

func (o HooksOutput) SkillContentGuard() HookDefinitionArrayOutput

Checks raw skill text before expansion or delivery. Every hook must explicitly approve; denials and failures reject the load in every safety mode.

func (HooksOutput) Stop

Hooks that run when the model finishes responding and is about to hand control back to the user. Can perform post-response validation or logging.

func (HooksOutput) SubagentStop

func (o HooksOutput) SubagentStop() HookDefinitionArrayOutput

Hooks that run when a sub-agent (transferred task, background agent, skill sub-session) finishes. Fires against the parent agent's executor so handlers configured on the orchestrator see every child completion. The sub-agent's name is in agent_name and its final assistant message in stop_response.

func (HooksOutput) ToHooksOutput

func (o HooksOutput) ToHooksOutput() HooksOutput

func (HooksOutput) ToHooksOutputWithContext

func (o HooksOutput) ToHooksOutputWithContext(ctx context.Context) HooksOutput

func (HooksOutput) ToHooksPtrOutput

func (o HooksOutput) ToHooksPtrOutput() HooksPtrOutput

func (HooksOutput) ToHooksPtrOutputWithContext

func (o HooksOutput) ToHooksPtrOutputWithContext(ctx context.Context) HooksPtrOutput

func (HooksOutput) ToolGuard

func (o HooksOutput) ToolGuard() HookMatcherArrayOutput

Hooks that run after tool_input_transform and before the deterministic approval pipeline, so their verdict cannot be bypassed by any safety mode (including autonomous / --yolo) or permission allow-rule. Hooks run concurrently; hookSpecificOutput.permission_decision verdicts aggregate to the most restrictive (deny > ask > allow). deny rejects the call; ask forces the interactive prompt even when the session already allowed the tool; allow is advisory (the pipeline still runs). hookSpecificOutput.metadata is merged into the confirmation prompt. updated_input is ignored — use tool_input_transform to rewrite arguments. Hook execution failures fail closed (deny), like pre_tool_use. Tool-matched; preempt_yolo is rejected because the event always preempts approval.

func (HooksOutput) ToolInputTransform

func (o HooksOutput) ToolInputTransform() HookMatcherArrayOutput

Hooks that run before every tool call, ahead of the deterministic approval pipeline (safety mode, permission rules, --yolo) and of tool_guard. Hooks run sequentially, each seeing the preceding rewrite, and may patch tool arguments via hookSpecificOutput.updated_input exactly like pre_tool_use; the approval pipeline and every later hook see the rewritten arguments. Rewrite-only: verdicts belong on tool_guard. Failures follow the hook's on_error policy (default warn; block denies the call). The redact_secrets builtin's argument-scrubbing leg is auto-injected here. Tool-matched, like pre_tool_use; preempt_yolo is rejected because the event always preempts approval.

func (HooksOutput) ToolResponseTransform

func (o HooksOutput) ToolResponseTransform() HookMatcherArrayOutput

Hooks that fire between a tool's execution and the runtime's emission/record of the response, with the rewrite reaching event consumers, the persisted session, the post_tool_use hook input, and the next LLM call. A hook may rewrite the tool's textual output by setting hookSpecificOutput.updated_tool_response — the symmetric counterpart of pre_tool_use's updated_input, applied to tool RESULTS instead of tool ARGUMENTS. The redact_secrets builtin uses this event for the third leg of the redact_secrets feature; custom rewriters can also truncate excessive output, scrub PII, or normalise tool dialects. Tool-matched, like pre_tool_use / post_tool_use.

func (HooksOutput) TurnEnd

Hooks that run once per agent turn when the turn finishes — the symmetric counterpart of turn_start. Fires no matter why the turn ended: a normal stop, an error, a hook-driven shutdown, the loop detector, or context cancellation. The reason is reported via the hook input's reason field ('normal', 'continue', 'steered', 'error', 'canceled', 'hook_blocked', 'loop_detected'). Observational; output is ignored.

func (HooksOutput) TurnStart

func (o HooksOutput) TurnStart() HookDefinitionArrayOutput

Hooks that run at the start of every agent turn (each model call). Their AdditionalContext is appended as transient system messages for that turn only — it is NOT persisted to the session, so per-turn signals (date, prompt files) are recomputed every turn instead of bloating message history on every resume.

func (HooksOutput) UserFollowupSubmit

func (o HooksOutput) UserFollowupSubmit() HookDefinitionArrayOutput

Hooks that run each time the runtime dequeues a follow-up message at the end of a turn and starts a fresh turn for it. Follow-ups are user messages queued for end-of-turn processing (the FollowUp API / queue), distinct from mid-turn steering — the model sees them as fresh input. The follow-up text is passed in the prompt field. Like user_prompt_submit, hooks can block the run (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for the follow-up turn only — it is NOT persisted to the session.

func (HooksOutput) UserPromptSubmit

func (o HooksOutput) UserPromptSubmit() HookDefinitionArrayOutput

Hooks that run once per user message, after the user has submitted their prompt and before the first model call of the turn. The submitted text is passed in the prompt field. Hooks can block submission (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for that turn only. Sub-sessions (transferred tasks, background agents) do NOT fire this event because their kick-off message is synthesised by the runtime.

func (HooksOutput) UserSteeringMessagesSubmit

func (o HooksOutput) UserSteeringMessagesSubmit() HookDefinitionArrayOutput

Hooks that run each time the runtime drains the steering queue and appends the queued user messages to the session — messages the user submitted while the agent was already working (mid-turn, after the model stopped, or while idle before the first model call). The drained messages are passed in the steering_messages field. Like user_prompt_submit, hooks can block the run (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for the steered turn only — it is NOT persisted to the session.

func (HooksOutput) WorktreeCreate

func (o HooksOutput) WorktreeCreate() HookDefinitionArrayOutput

Hooks that run once, just after `docker agent run --worktree` creates a git worktree and before the session starts. They execute inside the new worktree (their working directory is the fresh checkout), and the worktree path, branch, and source repository root are passed in worktree_path / worktree_branch / worktree_source_dir. Use them to prepare the checkout: copy untracked files like .env, install dependencies, warm caches, before the agent begins. A hook may abort the run by blocking (decision=block / continue=false / exit code 2); stdout is surfaced as additional context. Dispatched from the CLI rather than the run loop because the worktree (and the working directory every downstream component captures) must be settled before the runtime and session exist.

type HooksPtrInput

type HooksPtrInput interface {
	pulumi.Input

	ToHooksPtrOutput() HooksPtrOutput
	ToHooksPtrOutputWithContext(context.Context) HooksPtrOutput
}

HooksPtrInput is an input type that accepts HooksArgs, HooksPtr and HooksPtrOutput values. You can construct a concrete instance of `HooksPtrInput` via:

        HooksArgs{...}

or:

        nil

func HooksPtr

func HooksPtr(v *HooksArgs) HooksPtrInput

type HooksPtrOutput

type HooksPtrOutput struct{ *pulumi.OutputState }

func (HooksPtrOutput) AfterAgentComplete

func (o HooksPtrOutput) AfterAgentComplete() HookDefinitionArrayOutput

Hooks that run once after an agent completes successfully (natural completion, accepted structured output, or a cached answer), before the run decides whether it is finished. A hook may return hookSpecificOutput.transition {action: route, agent} to continue the same conversation with another agent from routing.allowed_agents. Not fired on errors, cancellation, budget stops, iteration-limit pauses, or empty completions. At most one hook is allowed per agent; cannot be combined with force_handoff. Output is always validated strictly and failures block the run.

func (HooksPtrOutput) AfterCompaction

func (o HooksPtrOutput) AfterCompaction() HookDefinitionArrayOutput

Hooks that run after a successful compaction (a summary was applied to the session). Receives the final summary text in Input.summary alongside input_tokens, output_tokens, context_limit and compaction_reason. Purely observational — hook output is ignored.

func (HooksPtrOutput) AfterLlmCall

func (o HooksPtrOutput) AfterLlmCall() HookDefinitionArrayOutput

Hooks that run just after each successful model call, before the response is recorded into the session and tool calls are dispatched. Receives the assistant text content in stop_response. Failed calls fire on_error instead.

func (HooksPtrOutput) BeforeAgentRun

func (o HooksPtrOutput) BeforeAgentRun() HookDefinitionArrayOutput

Hooks that run once per agent activation, before the agent's model is selected or its response cache is consulted. A hook may return hookSpecificOutput.transition {action: route, agent} to replace the activation with another agent from the agent's routing.allowed_agents; the skipped agent never calls its model. Each destination has its own activation. At most one hook is allowed per agent after merging identical definitions; requires the agent's routing declaration. Output is always validated strictly and failures block the run; blocking beats any transition.

func (HooksPtrOutput) BeforeCompaction

func (o HooksPtrOutput) BeforeCompaction() HookDefinitionArrayOutput

Hooks that run immediately before a session compaction. The Input carries input_tokens, output_tokens, context_limit, and compaction_reason ('threshold', 'overflow', 'manual'). A hook may veto compaction by setting decision='block' (or exiting with code 2), or supply a custom summary via hookSpecificOutput.summary, in which case the runtime applies that summary verbatim and skips the LLM-based summarization. Be cautious about denying when compaction_reason='overflow': the runtime is recovering from a context-overflow error and a denial there will leave the session unable to make progress.

func (HooksPtrOutput) BeforeLlmCall

func (o HooksPtrOutput) BeforeLlmCall() HookDefinitionArrayOutput

Hooks that run just before each model call (after turn_start has assembled the messages). Use for observability, cost guardrails, or auditing without contributing system messages — turn_start is the right event for the latter.

func (HooksPtrOutput) Elem

func (o HooksPtrOutput) Elem() HooksOutput

func (HooksPtrOutput) ElementType

func (HooksPtrOutput) ElementType() reflect.Type

func (HooksPtrOutput) Extra

func (o HooksPtrOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (HooksPtrOutput) Notification

func (o HooksPtrOutput) Notification() HookDefinitionArrayOutput

Hooks that run when the agent sends a notification (error, warning) to the user. Can send external notifications or log events.

func (HooksPtrOutput) OnAgentSwitch

func (o HooksPtrOutput) OnAgentSwitch() HookDefinitionArrayOutput

Hooks that run whenever the runtime moves the active agent to a new one (transfer_task, handoff, or the return after a transferred task completes). Receives from_agent, to_agent, and agent_switch_kind in the input. Observational; useful for audit, transcript, and metrics pipelines that track which agent ran which tools.

func (HooksPtrOutput) OnError

Hooks that run when the runtime hits an error during a turn (model failures, repetitive tool-call loops). Fires alongside notification (level=error); use this for structured error-only handlers without parsing notification_level.

func (HooksPtrOutput) OnMaxIterations

func (o HooksPtrOutput) OnMaxIterations() HookDefinitionArrayOutput

Hooks that run when the runtime reaches its configured max_iterations limit. Fires alongside notification (level=warning); use this for structured handlers (e.g. log to a metrics pipeline) without parsing notification_message.

func (HooksPtrOutput) OnSessionResume

func (o HooksPtrOutput) OnSessionResume() HookDefinitionArrayOutput

Hooks that run when the user explicitly approves the runtime to continue past its configured max_iterations limit. Receives previous_max_iterations and new_max_iterations in the input. Observational; useful for alerting on extended-runtime sessions or for billing/quota pipelines that meter resumes.

func (HooksPtrOutput) OnToolApprovalDecision

func (o HooksPtrOutput) OnToolApprovalDecision() HookDefinitionArrayOutput

Hooks that run after the runtime's tool approval chain (custom rules / safety mode / hooks / ask) resolves a verdict for a tool call, before the call is executed (allow) or its error response is recorded (deny / canceled). Receives approval_decision ("allow" | "deny" | "canceled"), approval_source (a stable classifier of which step decided), and safety_label (the runtime classifier's safe / destructive / unknown verdict). Observational; gives audit pipelines a single "who approved what" record without re-implementing the chain.

func (HooksPtrOutput) OnUserInput

func (o HooksPtrOutput) OnUserInput() HookDefinitionArrayOutput

Hooks that run when the agent needs user input. Can send notifications or log events.

func (HooksPtrOutput) PermissionRequest

func (o HooksPtrOutput) PermissionRequest() HookMatcherArrayOutput

Hooks that run just before the runtime prompts the user to approve a tool call (i.e. when the safety mode and permission rules did not short-circuit the decision). Hooks may auto-allow or auto-deny via hook_specific_output.permission_decision; otherwise control falls through to the interactive confirmation. Tool-matched, like pre_tool_use.

func (HooksPtrOutput) PostToolUse

func (o HooksPtrOutput) PostToolUse() HookMatcherArrayOutput

Hooks that run after a tool completes (both success and failure). The result is delivered in tool_response (failed calls carry an is_error flag and any error text). Returning decision=block or exit code 2 stops the run loop after the current tool batch — useful for circuit-breaker patterns.

func (HooksPtrOutput) PreCompact

Hooks that run just before the runtime compacts the session transcript into a summary. The trigger is reported in source: 'manual' (user-initiated /compact), 'auto' (proactive threshold), 'overflow' (context-overflow recovery), or 'tool_overflow' (proactive after tool results pushed past the threshold). Hooks may block compaction (decision=block / continue=false / exit code 2) or contribute additional_context that is appended to the compaction prompt — useful for steering the summary without modifying the agent's instruction.

func (HooksPtrOutput) PreToolUse

func (o HooksPtrOutput) PreToolUse() HookMatcherArrayOutput

Hooks that run before a tool is executed. Can allow/deny/modify tool calls.

func (HooksPtrOutput) PromptFileGuard

func (o HooksPtrOutput) PromptFileGuard() HookDefinitionArrayOutput

Checks loaded and retained prompt-file instructions before storage or use. Every hook must explicitly approve; failures stop the turn in every safety mode.

func (HooksPtrOutput) SessionEnd

Hooks that run when a session ends. Can perform cleanup or logging.

func (HooksPtrOutput) SessionStart

func (o HooksPtrOutput) SessionStart() HookDefinitionArrayOutput

Hooks that run when a session begins. Can load context or setup environment.

func (HooksPtrOutput) SkillContentGuard

func (o HooksPtrOutput) SkillContentGuard() HookDefinitionArrayOutput

Checks raw skill text before expansion or delivery. Every hook must explicitly approve; denials and failures reject the load in every safety mode.

func (HooksPtrOutput) Stop

Hooks that run when the model finishes responding and is about to hand control back to the user. Can perform post-response validation or logging.

func (HooksPtrOutput) SubagentStop

func (o HooksPtrOutput) SubagentStop() HookDefinitionArrayOutput

Hooks that run when a sub-agent (transferred task, background agent, skill sub-session) finishes. Fires against the parent agent's executor so handlers configured on the orchestrator see every child completion. The sub-agent's name is in agent_name and its final assistant message in stop_response.

func (HooksPtrOutput) ToHooksPtrOutput

func (o HooksPtrOutput) ToHooksPtrOutput() HooksPtrOutput

func (HooksPtrOutput) ToHooksPtrOutputWithContext

func (o HooksPtrOutput) ToHooksPtrOutputWithContext(ctx context.Context) HooksPtrOutput

func (HooksPtrOutput) ToolGuard

func (o HooksPtrOutput) ToolGuard() HookMatcherArrayOutput

Hooks that run after tool_input_transform and before the deterministic approval pipeline, so their verdict cannot be bypassed by any safety mode (including autonomous / --yolo) or permission allow-rule. Hooks run concurrently; hookSpecificOutput.permission_decision verdicts aggregate to the most restrictive (deny > ask > allow). deny rejects the call; ask forces the interactive prompt even when the session already allowed the tool; allow is advisory (the pipeline still runs). hookSpecificOutput.metadata is merged into the confirmation prompt. updated_input is ignored — use tool_input_transform to rewrite arguments. Hook execution failures fail closed (deny), like pre_tool_use. Tool-matched; preempt_yolo is rejected because the event always preempts approval.

func (HooksPtrOutput) ToolInputTransform

func (o HooksPtrOutput) ToolInputTransform() HookMatcherArrayOutput

Hooks that run before every tool call, ahead of the deterministic approval pipeline (safety mode, permission rules, --yolo) and of tool_guard. Hooks run sequentially, each seeing the preceding rewrite, and may patch tool arguments via hookSpecificOutput.updated_input exactly like pre_tool_use; the approval pipeline and every later hook see the rewritten arguments. Rewrite-only: verdicts belong on tool_guard. Failures follow the hook's on_error policy (default warn; block denies the call). The redact_secrets builtin's argument-scrubbing leg is auto-injected here. Tool-matched, like pre_tool_use; preempt_yolo is rejected because the event always preempts approval.

func (HooksPtrOutput) ToolResponseTransform

func (o HooksPtrOutput) ToolResponseTransform() HookMatcherArrayOutput

Hooks that fire between a tool's execution and the runtime's emission/record of the response, with the rewrite reaching event consumers, the persisted session, the post_tool_use hook input, and the next LLM call. A hook may rewrite the tool's textual output by setting hookSpecificOutput.updated_tool_response — the symmetric counterpart of pre_tool_use's updated_input, applied to tool RESULTS instead of tool ARGUMENTS. The redact_secrets builtin uses this event for the third leg of the redact_secrets feature; custom rewriters can also truncate excessive output, scrub PII, or normalise tool dialects. Tool-matched, like pre_tool_use / post_tool_use.

func (HooksPtrOutput) TurnEnd

Hooks that run once per agent turn when the turn finishes — the symmetric counterpart of turn_start. Fires no matter why the turn ended: a normal stop, an error, a hook-driven shutdown, the loop detector, or context cancellation. The reason is reported via the hook input's reason field ('normal', 'continue', 'steered', 'error', 'canceled', 'hook_blocked', 'loop_detected'). Observational; output is ignored.

func (HooksPtrOutput) TurnStart

Hooks that run at the start of every agent turn (each model call). Their AdditionalContext is appended as transient system messages for that turn only — it is NOT persisted to the session, so per-turn signals (date, prompt files) are recomputed every turn instead of bloating message history on every resume.

func (HooksPtrOutput) UserFollowupSubmit

func (o HooksPtrOutput) UserFollowupSubmit() HookDefinitionArrayOutput

Hooks that run each time the runtime dequeues a follow-up message at the end of a turn and starts a fresh turn for it. Follow-ups are user messages queued for end-of-turn processing (the FollowUp API / queue), distinct from mid-turn steering — the model sees them as fresh input. The follow-up text is passed in the prompt field. Like user_prompt_submit, hooks can block the run (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for the follow-up turn only — it is NOT persisted to the session.

func (HooksPtrOutput) UserPromptSubmit

func (o HooksPtrOutput) UserPromptSubmit() HookDefinitionArrayOutput

Hooks that run once per user message, after the user has submitted their prompt and before the first model call of the turn. The submitted text is passed in the prompt field. Hooks can block submission (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for that turn only. Sub-sessions (transferred tasks, background agents) do NOT fire this event because their kick-off message is synthesised by the runtime.

func (HooksPtrOutput) UserSteeringMessagesSubmit

func (o HooksPtrOutput) UserSteeringMessagesSubmit() HookDefinitionArrayOutput

Hooks that run each time the runtime drains the steering queue and appends the queued user messages to the session — messages the user submitted while the agent was already working (mid-turn, after the model stopped, or while idle before the first model call). The drained messages are passed in the steering_messages field. Like user_prompt_submit, hooks can block the run (decision=block / continue=false / exit code 2) or contribute additional_context that is spliced into the conversation as a transient system message for the steered turn only — it is NOT persisted to the session.

func (HooksPtrOutput) WorktreeCreate

func (o HooksPtrOutput) WorktreeCreate() HookDefinitionArrayOutput

Hooks that run once, just after `docker agent run --worktree` creates a git worktree and before the session starts. They execute inside the new worktree (their working directory is the fresh checkout), and the worktree path, branch, and source repository root are passed in worktree_path / worktree_branch / worktree_source_dir. Use them to prepare the checkout: copy untracked files like .env, install dependencies, warm caches, before the agent begins. A hook may abort the run by blocking (decision=block / continue=false / exit code 2); stdout is surfaced as additional context. Dispatched from the CLI rather than the run loop because the worktree (and the working directory every downstream component captures) must be settled before the runtime and session exist.

type HttpMethod

type HttpMethod string

func (HttpMethod) ElementType

func (HttpMethod) ElementType() reflect.Type

func (HttpMethod) ToHttpMethodOutput

func (e HttpMethod) ToHttpMethodOutput() HttpMethodOutput

func (HttpMethod) ToHttpMethodOutputWithContext

func (e HttpMethod) ToHttpMethodOutputWithContext(ctx context.Context) HttpMethodOutput

func (HttpMethod) ToHttpMethodPtrOutput

func (e HttpMethod) ToHttpMethodPtrOutput() HttpMethodPtrOutput

func (HttpMethod) ToHttpMethodPtrOutputWithContext

func (e HttpMethod) ToHttpMethodPtrOutputWithContext(ctx context.Context) HttpMethodPtrOutput

func (HttpMethod) ToStringOutput

func (e HttpMethod) ToStringOutput() pulumi.StringOutput

func (HttpMethod) ToStringOutputWithContext

func (e HttpMethod) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HttpMethod) ToStringPtrOutput

func (e HttpMethod) ToStringPtrOutput() pulumi.StringPtrOutput

func (HttpMethod) ToStringPtrOutputWithContext

func (e HttpMethod) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HttpMethodInput

type HttpMethodInput interface {
	pulumi.Input

	ToHttpMethodOutput() HttpMethodOutput
	ToHttpMethodOutputWithContext(context.Context) HttpMethodOutput
}

HttpMethodInput is an input type that accepts values of the HttpMethod enum A concrete instance of `HttpMethodInput` can be one of the following:

HttpMethodGet
HttpMethodPost
HttpMethodPut
HttpMethodPatch
HttpMethodDelete

type HttpMethodOutput

type HttpMethodOutput struct{ *pulumi.OutputState }

func (HttpMethodOutput) ElementType

func (HttpMethodOutput) ElementType() reflect.Type

func (HttpMethodOutput) ToHttpMethodOutput

func (o HttpMethodOutput) ToHttpMethodOutput() HttpMethodOutput

func (HttpMethodOutput) ToHttpMethodOutputWithContext

func (o HttpMethodOutput) ToHttpMethodOutputWithContext(ctx context.Context) HttpMethodOutput

func (HttpMethodOutput) ToHttpMethodPtrOutput

func (o HttpMethodOutput) ToHttpMethodPtrOutput() HttpMethodPtrOutput

func (HttpMethodOutput) ToHttpMethodPtrOutputWithContext

func (o HttpMethodOutput) ToHttpMethodPtrOutputWithContext(ctx context.Context) HttpMethodPtrOutput

func (HttpMethodOutput) ToStringOutput

func (o HttpMethodOutput) ToStringOutput() pulumi.StringOutput

func (HttpMethodOutput) ToStringOutputWithContext

func (o HttpMethodOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (HttpMethodOutput) ToStringPtrOutput

func (o HttpMethodOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HttpMethodOutput) ToStringPtrOutputWithContext

func (o HttpMethodOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type HttpMethodPtrInput

type HttpMethodPtrInput interface {
	pulumi.Input

	ToHttpMethodPtrOutput() HttpMethodPtrOutput
	ToHttpMethodPtrOutputWithContext(context.Context) HttpMethodPtrOutput
}

func HttpMethodPtr

func HttpMethodPtr(v string) HttpMethodPtrInput

type HttpMethodPtrOutput

type HttpMethodPtrOutput struct{ *pulumi.OutputState }

func (HttpMethodPtrOutput) Elem

func (HttpMethodPtrOutput) ElementType

func (HttpMethodPtrOutput) ElementType() reflect.Type

func (HttpMethodPtrOutput) ToHttpMethodPtrOutput

func (o HttpMethodPtrOutput) ToHttpMethodPtrOutput() HttpMethodPtrOutput

func (HttpMethodPtrOutput) ToHttpMethodPtrOutputWithContext

func (o HttpMethodPtrOutput) ToHttpMethodPtrOutputWithContext(ctx context.Context) HttpMethodPtrOutput

func (HttpMethodPtrOutput) ToStringPtrOutput

func (o HttpMethodPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (HttpMethodPtrOutput) ToStringPtrOutputWithContext

func (o HttpMethodPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type IdentityTokenSource

type IdentityTokenSource struct {
	// Subprocess to execute; stdout is used as the JWT. Re-run on every token exchange.
	Command []string `pulumi:"command"`
	// Name of an environment variable holding the JWT.
	Env *string `pulumi:"env"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Path to a file containing the JWT. Re-read on every token exchange (suitable for K8s projected SA tokens, SPIFFE helpers, Vault sidecars).
	File *string `pulumi:"file"`
	// HTTP headers sent with the URL request. Values support ${VAR} expansion. Only valid with 'url'.
	Headers map[string]string `pulumi:"headers"`
	// When set, the URL response is parsed as JSON and this top-level field is used as the token. When empty, the entire (trimmed) response body is used. Only valid with 'url'.
	ResponseField *string `pulumi:"responseField"`
	// HTTP(S) endpoint to GET for the JWT. ${VAR} references in the URL are expanded against the runtime environment.
	Url *string `pulumi:"url"`
}

Source of the JWT identity token used for OIDC federation. Exactly one of file, env, command, or url must be set.

type IdentityTokenSourceArgs

type IdentityTokenSourceArgs struct {
	// Subprocess to execute; stdout is used as the JWT. Re-run on every token exchange.
	Command pulumi.StringArrayInput `pulumi:"command"`
	// Name of an environment variable holding the JWT.
	Env pulumi.StringPtrInput `pulumi:"env"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Path to a file containing the JWT. Re-read on every token exchange (suitable for K8s projected SA tokens, SPIFFE helpers, Vault sidecars).
	File pulumi.StringPtrInput `pulumi:"file"`
	// HTTP headers sent with the URL request. Values support ${VAR} expansion. Only valid with 'url'.
	Headers pulumi.StringMapInput `pulumi:"headers"`
	// When set, the URL response is parsed as JSON and this top-level field is used as the token. When empty, the entire (trimmed) response body is used. Only valid with 'url'.
	ResponseField pulumi.StringPtrInput `pulumi:"responseField"`
	// HTTP(S) endpoint to GET for the JWT. ${VAR} references in the URL are expanded against the runtime environment.
	Url pulumi.StringPtrInput `pulumi:"url"`
}

Source of the JWT identity token used for OIDC federation. Exactly one of file, env, command, or url must be set.

func (IdentityTokenSourceArgs) ElementType

func (IdentityTokenSourceArgs) ElementType() reflect.Type

func (IdentityTokenSourceArgs) ToIdentityTokenSourceOutput

func (i IdentityTokenSourceArgs) ToIdentityTokenSourceOutput() IdentityTokenSourceOutput

func (IdentityTokenSourceArgs) ToIdentityTokenSourceOutputWithContext

func (i IdentityTokenSourceArgs) ToIdentityTokenSourceOutputWithContext(ctx context.Context) IdentityTokenSourceOutput

func (IdentityTokenSourceArgs) ToIdentityTokenSourcePtrOutput

func (i IdentityTokenSourceArgs) ToIdentityTokenSourcePtrOutput() IdentityTokenSourcePtrOutput

func (IdentityTokenSourceArgs) ToIdentityTokenSourcePtrOutputWithContext

func (i IdentityTokenSourceArgs) ToIdentityTokenSourcePtrOutputWithContext(ctx context.Context) IdentityTokenSourcePtrOutput

type IdentityTokenSourceInput

type IdentityTokenSourceInput interface {
	pulumi.Input

	ToIdentityTokenSourceOutput() IdentityTokenSourceOutput
	ToIdentityTokenSourceOutputWithContext(context.Context) IdentityTokenSourceOutput
}

IdentityTokenSourceInput is an input type that accepts IdentityTokenSourceArgs and IdentityTokenSourceOutput values. You can construct a concrete instance of `IdentityTokenSourceInput` via:

IdentityTokenSourceArgs{...}

type IdentityTokenSourceOutput

type IdentityTokenSourceOutput struct{ *pulumi.OutputState }

Source of the JWT identity token used for OIDC federation. Exactly one of file, env, command, or url must be set.

func (IdentityTokenSourceOutput) Command

Subprocess to execute; stdout is used as the JWT. Re-run on every token exchange.

func (IdentityTokenSourceOutput) ElementType

func (IdentityTokenSourceOutput) ElementType() reflect.Type

func (IdentityTokenSourceOutput) Env

Name of an environment variable holding the JWT.

func (IdentityTokenSourceOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (IdentityTokenSourceOutput) File

Path to a file containing the JWT. Re-read on every token exchange (suitable for K8s projected SA tokens, SPIFFE helpers, Vault sidecars).

func (IdentityTokenSourceOutput) Headers

HTTP headers sent with the URL request. Values support ${VAR} expansion. Only valid with 'url'.

func (IdentityTokenSourceOutput) ResponseField

When set, the URL response is parsed as JSON and this top-level field is used as the token. When empty, the entire (trimmed) response body is used. Only valid with 'url'.

func (IdentityTokenSourceOutput) ToIdentityTokenSourceOutput

func (o IdentityTokenSourceOutput) ToIdentityTokenSourceOutput() IdentityTokenSourceOutput

func (IdentityTokenSourceOutput) ToIdentityTokenSourceOutputWithContext

func (o IdentityTokenSourceOutput) ToIdentityTokenSourceOutputWithContext(ctx context.Context) IdentityTokenSourceOutput

func (IdentityTokenSourceOutput) ToIdentityTokenSourcePtrOutput

func (o IdentityTokenSourceOutput) ToIdentityTokenSourcePtrOutput() IdentityTokenSourcePtrOutput

func (IdentityTokenSourceOutput) ToIdentityTokenSourcePtrOutputWithContext

func (o IdentityTokenSourceOutput) ToIdentityTokenSourcePtrOutputWithContext(ctx context.Context) IdentityTokenSourcePtrOutput

func (IdentityTokenSourceOutput) Url

HTTP(S) endpoint to GET for the JWT. ${VAR} references in the URL are expanded against the runtime environment.

type IdentityTokenSourcePtrInput

type IdentityTokenSourcePtrInput interface {
	pulumi.Input

	ToIdentityTokenSourcePtrOutput() IdentityTokenSourcePtrOutput
	ToIdentityTokenSourcePtrOutputWithContext(context.Context) IdentityTokenSourcePtrOutput
}

IdentityTokenSourcePtrInput is an input type that accepts IdentityTokenSourceArgs, IdentityTokenSourcePtr and IdentityTokenSourcePtrOutput values. You can construct a concrete instance of `IdentityTokenSourcePtrInput` via:

        IdentityTokenSourceArgs{...}

or:

        nil

type IdentityTokenSourcePtrOutput

type IdentityTokenSourcePtrOutput struct{ *pulumi.OutputState }

func (IdentityTokenSourcePtrOutput) Command

Subprocess to execute; stdout is used as the JWT. Re-run on every token exchange.

func (IdentityTokenSourcePtrOutput) Elem

func (IdentityTokenSourcePtrOutput) ElementType

func (IdentityTokenSourcePtrOutput) Env

Name of an environment variable holding the JWT.

func (IdentityTokenSourcePtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (IdentityTokenSourcePtrOutput) File

Path to a file containing the JWT. Re-read on every token exchange (suitable for K8s projected SA tokens, SPIFFE helpers, Vault sidecars).

func (IdentityTokenSourcePtrOutput) Headers

HTTP headers sent with the URL request. Values support ${VAR} expansion. Only valid with 'url'.

func (IdentityTokenSourcePtrOutput) ResponseField

When set, the URL response is parsed as JSON and this top-level field is used as the token. When empty, the entire (trimmed) response body is used. Only valid with 'url'.

func (IdentityTokenSourcePtrOutput) ToIdentityTokenSourcePtrOutput

func (o IdentityTokenSourcePtrOutput) ToIdentityTokenSourcePtrOutput() IdentityTokenSourcePtrOutput

func (IdentityTokenSourcePtrOutput) ToIdentityTokenSourcePtrOutputWithContext

func (o IdentityTokenSourcePtrOutput) ToIdentityTokenSourcePtrOutputWithContext(ctx context.Context) IdentityTokenSourcePtrOutput

func (IdentityTokenSourcePtrOutput) Url

HTTP(S) endpoint to GET for the JWT. ${VAR} references in the URL are expanded against the runtime environment.

type InlineSkill

type InlineSkill struct {
	// Tools the skill expects to use (mirrors the SKILL.md allowed-tools field). For a fork-mode skill (context: fork) this is enforced as an allow-list over the parent agent's inherited tools while the skill runs in its sub-session: only tools whose names match an entry are kept (entries support glob patterns like 'read_*', otherwise an exact match). Ignored for non-fork skills.
	AllowedTools []string `pulumi:"allowedTools"`
	// When set to "fork", the skill runs as an isolated sub-agent (exposed via run_skill) instead of inlining into the conversation. Allowed values: `fork`.
	Context *string `pulumi:"context"`
	// Short description injected into the system prompt so the model knows when the skill applies.
	Description string `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// The skill body (equivalent to the Markdown content below the SKILL.md frontmatter).
	Instructions string `pulumi:"instructions"`
	// Optional model override applied while a fork-mode skill runs. Ignored for non-fork skills.
	Model *string `pulumi:"model"`
	// Skill identifier used by read_skill / run_skill and the /<name> slash command. Must not contain whitespace, which the slash command parser uses to separate the name from its argument.
	Name string `pulumi:"name"`
	// Names of reusable toolset definitions (from the top-level 'toolsets' section) to expose to this skill while it runs in its fork sub-session, in addition to the parent agent's tools. Only valid for fork-mode skills (context: fork).
	Toolsets []string `pulumi:"toolsets"`
}

A skill defined directly in the agent config instead of a SKILL.md file or remote URL. Supports the subset of the skill format that can be expressed in YAML.

type InlineSkillArgs

type InlineSkillArgs struct {
	// Tools the skill expects to use (mirrors the SKILL.md allowed-tools field). For a fork-mode skill (context: fork) this is enforced as an allow-list over the parent agent's inherited tools while the skill runs in its sub-session: only tools whose names match an entry are kept (entries support glob patterns like 'read_*', otherwise an exact match). Ignored for non-fork skills.
	AllowedTools pulumi.StringArrayInput `pulumi:"allowedTools"`
	// When set to "fork", the skill runs as an isolated sub-agent (exposed via run_skill) instead of inlining into the conversation. Allowed values: `fork`.
	Context pulumi.StringPtrInput `pulumi:"context"`
	// Short description injected into the system prompt so the model knows when the skill applies.
	Description pulumi.StringInput `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// The skill body (equivalent to the Markdown content below the SKILL.md frontmatter).
	Instructions pulumi.StringInput `pulumi:"instructions"`
	// Optional model override applied while a fork-mode skill runs. Ignored for non-fork skills.
	Model pulumi.StringPtrInput `pulumi:"model"`
	// Skill identifier used by read_skill / run_skill and the /<name> slash command. Must not contain whitespace, which the slash command parser uses to separate the name from its argument.
	Name pulumi.StringInput `pulumi:"name"`
	// Names of reusable toolset definitions (from the top-level 'toolsets' section) to expose to this skill while it runs in its fork sub-session, in addition to the parent agent's tools. Only valid for fork-mode skills (context: fork).
	Toolsets pulumi.StringArrayInput `pulumi:"toolsets"`
}

A skill defined directly in the agent config instead of a SKILL.md file or remote URL. Supports the subset of the skill format that can be expressed in YAML.

func (InlineSkillArgs) ElementType

func (InlineSkillArgs) ElementType() reflect.Type

func (InlineSkillArgs) ToInlineSkillOutput

func (i InlineSkillArgs) ToInlineSkillOutput() InlineSkillOutput

func (InlineSkillArgs) ToInlineSkillOutputWithContext

func (i InlineSkillArgs) ToInlineSkillOutputWithContext(ctx context.Context) InlineSkillOutput

type InlineSkillArray

type InlineSkillArray []InlineSkillInput

func (InlineSkillArray) ElementType

func (InlineSkillArray) ElementType() reflect.Type

func (InlineSkillArray) ToInlineSkillArrayOutput

func (i InlineSkillArray) ToInlineSkillArrayOutput() InlineSkillArrayOutput

func (InlineSkillArray) ToInlineSkillArrayOutputWithContext

func (i InlineSkillArray) ToInlineSkillArrayOutputWithContext(ctx context.Context) InlineSkillArrayOutput

type InlineSkillArrayInput

type InlineSkillArrayInput interface {
	pulumi.Input

	ToInlineSkillArrayOutput() InlineSkillArrayOutput
	ToInlineSkillArrayOutputWithContext(context.Context) InlineSkillArrayOutput
}

InlineSkillArrayInput is an input type that accepts InlineSkillArray and InlineSkillArrayOutput values. You can construct a concrete instance of `InlineSkillArrayInput` via:

InlineSkillArray{ InlineSkillArgs{...} }

type InlineSkillArrayOutput

type InlineSkillArrayOutput struct{ *pulumi.OutputState }

func (InlineSkillArrayOutput) ElementType

func (InlineSkillArrayOutput) ElementType() reflect.Type

func (InlineSkillArrayOutput) Index

func (InlineSkillArrayOutput) ToInlineSkillArrayOutput

func (o InlineSkillArrayOutput) ToInlineSkillArrayOutput() InlineSkillArrayOutput

func (InlineSkillArrayOutput) ToInlineSkillArrayOutputWithContext

func (o InlineSkillArrayOutput) ToInlineSkillArrayOutputWithContext(ctx context.Context) InlineSkillArrayOutput

type InlineSkillInput

type InlineSkillInput interface {
	pulumi.Input

	ToInlineSkillOutput() InlineSkillOutput
	ToInlineSkillOutputWithContext(context.Context) InlineSkillOutput
}

InlineSkillInput is an input type that accepts InlineSkillArgs and InlineSkillOutput values. You can construct a concrete instance of `InlineSkillInput` via:

InlineSkillArgs{...}

type InlineSkillOutput

type InlineSkillOutput struct{ *pulumi.OutputState }

A skill defined directly in the agent config instead of a SKILL.md file or remote URL. Supports the subset of the skill format that can be expressed in YAML.

func (InlineSkillOutput) AllowedTools

func (o InlineSkillOutput) AllowedTools() pulumi.StringArrayOutput

Tools the skill expects to use (mirrors the SKILL.md allowed-tools field). For a fork-mode skill (context: fork) this is enforced as an allow-list over the parent agent's inherited tools while the skill runs in its sub-session: only tools whose names match an entry are kept (entries support glob patterns like 'read_*', otherwise an exact match). Ignored for non-fork skills.

func (InlineSkillOutput) Context

When set to "fork", the skill runs as an isolated sub-agent (exposed via run_skill) instead of inlining into the conversation. Allowed values: `fork`.

func (InlineSkillOutput) Description

func (o InlineSkillOutput) Description() pulumi.StringOutput

Short description injected into the system prompt so the model knows when the skill applies.

func (InlineSkillOutput) ElementType

func (InlineSkillOutput) ElementType() reflect.Type

func (InlineSkillOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (InlineSkillOutput) Instructions

func (o InlineSkillOutput) Instructions() pulumi.StringOutput

The skill body (equivalent to the Markdown content below the SKILL.md frontmatter).

func (InlineSkillOutput) Model

Optional model override applied while a fork-mode skill runs. Ignored for non-fork skills.

func (InlineSkillOutput) Name

Skill identifier used by read_skill / run_skill and the /<name> slash command. Must not contain whitespace, which the slash command parser uses to separate the name from its argument.

func (InlineSkillOutput) ToInlineSkillOutput

func (o InlineSkillOutput) ToInlineSkillOutput() InlineSkillOutput

func (InlineSkillOutput) ToInlineSkillOutputWithContext

func (o InlineSkillOutput) ToInlineSkillOutputWithContext(ctx context.Context) InlineSkillOutput

func (InlineSkillOutput) Toolsets

Names of reusable toolset definitions (from the top-level 'toolsets' section) to expose to this skill while it runs in its fork sub-session, in addition to the parent agent's tools. Only valid for fork-mode skills (context: fork).

type InterruptConfirmation

type InterruptConfirmation string

func (InterruptConfirmation) ElementType

func (InterruptConfirmation) ElementType() reflect.Type

func (InterruptConfirmation) ToInterruptConfirmationOutput

func (e InterruptConfirmation) ToInterruptConfirmationOutput() InterruptConfirmationOutput

func (InterruptConfirmation) ToInterruptConfirmationOutputWithContext

func (e InterruptConfirmation) ToInterruptConfirmationOutputWithContext(ctx context.Context) InterruptConfirmationOutput

func (InterruptConfirmation) ToInterruptConfirmationPtrOutput

func (e InterruptConfirmation) ToInterruptConfirmationPtrOutput() InterruptConfirmationPtrOutput

func (InterruptConfirmation) ToInterruptConfirmationPtrOutputWithContext

func (e InterruptConfirmation) ToInterruptConfirmationPtrOutputWithContext(ctx context.Context) InterruptConfirmationPtrOutput

func (InterruptConfirmation) ToStringOutput

func (e InterruptConfirmation) ToStringOutput() pulumi.StringOutput

func (InterruptConfirmation) ToStringOutputWithContext

func (e InterruptConfirmation) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (InterruptConfirmation) ToStringPtrOutput

func (e InterruptConfirmation) ToStringPtrOutput() pulumi.StringPtrOutput

func (InterruptConfirmation) ToStringPtrOutputWithContext

func (e InterruptConfirmation) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type InterruptConfirmationInput

type InterruptConfirmationInput interface {
	pulumi.Input

	ToInterruptConfirmationOutput() InterruptConfirmationOutput
	ToInterruptConfirmationOutputWithContext(context.Context) InterruptConfirmationOutput
}

InterruptConfirmationInput is an input type that accepts values of the InterruptConfirmation enum A concrete instance of `InterruptConfirmationInput` can be one of the following:

InterruptConfirmationAlways
InterruptConfirmationDoubleTap
InterruptConfirmationNone

type InterruptConfirmationOutput

type InterruptConfirmationOutput struct{ *pulumi.OutputState }

func (InterruptConfirmationOutput) ElementType

func (InterruptConfirmationOutput) ToInterruptConfirmationOutput

func (o InterruptConfirmationOutput) ToInterruptConfirmationOutput() InterruptConfirmationOutput

func (InterruptConfirmationOutput) ToInterruptConfirmationOutputWithContext

func (o InterruptConfirmationOutput) ToInterruptConfirmationOutputWithContext(ctx context.Context) InterruptConfirmationOutput

func (InterruptConfirmationOutput) ToInterruptConfirmationPtrOutput

func (o InterruptConfirmationOutput) ToInterruptConfirmationPtrOutput() InterruptConfirmationPtrOutput

func (InterruptConfirmationOutput) ToInterruptConfirmationPtrOutputWithContext

func (o InterruptConfirmationOutput) ToInterruptConfirmationPtrOutputWithContext(ctx context.Context) InterruptConfirmationPtrOutput

func (InterruptConfirmationOutput) ToStringOutput

func (o InterruptConfirmationOutput) ToStringOutput() pulumi.StringOutput

func (InterruptConfirmationOutput) ToStringOutputWithContext

func (o InterruptConfirmationOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (InterruptConfirmationOutput) ToStringPtrOutput

func (o InterruptConfirmationOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (InterruptConfirmationOutput) ToStringPtrOutputWithContext

func (o InterruptConfirmationOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type InterruptConfirmationPtrInput

type InterruptConfirmationPtrInput interface {
	pulumi.Input

	ToInterruptConfirmationPtrOutput() InterruptConfirmationPtrOutput
	ToInterruptConfirmationPtrOutputWithContext(context.Context) InterruptConfirmationPtrOutput
}

func InterruptConfirmationPtr

func InterruptConfirmationPtr(v string) InterruptConfirmationPtrInput

type InterruptConfirmationPtrOutput

type InterruptConfirmationPtrOutput struct{ *pulumi.OutputState }

func (InterruptConfirmationPtrOutput) Elem

func (InterruptConfirmationPtrOutput) ElementType

func (InterruptConfirmationPtrOutput) ToInterruptConfirmationPtrOutput

func (o InterruptConfirmationPtrOutput) ToInterruptConfirmationPtrOutput() InterruptConfirmationPtrOutput

func (InterruptConfirmationPtrOutput) ToInterruptConfirmationPtrOutputWithContext

func (o InterruptConfirmationPtrOutput) ToInterruptConfirmationPtrOutputWithContext(ctx context.Context) InterruptConfirmationPtrOutput

func (InterruptConfirmationPtrOutput) ToStringPtrOutput

func (InterruptConfirmationPtrOutput) ToStringPtrOutputWithContext

func (o InterruptConfirmationPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type Lifecycle

type Lifecycle struct {
	// Exponential backoff between restart attempts.
	Backoff *LifecycleBackoff `pulumi:"backoff"`
	// Cap on an individual tool call, including one reconnect-retry. Enforced: on expiry the call is cancelled and surfaced to the model as a tool error; cancellation is propagated to the server. The budget includes any nested sampling/elicitation time. Go duration format (e.g. '30s', '2m'). 0/unset means no timeout (opt-in; no profile default).
	CallTimeout *string `pulumi:"callTimeout"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Maximum number of consecutive restart attempts after a disconnect. 0 = use profile default (5). -1 = unlimited.
	MaxRestarts *int `pulumi:"maxRestarts"`
	// Shorthand that picks defaults for all the other fields. 'resilient' (default): auto-restart on failure with exponential backoff. 'strict': fail fast — the agent refuses to start when the toolset is unavailable. 'best-effort': single attempt, no auto-restart.
	Profile *LifecycleProfile `pulumi:"profile"`
	// Marks the toolset as critical to the agent. NOTE: not yet enforced — a planned eager-startup phase will refuse to start the agent when a required toolset cannot reach Ready within startup_timeout. Defaults to true under the 'strict' profile, false otherwise.
	Required *bool `pulumi:"required"`
	// How the supervisor reacts to an unexpected disconnect.
	Restart *RestartPolicy `pulumi:"restart"`
	// Cap on the initial Connect+initialize duration. Enforced since v1.94.0: on expiry the toolset stays stopped and the runtime retries on the next turn. Go duration format (e.g. '30s', '2m'). 0 means no timeout.
	StartupTimeout *string `pulumi:"startupTimeout"`
}

Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.

type LifecycleArgs

type LifecycleArgs struct {
	// Exponential backoff between restart attempts.
	Backoff LifecycleBackoffPtrInput `pulumi:"backoff"`
	// Cap on an individual tool call, including one reconnect-retry. Enforced: on expiry the call is cancelled and surfaced to the model as a tool error; cancellation is propagated to the server. The budget includes any nested sampling/elicitation time. Go duration format (e.g. '30s', '2m'). 0/unset means no timeout (opt-in; no profile default).
	CallTimeout pulumi.StringPtrInput `pulumi:"callTimeout"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Maximum number of consecutive restart attempts after a disconnect. 0 = use profile default (5). -1 = unlimited.
	MaxRestarts pulumi.IntPtrInput `pulumi:"maxRestarts"`
	// Shorthand that picks defaults for all the other fields. 'resilient' (default): auto-restart on failure with exponential backoff. 'strict': fail fast — the agent refuses to start when the toolset is unavailable. 'best-effort': single attempt, no auto-restart.
	Profile LifecycleProfilePtrInput `pulumi:"profile"`
	// Marks the toolset as critical to the agent. NOTE: not yet enforced — a planned eager-startup phase will refuse to start the agent when a required toolset cannot reach Ready within startup_timeout. Defaults to true under the 'strict' profile, false otherwise.
	Required pulumi.BoolPtrInput `pulumi:"required"`
	// How the supervisor reacts to an unexpected disconnect.
	Restart RestartPolicyPtrInput `pulumi:"restart"`
	// Cap on the initial Connect+initialize duration. Enforced since v1.94.0: on expiry the toolset stays stopped and the runtime retries on the next turn. Go duration format (e.g. '30s', '2m'). 0 means no timeout.
	StartupTimeout pulumi.StringPtrInput `pulumi:"startupTimeout"`
}

Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.

func (LifecycleArgs) ElementType

func (LifecycleArgs) ElementType() reflect.Type

func (LifecycleArgs) ToLifecycleOutput

func (i LifecycleArgs) ToLifecycleOutput() LifecycleOutput

func (LifecycleArgs) ToLifecycleOutputWithContext

func (i LifecycleArgs) ToLifecycleOutputWithContext(ctx context.Context) LifecycleOutput

func (LifecycleArgs) ToLifecyclePtrOutput

func (i LifecycleArgs) ToLifecyclePtrOutput() LifecyclePtrOutput

func (LifecycleArgs) ToLifecyclePtrOutputWithContext

func (i LifecycleArgs) ToLifecyclePtrOutputWithContext(ctx context.Context) LifecyclePtrOutput

type LifecycleBackoff

type LifecycleBackoff struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// First wait between attempts (Go duration format, e.g. '1s'). Defaults to 1s.
	Initial *string `pulumi:"initial"`
	// Fraction of the computed delay applied as a uniform random offset. 0 disables (default).
	Jitter *float64 `pulumi:"jitter"`
	// Cap on the wait (Go duration format). Defaults to 32s.
	Max *string `pulumi:"max"`
	// Multiplier applied each attempt. Defaults to 2.
	Multiplier *float64 `pulumi:"multiplier"`
}

Exponential backoff between restart attempts.

type LifecycleBackoffArgs

type LifecycleBackoffArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// First wait between attempts (Go duration format, e.g. '1s'). Defaults to 1s.
	Initial pulumi.StringPtrInput `pulumi:"initial"`
	// Fraction of the computed delay applied as a uniform random offset. 0 disables (default).
	Jitter pulumi.Float64PtrInput `pulumi:"jitter"`
	// Cap on the wait (Go duration format). Defaults to 32s.
	Max pulumi.StringPtrInput `pulumi:"max"`
	// Multiplier applied each attempt. Defaults to 2.
	Multiplier pulumi.Float64PtrInput `pulumi:"multiplier"`
}

Exponential backoff between restart attempts.

func (LifecycleBackoffArgs) ElementType

func (LifecycleBackoffArgs) ElementType() reflect.Type

func (LifecycleBackoffArgs) ToLifecycleBackoffOutput

func (i LifecycleBackoffArgs) ToLifecycleBackoffOutput() LifecycleBackoffOutput

func (LifecycleBackoffArgs) ToLifecycleBackoffOutputWithContext

func (i LifecycleBackoffArgs) ToLifecycleBackoffOutputWithContext(ctx context.Context) LifecycleBackoffOutput

func (LifecycleBackoffArgs) ToLifecycleBackoffPtrOutput

func (i LifecycleBackoffArgs) ToLifecycleBackoffPtrOutput() LifecycleBackoffPtrOutput

func (LifecycleBackoffArgs) ToLifecycleBackoffPtrOutputWithContext

func (i LifecycleBackoffArgs) ToLifecycleBackoffPtrOutputWithContext(ctx context.Context) LifecycleBackoffPtrOutput

type LifecycleBackoffInput

type LifecycleBackoffInput interface {
	pulumi.Input

	ToLifecycleBackoffOutput() LifecycleBackoffOutput
	ToLifecycleBackoffOutputWithContext(context.Context) LifecycleBackoffOutput
}

LifecycleBackoffInput is an input type that accepts LifecycleBackoffArgs and LifecycleBackoffOutput values. You can construct a concrete instance of `LifecycleBackoffInput` via:

LifecycleBackoffArgs{...}

type LifecycleBackoffOutput

type LifecycleBackoffOutput struct{ *pulumi.OutputState }

Exponential backoff between restart attempts.

func (LifecycleBackoffOutput) ElementType

func (LifecycleBackoffOutput) ElementType() reflect.Type

func (LifecycleBackoffOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (LifecycleBackoffOutput) Initial

First wait between attempts (Go duration format, e.g. '1s'). Defaults to 1s.

func (LifecycleBackoffOutput) Jitter

Fraction of the computed delay applied as a uniform random offset. 0 disables (default).

func (LifecycleBackoffOutput) Max

Cap on the wait (Go duration format). Defaults to 32s.

func (LifecycleBackoffOutput) Multiplier

Multiplier applied each attempt. Defaults to 2.

func (LifecycleBackoffOutput) ToLifecycleBackoffOutput

func (o LifecycleBackoffOutput) ToLifecycleBackoffOutput() LifecycleBackoffOutput

func (LifecycleBackoffOutput) ToLifecycleBackoffOutputWithContext

func (o LifecycleBackoffOutput) ToLifecycleBackoffOutputWithContext(ctx context.Context) LifecycleBackoffOutput

func (LifecycleBackoffOutput) ToLifecycleBackoffPtrOutput

func (o LifecycleBackoffOutput) ToLifecycleBackoffPtrOutput() LifecycleBackoffPtrOutput

func (LifecycleBackoffOutput) ToLifecycleBackoffPtrOutputWithContext

func (o LifecycleBackoffOutput) ToLifecycleBackoffPtrOutputWithContext(ctx context.Context) LifecycleBackoffPtrOutput

type LifecycleBackoffPtrInput

type LifecycleBackoffPtrInput interface {
	pulumi.Input

	ToLifecycleBackoffPtrOutput() LifecycleBackoffPtrOutput
	ToLifecycleBackoffPtrOutputWithContext(context.Context) LifecycleBackoffPtrOutput
}

LifecycleBackoffPtrInput is an input type that accepts LifecycleBackoffArgs, LifecycleBackoffPtr and LifecycleBackoffPtrOutput values. You can construct a concrete instance of `LifecycleBackoffPtrInput` via:

        LifecycleBackoffArgs{...}

or:

        nil

type LifecycleBackoffPtrOutput

type LifecycleBackoffPtrOutput struct{ *pulumi.OutputState }

func (LifecycleBackoffPtrOutput) Elem

func (LifecycleBackoffPtrOutput) ElementType

func (LifecycleBackoffPtrOutput) ElementType() reflect.Type

func (LifecycleBackoffPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (LifecycleBackoffPtrOutput) Initial

First wait between attempts (Go duration format, e.g. '1s'). Defaults to 1s.

func (LifecycleBackoffPtrOutput) Jitter

Fraction of the computed delay applied as a uniform random offset. 0 disables (default).

func (LifecycleBackoffPtrOutput) Max

Cap on the wait (Go duration format). Defaults to 32s.

func (LifecycleBackoffPtrOutput) Multiplier

Multiplier applied each attempt. Defaults to 2.

func (LifecycleBackoffPtrOutput) ToLifecycleBackoffPtrOutput

func (o LifecycleBackoffPtrOutput) ToLifecycleBackoffPtrOutput() LifecycleBackoffPtrOutput

func (LifecycleBackoffPtrOutput) ToLifecycleBackoffPtrOutputWithContext

func (o LifecycleBackoffPtrOutput) ToLifecycleBackoffPtrOutputWithContext(ctx context.Context) LifecycleBackoffPtrOutput

type LifecycleInput

type LifecycleInput interface {
	pulumi.Input

	ToLifecycleOutput() LifecycleOutput
	ToLifecycleOutputWithContext(context.Context) LifecycleOutput
}

LifecycleInput is an input type that accepts LifecycleArgs and LifecycleOutput values. You can construct a concrete instance of `LifecycleInput` via:

LifecycleArgs{...}

type LifecycleOutput

type LifecycleOutput struct{ *pulumi.OutputState }

Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.

func (LifecycleOutput) Backoff

Exponential backoff between restart attempts.

func (LifecycleOutput) CallTimeout

func (o LifecycleOutput) CallTimeout() pulumi.StringPtrOutput

Cap on an individual tool call, including one reconnect-retry. Enforced: on expiry the call is cancelled and surfaced to the model as a tool error; cancellation is propagated to the server. The budget includes any nested sampling/elicitation time. Go duration format (e.g. '30s', '2m'). 0/unset means no timeout (opt-in; no profile default).

func (LifecycleOutput) ElementType

func (LifecycleOutput) ElementType() reflect.Type

func (LifecycleOutput) Extra

func (o LifecycleOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (LifecycleOutput) MaxRestarts

func (o LifecycleOutput) MaxRestarts() pulumi.IntPtrOutput

Maximum number of consecutive restart attempts after a disconnect. 0 = use profile default (5). -1 = unlimited.

func (LifecycleOutput) Profile

Shorthand that picks defaults for all the other fields. 'resilient' (default): auto-restart on failure with exponential backoff. 'strict': fail fast — the agent refuses to start when the toolset is unavailable. 'best-effort': single attempt, no auto-restart.

func (LifecycleOutput) Required

func (o LifecycleOutput) Required() pulumi.BoolPtrOutput

Marks the toolset as critical to the agent. NOTE: not yet enforced — a planned eager-startup phase will refuse to start the agent when a required toolset cannot reach Ready within startup_timeout. Defaults to true under the 'strict' profile, false otherwise.

func (LifecycleOutput) Restart

How the supervisor reacts to an unexpected disconnect.

func (LifecycleOutput) StartupTimeout

func (o LifecycleOutput) StartupTimeout() pulumi.StringPtrOutput

Cap on the initial Connect+initialize duration. Enforced since v1.94.0: on expiry the toolset stays stopped and the runtime retries on the next turn. Go duration format (e.g. '30s', '2m'). 0 means no timeout.

func (LifecycleOutput) ToLifecycleOutput

func (o LifecycleOutput) ToLifecycleOutput() LifecycleOutput

func (LifecycleOutput) ToLifecycleOutputWithContext

func (o LifecycleOutput) ToLifecycleOutputWithContext(ctx context.Context) LifecycleOutput

func (LifecycleOutput) ToLifecyclePtrOutput

func (o LifecycleOutput) ToLifecyclePtrOutput() LifecyclePtrOutput

func (LifecycleOutput) ToLifecyclePtrOutputWithContext

func (o LifecycleOutput) ToLifecyclePtrOutputWithContext(ctx context.Context) LifecyclePtrOutput

type LifecycleProfile

type LifecycleProfile string

func (LifecycleProfile) ElementType

func (LifecycleProfile) ElementType() reflect.Type

func (LifecycleProfile) ToLifecycleProfileOutput

func (e LifecycleProfile) ToLifecycleProfileOutput() LifecycleProfileOutput

func (LifecycleProfile) ToLifecycleProfileOutputWithContext

func (e LifecycleProfile) ToLifecycleProfileOutputWithContext(ctx context.Context) LifecycleProfileOutput

func (LifecycleProfile) ToLifecycleProfilePtrOutput

func (e LifecycleProfile) ToLifecycleProfilePtrOutput() LifecycleProfilePtrOutput

func (LifecycleProfile) ToLifecycleProfilePtrOutputWithContext

func (e LifecycleProfile) ToLifecycleProfilePtrOutputWithContext(ctx context.Context) LifecycleProfilePtrOutput

func (LifecycleProfile) ToStringOutput

func (e LifecycleProfile) ToStringOutput() pulumi.StringOutput

func (LifecycleProfile) ToStringOutputWithContext

func (e LifecycleProfile) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (LifecycleProfile) ToStringPtrOutput

func (e LifecycleProfile) ToStringPtrOutput() pulumi.StringPtrOutput

func (LifecycleProfile) ToStringPtrOutputWithContext

func (e LifecycleProfile) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LifecycleProfileInput

type LifecycleProfileInput interface {
	pulumi.Input

	ToLifecycleProfileOutput() LifecycleProfileOutput
	ToLifecycleProfileOutputWithContext(context.Context) LifecycleProfileOutput
}

LifecycleProfileInput is an input type that accepts values of the LifecycleProfile enum A concrete instance of `LifecycleProfileInput` can be one of the following:

LifecycleProfileResilient
LifecycleProfileStrict
LifecycleProfileBestEffort

type LifecycleProfileOutput

type LifecycleProfileOutput struct{ *pulumi.OutputState }

func (LifecycleProfileOutput) ElementType

func (LifecycleProfileOutput) ElementType() reflect.Type

func (LifecycleProfileOutput) ToLifecycleProfileOutput

func (o LifecycleProfileOutput) ToLifecycleProfileOutput() LifecycleProfileOutput

func (LifecycleProfileOutput) ToLifecycleProfileOutputWithContext

func (o LifecycleProfileOutput) ToLifecycleProfileOutputWithContext(ctx context.Context) LifecycleProfileOutput

func (LifecycleProfileOutput) ToLifecycleProfilePtrOutput

func (o LifecycleProfileOutput) ToLifecycleProfilePtrOutput() LifecycleProfilePtrOutput

func (LifecycleProfileOutput) ToLifecycleProfilePtrOutputWithContext

func (o LifecycleProfileOutput) ToLifecycleProfilePtrOutputWithContext(ctx context.Context) LifecycleProfilePtrOutput

func (LifecycleProfileOutput) ToStringOutput

func (o LifecycleProfileOutput) ToStringOutput() pulumi.StringOutput

func (LifecycleProfileOutput) ToStringOutputWithContext

func (o LifecycleProfileOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (LifecycleProfileOutput) ToStringPtrOutput

func (o LifecycleProfileOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (LifecycleProfileOutput) ToStringPtrOutputWithContext

func (o LifecycleProfileOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LifecycleProfilePtrInput

type LifecycleProfilePtrInput interface {
	pulumi.Input

	ToLifecycleProfilePtrOutput() LifecycleProfilePtrOutput
	ToLifecycleProfilePtrOutputWithContext(context.Context) LifecycleProfilePtrOutput
}

func LifecycleProfilePtr

func LifecycleProfilePtr(v string) LifecycleProfilePtrInput

type LifecycleProfilePtrOutput

type LifecycleProfilePtrOutput struct{ *pulumi.OutputState }

func (LifecycleProfilePtrOutput) Elem

func (LifecycleProfilePtrOutput) ElementType

func (LifecycleProfilePtrOutput) ElementType() reflect.Type

func (LifecycleProfilePtrOutput) ToLifecycleProfilePtrOutput

func (o LifecycleProfilePtrOutput) ToLifecycleProfilePtrOutput() LifecycleProfilePtrOutput

func (LifecycleProfilePtrOutput) ToLifecycleProfilePtrOutputWithContext

func (o LifecycleProfilePtrOutput) ToLifecycleProfilePtrOutputWithContext(ctx context.Context) LifecycleProfilePtrOutput

func (LifecycleProfilePtrOutput) ToStringPtrOutput

func (o LifecycleProfilePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (LifecycleProfilePtrOutput) ToStringPtrOutputWithContext

func (o LifecycleProfilePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LifecyclePtrInput

type LifecyclePtrInput interface {
	pulumi.Input

	ToLifecyclePtrOutput() LifecyclePtrOutput
	ToLifecyclePtrOutputWithContext(context.Context) LifecyclePtrOutput
}

LifecyclePtrInput is an input type that accepts LifecycleArgs, LifecyclePtr and LifecyclePtrOutput values. You can construct a concrete instance of `LifecyclePtrInput` via:

        LifecycleArgs{...}

or:

        nil

func LifecyclePtr

func LifecyclePtr(v *LifecycleArgs) LifecyclePtrInput

type LifecyclePtrOutput

type LifecyclePtrOutput struct{ *pulumi.OutputState }

func (LifecyclePtrOutput) Backoff

Exponential backoff between restart attempts.

func (LifecyclePtrOutput) CallTimeout

func (o LifecyclePtrOutput) CallTimeout() pulumi.StringPtrOutput

Cap on an individual tool call, including one reconnect-retry. Enforced: on expiry the call is cancelled and surfaced to the model as a tool error; cancellation is propagated to the server. The budget includes any nested sampling/elicitation time. Go duration format (e.g. '30s', '2m'). 0/unset means no timeout (opt-in; no profile default).

func (LifecyclePtrOutput) Elem

func (LifecyclePtrOutput) ElementType

func (LifecyclePtrOutput) ElementType() reflect.Type

func (LifecyclePtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (LifecyclePtrOutput) MaxRestarts

func (o LifecyclePtrOutput) MaxRestarts() pulumi.IntPtrOutput

Maximum number of consecutive restart attempts after a disconnect. 0 = use profile default (5). -1 = unlimited.

func (LifecyclePtrOutput) Profile

Shorthand that picks defaults for all the other fields. 'resilient' (default): auto-restart on failure with exponential backoff. 'strict': fail fast — the agent refuses to start when the toolset is unavailable. 'best-effort': single attempt, no auto-restart.

func (LifecyclePtrOutput) Required

Marks the toolset as critical to the agent. NOTE: not yet enforced — a planned eager-startup phase will refuse to start the agent when a required toolset cannot reach Ready within startup_timeout. Defaults to true under the 'strict' profile, false otherwise.

func (LifecyclePtrOutput) Restart

How the supervisor reacts to an unexpected disconnect.

func (LifecyclePtrOutput) StartupTimeout

func (o LifecyclePtrOutput) StartupTimeout() pulumi.StringPtrOutput

Cap on the initial Connect+initialize duration. Enforced since v1.94.0: on expiry the toolset stays stopped and the runtime retries on the next turn. Go duration format (e.g. '30s', '2m'). 0 means no timeout.

func (LifecyclePtrOutput) ToLifecyclePtrOutput

func (o LifecyclePtrOutput) ToLifecyclePtrOutput() LifecyclePtrOutput

func (LifecyclePtrOutput) ToLifecyclePtrOutputWithContext

func (o LifecyclePtrOutput) ToLifecyclePtrOutputWithContext(ctx context.Context) LifecyclePtrOutput

type Logging

type Logging string

func (Logging) ElementType

func (Logging) ElementType() reflect.Type

func (Logging) ToLoggingOutput

func (e Logging) ToLoggingOutput() LoggingOutput

func (Logging) ToLoggingOutputWithContext

func (e Logging) ToLoggingOutputWithContext(ctx context.Context) LoggingOutput

func (Logging) ToLoggingPtrOutput

func (e Logging) ToLoggingPtrOutput() LoggingPtrOutput

func (Logging) ToLoggingPtrOutputWithContext

func (e Logging) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

func (Logging) ToStringOutput

func (e Logging) ToStringOutput() pulumi.StringOutput

func (Logging) ToStringOutputWithContext

func (e Logging) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (Logging) ToStringPtrOutput

func (e Logging) ToStringPtrOutput() pulumi.StringPtrOutput

func (Logging) ToStringPtrOutputWithContext

func (e Logging) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LoggingInput

type LoggingInput interface {
	pulumi.Input

	ToLoggingOutput() LoggingOutput
	ToLoggingOutputWithContext(context.Context) LoggingOutput
}

LoggingInput is an input type that accepts values of the Logging enum A concrete instance of `LoggingInput` can be one of the following:

LoggingNone
LoggingStatus
LoggingTools
LoggingFull

type LoggingOutput

type LoggingOutput struct{ *pulumi.OutputState }

func (LoggingOutput) ElementType

func (LoggingOutput) ElementType() reflect.Type

func (LoggingOutput) ToLoggingOutput

func (o LoggingOutput) ToLoggingOutput() LoggingOutput

func (LoggingOutput) ToLoggingOutputWithContext

func (o LoggingOutput) ToLoggingOutputWithContext(ctx context.Context) LoggingOutput

func (LoggingOutput) ToLoggingPtrOutput

func (o LoggingOutput) ToLoggingPtrOutput() LoggingPtrOutput

func (LoggingOutput) ToLoggingPtrOutputWithContext

func (o LoggingOutput) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

func (LoggingOutput) ToStringOutput

func (o LoggingOutput) ToStringOutput() pulumi.StringOutput

func (LoggingOutput) ToStringOutputWithContext

func (o LoggingOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (LoggingOutput) ToStringPtrOutput

func (o LoggingOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (LoggingOutput) ToStringPtrOutputWithContext

func (o LoggingOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LoggingPtrInput

type LoggingPtrInput interface {
	pulumi.Input

	ToLoggingPtrOutput() LoggingPtrOutput
	ToLoggingPtrOutputWithContext(context.Context) LoggingPtrOutput
}

func LoggingPtr

func LoggingPtr(v string) LoggingPtrInput

type LoggingPtrOutput

type LoggingPtrOutput struct{ *pulumi.OutputState }

func (LoggingPtrOutput) Elem

func (LoggingPtrOutput) ElementType

func (LoggingPtrOutput) ElementType() reflect.Type

func (LoggingPtrOutput) ToLoggingPtrOutput

func (o LoggingPtrOutput) ToLoggingPtrOutput() LoggingPtrOutput

func (LoggingPtrOutput) ToLoggingPtrOutputWithContext

func (o LoggingPtrOutput) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

func (LoggingPtrOutput) ToStringPtrOutput

func (o LoggingPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (LoggingPtrOutput) ToStringPtrOutputWithContext

func (o LoggingPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type McpDefinition

type McpDefinition struct {
	// Opt in to dialling non-public IP addresses (valid for type 'fetch', 'api', 'openapi', 'a2a', and remote MCP toolsets). By default, on the direct path (Docker Desktop unavailable, disabled, or target host is not in the Docker-owned allowlist), protected HTTP clients refuse connections — after DNS resolution, defeating DNS rebinding — to loopback, RFC1918 private ranges, link-local (including the cloud metadata endpoint at 169.254.169.254), multicast and the unspecified address. When Docker Desktop is running, only Docker-owned hostnames (docker.com, docker.io families) go through its PAC proxy; dial-time enforcement does not apply on that path. Set this to true when an agent legitimately needs to call internal services. For fetch, 'allowed_domains' / 'blocked_domains' are evaluated independently and still apply. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	AllowPrivateIps *bool `pulumi:"allowPrivateIps"`
	// Arguments to pass to the command
	Args []string `pulumi:"args"`
	// Command to run the MCP server (stdio transport)
	Command *string `pulumi:"command"`
	// MCP server configuration (for docker refs) Free-form, rendered verbatim.
	Config interface{} `pulumi:"config"`
	// Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.
	Defer *bool `pulumi:"defer"`
	// Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.
	DeferTools []string `pulumi:"deferTools"`
	// Environment variables for the MCP server
	Env map[string]string `pulumi:"env"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Custom instruction for this MCP server's tools. By default, setting this field replaces the toolset's built-in instructions entirely. To enrich (rather than replace) the original instructions, include the placeholder {ORIGINAL_INSTRUCTIONS} in your text — it will be substituted with the toolset's built-in instructions at runtime. For example: '{ORIGINAL_INSTRUCTIONS}
	// Always prefer JSON output.' will prepend the original instructions and append your extra guidance.
	Instruction *string `pulumi:"instruction"`
	// Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.
	Lifecycle *Lifecycle `pulumi:"lifecycle"`
	// Model to use for the LLM turn that processes tool results from this toolset. Enables per-tool model routing: cheaper/faster models handle simple tool results (e.g. knowledge-base lookups, file reads) while the agent's primary model handles complex reasoning. Value can be a model name from the models section or an inline provider/model format (e.g. 'openai/gpt-4o-mini'). Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Model *string `pulumi:"model"`
	// Optional display name override for the MCP server
	Name *string `pulumi:"name"`
	// When true, restricts this toolset to tools whose annotations carry a read-only hint. Every other (mutating) tool is filtered out, so the agent can only list and call the non-mutating subset of the toolset. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Readonly *bool `pulumi:"readonly"`
	// Docker MCP reference (e.g., 'docker:context7')
	Ref *string `pulumi:"ref"`
	// Remote MCP server configuration (streamable-http/SSE transport)
	Remote *Remote `pulumi:"remote"`
	// HTTP timeout in seconds (valid for type 'fetch', 'api', and 'openapi'). Defaults to 30 seconds when omitted. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Timeout *int `pulumi:"timeout"`
	// Optional list of tools to expose from the MCP server
	Tools []string `pulumi:"tools"`
	// A comma-delimited list of regular expressions of tools to toonify. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Toon *string `pulumi:"toon"`
	// Version/package reference for auto-installation
	Version *string `pulumi:"version"`
	// Optional working directory for the MCP server process. Relative paths are resolved relative to the agent's working directory. Only valid for subprocess-based MCP types (command or ref); not supported for remote MCP toolsets.
	WorkingDir *string `pulumi:"workingDir"`
}

Reusable MCP server definition. Define once at the top level and reference by name from agent toolsets.

type McpDefinitionArgs

type McpDefinitionArgs struct {
	// Opt in to dialling non-public IP addresses (valid for type 'fetch', 'api', 'openapi', 'a2a', and remote MCP toolsets). By default, on the direct path (Docker Desktop unavailable, disabled, or target host is not in the Docker-owned allowlist), protected HTTP clients refuse connections — after DNS resolution, defeating DNS rebinding — to loopback, RFC1918 private ranges, link-local (including the cloud metadata endpoint at 169.254.169.254), multicast and the unspecified address. When Docker Desktop is running, only Docker-owned hostnames (docker.com, docker.io families) go through its PAC proxy; dial-time enforcement does not apply on that path. Set this to true when an agent legitimately needs to call internal services. For fetch, 'allowed_domains' / 'blocked_domains' are evaluated independently and still apply. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	AllowPrivateIps pulumi.BoolPtrInput `pulumi:"allowPrivateIps"`
	// Arguments to pass to the command
	Args pulumi.StringArrayInput `pulumi:"args"`
	// Command to run the MCP server (stdio transport)
	Command pulumi.StringPtrInput `pulumi:"command"`
	// MCP server configuration (for docker refs) Free-form, rendered verbatim.
	Config pulumi.Input `pulumi:"config"`
	// Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.
	Defer pulumi.BoolPtrInput `pulumi:"defer"`
	// Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.
	DeferTools pulumi.StringArrayInput `pulumi:"deferTools"`
	// Environment variables for the MCP server
	Env pulumi.StringMapInput `pulumi:"env"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Custom instruction for this MCP server's tools. By default, setting this field replaces the toolset's built-in instructions entirely. To enrich (rather than replace) the original instructions, include the placeholder {ORIGINAL_INSTRUCTIONS} in your text — it will be substituted with the toolset's built-in instructions at runtime. For example: '{ORIGINAL_INSTRUCTIONS}
	// Always prefer JSON output.' will prepend the original instructions and append your extra guidance.
	Instruction pulumi.StringPtrInput `pulumi:"instruction"`
	// Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.
	Lifecycle LifecyclePtrInput `pulumi:"lifecycle"`
	// Model to use for the LLM turn that processes tool results from this toolset. Enables per-tool model routing: cheaper/faster models handle simple tool results (e.g. knowledge-base lookups, file reads) while the agent's primary model handles complex reasoning. Value can be a model name from the models section or an inline provider/model format (e.g. 'openai/gpt-4o-mini'). Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Model pulumi.StringPtrInput `pulumi:"model"`
	// Optional display name override for the MCP server
	Name pulumi.StringPtrInput `pulumi:"name"`
	// When true, restricts this toolset to tools whose annotations carry a read-only hint. Every other (mutating) tool is filtered out, so the agent can only list and call the non-mutating subset of the toolset. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Readonly pulumi.BoolPtrInput `pulumi:"readonly"`
	// Docker MCP reference (e.g., 'docker:context7')
	Ref pulumi.StringPtrInput `pulumi:"ref"`
	// Remote MCP server configuration (streamable-http/SSE transport)
	Remote RemotePtrInput `pulumi:"remote"`
	// HTTP timeout in seconds (valid for type 'fetch', 'api', and 'openapi'). Defaults to 30 seconds when omitted. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// Optional list of tools to expose from the MCP server
	Tools pulumi.StringArrayInput `pulumi:"tools"`
	// A comma-delimited list of regular expressions of tools to toonify. Accepted by docker-agent's loader, although agent-schema.json does not list it here.
	Toon pulumi.StringPtrInput `pulumi:"toon"`
	// Version/package reference for auto-installation
	Version pulumi.StringPtrInput `pulumi:"version"`
	// Optional working directory for the MCP server process. Relative paths are resolved relative to the agent's working directory. Only valid for subprocess-based MCP types (command or ref); not supported for remote MCP toolsets.
	WorkingDir pulumi.StringPtrInput `pulumi:"workingDir"`
}

Reusable MCP server definition. Define once at the top level and reference by name from agent toolsets.

func (McpDefinitionArgs) ElementType

func (McpDefinitionArgs) ElementType() reflect.Type

func (McpDefinitionArgs) ToMcpDefinitionOutput

func (i McpDefinitionArgs) ToMcpDefinitionOutput() McpDefinitionOutput

func (McpDefinitionArgs) ToMcpDefinitionOutputWithContext

func (i McpDefinitionArgs) ToMcpDefinitionOutputWithContext(ctx context.Context) McpDefinitionOutput

type McpDefinitionInput

type McpDefinitionInput interface {
	pulumi.Input

	ToMcpDefinitionOutput() McpDefinitionOutput
	ToMcpDefinitionOutputWithContext(context.Context) McpDefinitionOutput
}

McpDefinitionInput is an input type that accepts McpDefinitionArgs and McpDefinitionOutput values. You can construct a concrete instance of `McpDefinitionInput` via:

McpDefinitionArgs{...}

type McpDefinitionMap

type McpDefinitionMap map[string]McpDefinitionInput

func (McpDefinitionMap) ElementType

func (McpDefinitionMap) ElementType() reflect.Type

func (McpDefinitionMap) ToMcpDefinitionMapOutput

func (i McpDefinitionMap) ToMcpDefinitionMapOutput() McpDefinitionMapOutput

func (McpDefinitionMap) ToMcpDefinitionMapOutputWithContext

func (i McpDefinitionMap) ToMcpDefinitionMapOutputWithContext(ctx context.Context) McpDefinitionMapOutput

type McpDefinitionMapInput

type McpDefinitionMapInput interface {
	pulumi.Input

	ToMcpDefinitionMapOutput() McpDefinitionMapOutput
	ToMcpDefinitionMapOutputWithContext(context.Context) McpDefinitionMapOutput
}

McpDefinitionMapInput is an input type that accepts McpDefinitionMap and McpDefinitionMapOutput values. You can construct a concrete instance of `McpDefinitionMapInput` via:

McpDefinitionMap{ "key": McpDefinitionArgs{...} }

type McpDefinitionMapOutput

type McpDefinitionMapOutput struct{ *pulumi.OutputState }

func (McpDefinitionMapOutput) ElementType

func (McpDefinitionMapOutput) ElementType() reflect.Type

func (McpDefinitionMapOutput) MapIndex

func (McpDefinitionMapOutput) ToMcpDefinitionMapOutput

func (o McpDefinitionMapOutput) ToMcpDefinitionMapOutput() McpDefinitionMapOutput

func (McpDefinitionMapOutput) ToMcpDefinitionMapOutputWithContext

func (o McpDefinitionMapOutput) ToMcpDefinitionMapOutputWithContext(ctx context.Context) McpDefinitionMapOutput

type McpDefinitionOutput

type McpDefinitionOutput struct{ *pulumi.OutputState }

Reusable MCP server definition. Define once at the top level and reference by name from agent toolsets.

func (McpDefinitionOutput) AllowPrivateIps

func (o McpDefinitionOutput) AllowPrivateIps() pulumi.BoolPtrOutput

Opt in to dialling non-public IP addresses (valid for type 'fetch', 'api', 'openapi', 'a2a', and remote MCP toolsets). By default, on the direct path (Docker Desktop unavailable, disabled, or target host is not in the Docker-owned allowlist), protected HTTP clients refuse connections — after DNS resolution, defeating DNS rebinding — to loopback, RFC1918 private ranges, link-local (including the cloud metadata endpoint at 169.254.169.254), multicast and the unspecified address. When Docker Desktop is running, only Docker-owned hostnames (docker.com, docker.io families) go through its PAC proxy; dial-time enforcement does not apply on that path. Set this to true when an agent legitimately needs to call internal services. For fetch, 'allowed_domains' / 'blocked_domains' are evaluated independently and still apply. Accepted by docker-agent's loader, although agent-schema.json does not list it here.

func (McpDefinitionOutput) Args

Arguments to pass to the command

func (McpDefinitionOutput) Command

Command to run the MCP server (stdio transport)

func (McpDefinitionOutput) Config

MCP server configuration (for docker refs) Free-form, rendered verbatim.

func (McpDefinitionOutput) Defer

Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.

func (McpDefinitionOutput) DeferTools

Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.

func (McpDefinitionOutput) ElementType

func (McpDefinitionOutput) ElementType() reflect.Type

func (McpDefinitionOutput) Env

Environment variables for the MCP server

func (McpDefinitionOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (McpDefinitionOutput) Instruction

func (o McpDefinitionOutput) Instruction() pulumi.StringPtrOutput

Custom instruction for this MCP server's tools. By default, setting this field replaces the toolset's built-in instructions entirely. To enrich (rather than replace) the original instructions, include the placeholder {ORIGINAL_INSTRUCTIONS} in your text — it will be substituted with the toolset's built-in instructions at runtime. For example: '{ORIGINAL_INSTRUCTIONS} Always prefer JSON output.' will prepend the original instructions and append your extra guidance.

func (McpDefinitionOutput) Lifecycle

Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.

func (McpDefinitionOutput) Model

Model to use for the LLM turn that processes tool results from this toolset. Enables per-tool model routing: cheaper/faster models handle simple tool results (e.g. knowledge-base lookups, file reads) while the agent's primary model handles complex reasoning. Value can be a model name from the models section or an inline provider/model format (e.g. 'openai/gpt-4o-mini'). Accepted by docker-agent's loader, although agent-schema.json does not list it here.

func (McpDefinitionOutput) Name

Optional display name override for the MCP server

func (McpDefinitionOutput) Readonly

When true, restricts this toolset to tools whose annotations carry a read-only hint. Every other (mutating) tool is filtered out, so the agent can only list and call the non-mutating subset of the toolset. Accepted by docker-agent's loader, although agent-schema.json does not list it here.

func (McpDefinitionOutput) Ref

Docker MCP reference (e.g., 'docker:context7')

func (McpDefinitionOutput) Remote

Remote MCP server configuration (streamable-http/SSE transport)

func (McpDefinitionOutput) Timeout

HTTP timeout in seconds (valid for type 'fetch', 'api', and 'openapi'). Defaults to 30 seconds when omitted. Accepted by docker-agent's loader, although agent-schema.json does not list it here.

func (McpDefinitionOutput) ToMcpDefinitionOutput

func (o McpDefinitionOutput) ToMcpDefinitionOutput() McpDefinitionOutput

func (McpDefinitionOutput) ToMcpDefinitionOutputWithContext

func (o McpDefinitionOutput) ToMcpDefinitionOutputWithContext(ctx context.Context) McpDefinitionOutput

func (McpDefinitionOutput) Tools

Optional list of tools to expose from the MCP server

func (McpDefinitionOutput) Toon

A comma-delimited list of regular expressions of tools to toonify. Accepted by docker-agent's loader, although agent-schema.json does not list it here.

func (McpDefinitionOutput) Version

Version/package reference for auto-installation

func (McpDefinitionOutput) WorkingDir

Optional working directory for the MCP server process. Relative paths are resolved relative to the agent's working directory. Only valid for subprocess-based MCP types (command or ref); not supported for remote MCP toolsets.

type Metadata

type Metadata struct {
	// Author of the configuration
	Author *string `pulumi:"author"`
	// Description of the agent configuration
	Description *string `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// License for the configuration
	License *string `pulumi:"license"`
	// README or description
	Readme *string `pulumi:"readme"`
	// Tags describing the agent configuration (e.g. for categorization and discovery)
	Tags []string `pulumi:"tags"`
	// Version of the agent configuration (used for OCI registry publishing)
	Version *string `pulumi:"version"`
}

Configuration metadata

type MetadataArgs

type MetadataArgs struct {
	// Author of the configuration
	Author pulumi.StringPtrInput `pulumi:"author"`
	// Description of the agent configuration
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// License for the configuration
	License pulumi.StringPtrInput `pulumi:"license"`
	// README or description
	Readme pulumi.StringPtrInput `pulumi:"readme"`
	// Tags describing the agent configuration (e.g. for categorization and discovery)
	Tags pulumi.StringArrayInput `pulumi:"tags"`
	// Version of the agent configuration (used for OCI registry publishing)
	Version pulumi.StringPtrInput `pulumi:"version"`
}

Configuration metadata

func (MetadataArgs) ElementType

func (MetadataArgs) ElementType() reflect.Type

func (MetadataArgs) ToMetadataOutput

func (i MetadataArgs) ToMetadataOutput() MetadataOutput

func (MetadataArgs) ToMetadataOutputWithContext

func (i MetadataArgs) ToMetadataOutputWithContext(ctx context.Context) MetadataOutput

func (MetadataArgs) ToMetadataPtrOutput

func (i MetadataArgs) ToMetadataPtrOutput() MetadataPtrOutput

func (MetadataArgs) ToMetadataPtrOutputWithContext

func (i MetadataArgs) ToMetadataPtrOutputWithContext(ctx context.Context) MetadataPtrOutput

type MetadataInput

type MetadataInput interface {
	pulumi.Input

	ToMetadataOutput() MetadataOutput
	ToMetadataOutputWithContext(context.Context) MetadataOutput
}

MetadataInput is an input type that accepts MetadataArgs and MetadataOutput values. You can construct a concrete instance of `MetadataInput` via:

MetadataArgs{...}

type MetadataOutput

type MetadataOutput struct{ *pulumi.OutputState }

Configuration metadata

func (MetadataOutput) Author

Author of the configuration

func (MetadataOutput) Description

func (o MetadataOutput) Description() pulumi.StringPtrOutput

Description of the agent configuration

func (MetadataOutput) ElementType

func (MetadataOutput) ElementType() reflect.Type

func (MetadataOutput) Extra

func (o MetadataOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (MetadataOutput) License

License for the configuration

func (MetadataOutput) Readme

README or description

func (MetadataOutput) Tags

Tags describing the agent configuration (e.g. for categorization and discovery)

func (MetadataOutput) ToMetadataOutput

func (o MetadataOutput) ToMetadataOutput() MetadataOutput

func (MetadataOutput) ToMetadataOutputWithContext

func (o MetadataOutput) ToMetadataOutputWithContext(ctx context.Context) MetadataOutput

func (MetadataOutput) ToMetadataPtrOutput

func (o MetadataOutput) ToMetadataPtrOutput() MetadataPtrOutput

func (MetadataOutput) ToMetadataPtrOutputWithContext

func (o MetadataOutput) ToMetadataPtrOutputWithContext(ctx context.Context) MetadataPtrOutput

func (MetadataOutput) Version

Version of the agent configuration (used for OCI registry publishing)

type MetadataPtrInput

type MetadataPtrInput interface {
	pulumi.Input

	ToMetadataPtrOutput() MetadataPtrOutput
	ToMetadataPtrOutputWithContext(context.Context) MetadataPtrOutput
}

MetadataPtrInput is an input type that accepts MetadataArgs, MetadataPtr and MetadataPtrOutput values. You can construct a concrete instance of `MetadataPtrInput` via:

        MetadataArgs{...}

or:

        nil

func MetadataPtr

func MetadataPtr(v *MetadataArgs) MetadataPtrInput

type MetadataPtrOutput

type MetadataPtrOutput struct{ *pulumi.OutputState }

func (MetadataPtrOutput) Author

Author of the configuration

func (MetadataPtrOutput) Description

func (o MetadataPtrOutput) Description() pulumi.StringPtrOutput

Description of the agent configuration

func (MetadataPtrOutput) Elem

func (MetadataPtrOutput) ElementType

func (MetadataPtrOutput) ElementType() reflect.Type

func (MetadataPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (MetadataPtrOutput) License

License for the configuration

func (MetadataPtrOutput) Readme

README or description

func (MetadataPtrOutput) Tags

Tags describing the agent configuration (e.g. for categorization and discovery)

func (MetadataPtrOutput) ToMetadataPtrOutput

func (o MetadataPtrOutput) ToMetadataPtrOutput() MetadataPtrOutput

func (MetadataPtrOutput) ToMetadataPtrOutputWithContext

func (o MetadataPtrOutput) ToMetadataPtrOutputWithContext(ctx context.Context) MetadataPtrOutput

func (MetadataPtrOutput) Version

Version of the agent configuration (used for OCI registry publishing)

type ModelAuth

type ModelAuth struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Authentication scheme discriminator. Allowed values: `workload_identity_federation`.
	Type string `pulumi:"type"`
	// Parameters for the Anthropic OIDC federation flow. Required when type is workload_identity_federation.
	WorkloadIdentityFederation *WorkloadIdentityFederation `pulumi:"workloadIdentityFederation"`
}

Non-API-key authentication for a model provider. Today only Anthropic Workload Identity Federation is supported (type: workload_identity_federation).

type ModelAuthArgs

type ModelAuthArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Authentication scheme discriminator. Allowed values: `workload_identity_federation`.
	Type pulumi.StringInput `pulumi:"type"`
	// Parameters for the Anthropic OIDC federation flow. Required when type is workload_identity_federation.
	WorkloadIdentityFederation WorkloadIdentityFederationPtrInput `pulumi:"workloadIdentityFederation"`
}

Non-API-key authentication for a model provider. Today only Anthropic Workload Identity Federation is supported (type: workload_identity_federation).

func (ModelAuthArgs) ElementType

func (ModelAuthArgs) ElementType() reflect.Type

func (ModelAuthArgs) ToModelAuthOutput

func (i ModelAuthArgs) ToModelAuthOutput() ModelAuthOutput

func (ModelAuthArgs) ToModelAuthOutputWithContext

func (i ModelAuthArgs) ToModelAuthOutputWithContext(ctx context.Context) ModelAuthOutput

func (ModelAuthArgs) ToModelAuthPtrOutput

func (i ModelAuthArgs) ToModelAuthPtrOutput() ModelAuthPtrOutput

func (ModelAuthArgs) ToModelAuthPtrOutputWithContext

func (i ModelAuthArgs) ToModelAuthPtrOutputWithContext(ctx context.Context) ModelAuthPtrOutput

type ModelAuthInput

type ModelAuthInput interface {
	pulumi.Input

	ToModelAuthOutput() ModelAuthOutput
	ToModelAuthOutputWithContext(context.Context) ModelAuthOutput
}

ModelAuthInput is an input type that accepts ModelAuthArgs and ModelAuthOutput values. You can construct a concrete instance of `ModelAuthInput` via:

ModelAuthArgs{...}

type ModelAuthOutput

type ModelAuthOutput struct{ *pulumi.OutputState }

Non-API-key authentication for a model provider. Today only Anthropic Workload Identity Federation is supported (type: workload_identity_federation).

func (ModelAuthOutput) ElementType

func (ModelAuthOutput) ElementType() reflect.Type

func (ModelAuthOutput) Extra

func (o ModelAuthOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ModelAuthOutput) ToModelAuthOutput

func (o ModelAuthOutput) ToModelAuthOutput() ModelAuthOutput

func (ModelAuthOutput) ToModelAuthOutputWithContext

func (o ModelAuthOutput) ToModelAuthOutputWithContext(ctx context.Context) ModelAuthOutput

func (ModelAuthOutput) ToModelAuthPtrOutput

func (o ModelAuthOutput) ToModelAuthPtrOutput() ModelAuthPtrOutput

func (ModelAuthOutput) ToModelAuthPtrOutputWithContext

func (o ModelAuthOutput) ToModelAuthPtrOutputWithContext(ctx context.Context) ModelAuthPtrOutput

func (ModelAuthOutput) Type

Authentication scheme discriminator. Allowed values: `workload_identity_federation`.

func (ModelAuthOutput) WorkloadIdentityFederation

func (o ModelAuthOutput) WorkloadIdentityFederation() WorkloadIdentityFederationPtrOutput

Parameters for the Anthropic OIDC federation flow. Required when type is workload_identity_federation.

type ModelAuthPtrInput

type ModelAuthPtrInput interface {
	pulumi.Input

	ToModelAuthPtrOutput() ModelAuthPtrOutput
	ToModelAuthPtrOutputWithContext(context.Context) ModelAuthPtrOutput
}

ModelAuthPtrInput is an input type that accepts ModelAuthArgs, ModelAuthPtr and ModelAuthPtrOutput values. You can construct a concrete instance of `ModelAuthPtrInput` via:

        ModelAuthArgs{...}

or:

        nil

func ModelAuthPtr

func ModelAuthPtr(v *ModelAuthArgs) ModelAuthPtrInput

type ModelAuthPtrOutput

type ModelAuthPtrOutput struct{ *pulumi.OutputState }

func (ModelAuthPtrOutput) Elem

func (ModelAuthPtrOutput) ElementType

func (ModelAuthPtrOutput) ElementType() reflect.Type

func (ModelAuthPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ModelAuthPtrOutput) ToModelAuthPtrOutput

func (o ModelAuthPtrOutput) ToModelAuthPtrOutput() ModelAuthPtrOutput

func (ModelAuthPtrOutput) ToModelAuthPtrOutputWithContext

func (o ModelAuthPtrOutput) ToModelAuthPtrOutputWithContext(ctx context.Context) ModelAuthPtrOutput

func (ModelAuthPtrOutput) Type

Authentication scheme discriminator. Allowed values: `workload_identity_federation`.

func (ModelAuthPtrOutput) WorkloadIdentityFederation

func (o ModelAuthPtrOutput) WorkloadIdentityFederation() WorkloadIdentityFederationPtrOutput

Parameters for the Anthropic OIDC federation flow. Required when type is workload_identity_federation.

type ModelCapabilities

type ModelCapabilities struct {
	// Whether the model accepts audio attachments
	Audio *bool `pulumi:"audio"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Whether the model accepts image attachments
	Image *bool `pulumi:"image"`
	// Whether the model accepts PDF (application/pdf) attachments
	Pdf *bool `pulumi:"pdf"`
	// Whether the model accepts video attachments
	Video *bool `pulumi:"video"`
}

Explicit attachment capabilities for a model, overriding automatic models.dev-based detection. The declared flags must match what the underlying endpoint actually accepts; claiming an unsupported modality results in a provider-side API error.

type ModelCapabilitiesArgs

type ModelCapabilitiesArgs struct {
	// Whether the model accepts audio attachments
	Audio pulumi.BoolPtrInput `pulumi:"audio"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Whether the model accepts image attachments
	Image pulumi.BoolPtrInput `pulumi:"image"`
	// Whether the model accepts PDF (application/pdf) attachments
	Pdf pulumi.BoolPtrInput `pulumi:"pdf"`
	// Whether the model accepts video attachments
	Video pulumi.BoolPtrInput `pulumi:"video"`
}

Explicit attachment capabilities for a model, overriding automatic models.dev-based detection. The declared flags must match what the underlying endpoint actually accepts; claiming an unsupported modality results in a provider-side API error.

func (ModelCapabilitiesArgs) ElementType

func (ModelCapabilitiesArgs) ElementType() reflect.Type

func (ModelCapabilitiesArgs) ToModelCapabilitiesOutput

func (i ModelCapabilitiesArgs) ToModelCapabilitiesOutput() ModelCapabilitiesOutput

func (ModelCapabilitiesArgs) ToModelCapabilitiesOutputWithContext

func (i ModelCapabilitiesArgs) ToModelCapabilitiesOutputWithContext(ctx context.Context) ModelCapabilitiesOutput

func (ModelCapabilitiesArgs) ToModelCapabilitiesPtrOutput

func (i ModelCapabilitiesArgs) ToModelCapabilitiesPtrOutput() ModelCapabilitiesPtrOutput

func (ModelCapabilitiesArgs) ToModelCapabilitiesPtrOutputWithContext

func (i ModelCapabilitiesArgs) ToModelCapabilitiesPtrOutputWithContext(ctx context.Context) ModelCapabilitiesPtrOutput

type ModelCapabilitiesInput

type ModelCapabilitiesInput interface {
	pulumi.Input

	ToModelCapabilitiesOutput() ModelCapabilitiesOutput
	ToModelCapabilitiesOutputWithContext(context.Context) ModelCapabilitiesOutput
}

ModelCapabilitiesInput is an input type that accepts ModelCapabilitiesArgs and ModelCapabilitiesOutput values. You can construct a concrete instance of `ModelCapabilitiesInput` via:

ModelCapabilitiesArgs{...}

type ModelCapabilitiesOutput

type ModelCapabilitiesOutput struct{ *pulumi.OutputState }

Explicit attachment capabilities for a model, overriding automatic models.dev-based detection. The declared flags must match what the underlying endpoint actually accepts; claiming an unsupported modality results in a provider-side API error.

func (ModelCapabilitiesOutput) Audio

Whether the model accepts audio attachments

func (ModelCapabilitiesOutput) ElementType

func (ModelCapabilitiesOutput) ElementType() reflect.Type

func (ModelCapabilitiesOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ModelCapabilitiesOutput) Image

Whether the model accepts image attachments

func (ModelCapabilitiesOutput) Pdf

Whether the model accepts PDF (application/pdf) attachments

func (ModelCapabilitiesOutput) ToModelCapabilitiesOutput

func (o ModelCapabilitiesOutput) ToModelCapabilitiesOutput() ModelCapabilitiesOutput

func (ModelCapabilitiesOutput) ToModelCapabilitiesOutputWithContext

func (o ModelCapabilitiesOutput) ToModelCapabilitiesOutputWithContext(ctx context.Context) ModelCapabilitiesOutput

func (ModelCapabilitiesOutput) ToModelCapabilitiesPtrOutput

func (o ModelCapabilitiesOutput) ToModelCapabilitiesPtrOutput() ModelCapabilitiesPtrOutput

func (ModelCapabilitiesOutput) ToModelCapabilitiesPtrOutputWithContext

func (o ModelCapabilitiesOutput) ToModelCapabilitiesPtrOutputWithContext(ctx context.Context) ModelCapabilitiesPtrOutput

func (ModelCapabilitiesOutput) Video

Whether the model accepts video attachments

type ModelCapabilitiesPtrInput

type ModelCapabilitiesPtrInput interface {
	pulumi.Input

	ToModelCapabilitiesPtrOutput() ModelCapabilitiesPtrOutput
	ToModelCapabilitiesPtrOutputWithContext(context.Context) ModelCapabilitiesPtrOutput
}

ModelCapabilitiesPtrInput is an input type that accepts ModelCapabilitiesArgs, ModelCapabilitiesPtr and ModelCapabilitiesPtrOutput values. You can construct a concrete instance of `ModelCapabilitiesPtrInput` via:

        ModelCapabilitiesArgs{...}

or:

        nil

type ModelCapabilitiesPtrOutput

type ModelCapabilitiesPtrOutput struct{ *pulumi.OutputState }

func (ModelCapabilitiesPtrOutput) Audio

Whether the model accepts audio attachments

func (ModelCapabilitiesPtrOutput) Elem

func (ModelCapabilitiesPtrOutput) ElementType

func (ModelCapabilitiesPtrOutput) ElementType() reflect.Type

func (ModelCapabilitiesPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ModelCapabilitiesPtrOutput) Image

Whether the model accepts image attachments

func (ModelCapabilitiesPtrOutput) Pdf

Whether the model accepts PDF (application/pdf) attachments

func (ModelCapabilitiesPtrOutput) ToModelCapabilitiesPtrOutput

func (o ModelCapabilitiesPtrOutput) ToModelCapabilitiesPtrOutput() ModelCapabilitiesPtrOutput

func (ModelCapabilitiesPtrOutput) ToModelCapabilitiesPtrOutputWithContext

func (o ModelCapabilitiesPtrOutput) ToModelCapabilitiesPtrOutputWithContext(ctx context.Context) ModelCapabilitiesPtrOutput

func (ModelCapabilitiesPtrOutput) Video

Whether the model accepts video attachments

type ModelDef

type ModelDef struct {
	// Non-API-key authentication scheme for this model. When set, takes precedence over both the provider's API-key path and any auth defined on the referenced ProviderConfig.
	Auth *ModelAuth `pulumi:"auth"`
	// Base URL for the model API. Accepts ${env.VAR} / ${VAR} references, substituted from the environment when the model is loaded.
	BaseUrl *string `pulumi:"baseUrl"`
	// When true, this model connects directly to its provider, ignoring any configured models gateway (--models-gateway / DOCKER_AGENT_MODELS_GATEWAY). The model then authenticates with the provider's own credentials (e.g. OPENAI_API_KEY, ANTHROPIC_API_KEY, or token_key) instead of routing through the gateway. A custom base_url (set on the model or inherited from a custom provider definition) implies this bypass even when the flag is false.
	BypassModelsGateway *bool `pulumi:"bypassModelsGateway"`
	// Explicit attachment capability override for models the models.dev catalogue does not describe correctly (custom OpenAI-compatible providers, local models like Ollama, or dropped model versions). When set, the declared flags are authoritative and no models.dev lookup is performed; when omitted, capabilities are detected automatically. Without it, such models fall back to text-only and their image/PDF/audio/video attachments are silently dropped.
	Capabilities *ModelCapabilities `pulumi:"capabilities"`
	// Model used to summarize the conversation when this model's session is compacted (manual /compact, the proactive threshold trigger, or post-overflow recovery). The summary call ingests the whole conversation and is the slowest, most expensive call in a session; pointing this at a smaller/faster model makes compaction cheaper and more reliable without changing the model that runs the conversation. Value can be a model name from the models section or an inline 'provider/model' spec. The agent-level compaction_model takes precedence over this value, which in turn takes precedence over a provider-level default; when all are omitted, compaction reuses the agent's own model. If the compaction model has a smaller context window than the primary, compaction is triggered against the smaller window so the summary call can always ingest the conversation it must compact.
	CompactionModel *string `pulumi:"compactionModel"`
	// Fraction of the context window at which proactive auto-compaction triggers for agents running this model. Must be greater than 0 and at most 1. Defaults to 0.9 (90% of the context window). Takes precedence over the agent-level compaction_threshold. Cannot be combined with first_available.
	CompactionThreshold *float64 `pulumi:"compactionThreshold"`
	// Explicit token pricing (USD per 1M tokens), overriding the models.dev catalogue. Used for per-turn cost computation, session cost tracking, the /model picker, and the after_llm_call hook's cost field. Makes an uncatalogued model (custom base_url provider, local or private deployment) 'priced' instead of billing $0. Prices must not be negative; an all-zero table means 'priced, free'. Cannot be combined with first_available.
	Cost *Cost `pulumi:"cost"`
	// Optional human-readable summary of the model's purpose or strengths (e.g. 'fast and cheap, good for summaries')
	Description *string `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Candidate model references in priority order. At load time docker-agent selects the first candidate whose credentials are configured. Candidates may be named models or inline 'provider/model' specs. Local providers (dmr, ollama) need no credentials and make reliable final fallbacks. Mutually exclusive with other model configuration fields.
	FirstAvailable []string `pulumi:"firstAvailable"`
	// Frequency penalty
	FrequencyPenalty *float64 `pulumi:"frequencyPenalty"`
	// Maximum output tokens per response (the completion budget), NOT the context window. OpenAI-compatible servers require prompt_tokens + max_tokens to fit the context window, so a value close to the window leaves no room for the prompt. Set provider_opts.context_size to declare the window.
	MaxTokens *int `pulumi:"maxTokens"`
	// Model name
	Model *string `pulumi:"model"`
	// Optional generative output capability override for this model. Resolution precedence is explicit false, explicit true, then the exact models.dev record's Modalities.Output=image for an omitted image flag (including an empty block). Unknown or unavailable catalogue metadata stays disabled; model names are never used to infer capability. Cannot be combined with first_available (set output_capabilities.image on the candidate models instead).
	OutputCapabilities *ModelOutputCapabilities `pulumi:"outputCapabilities"`
	// Whether to enable parallel tool calls
	ParallelToolCalls *bool `pulumi:"parallelToolCalls"`
	// Presence penalty
	PresencePenalty *float64 `pulumi:"presencePenalty"`
	// Model provider (e.g., openai, anthropic, dmr)
	Provider *string `pulumi:"provider"`
	// Provider-specific options. Anthropic: thinking_prefix_mismatch (error or drop_block; defaults to drop_block on Fable/Mythos 5.1), strict_tools (true for eligible schemas or a tool-name array requiring strict mode), cache_diagnostics (boolean; Claude API only), native_compaction (boolean; synchronous whole-history signed compaction on Claude API), cache_preserving_updates (boolean; native system/tool/effort changes with turn-scoped reminders on supported models), thinking_display: updates (progress updates beta on Fable 5+ and Mythos 5.1). Sampling parameters: top_k (integer, supported by anthropic, google, amazon-bedrock, and custom OpenAI-compatible providers like vLLM/Ollama), repetition_penalty (float, forwarded to custom OpenAI-compatible providers), min_p (float, forwarded to custom providers), seed (integer, forwarded to OpenAI). Lifecycle: unload_api (string) overrides the unload endpoint inherited from the provider config (relative path resolved against base_url's scheme+host, or an absolute URL); used by the runtime's `unload` on_agent_switch builtin hook to release model resources between agent switches. Infrastructure options: http_headers (map of string to string, adds custom HTTP headers to every request; used for OpenAI-compatible providers like github-copilot which requires Copilot-Integration-Id). dmr: runtime_flags; supports_images (boolean) and supports_pdf (boolean) declare which document attachment types the local model accepts. DMR-hosted models are not in the models.dev catalog, so attachment capabilities cannot be detected automatically and default to text-only; set supports_images: true for a vision model so image attachments are forwarded instead of silently dropped. anthropic/amazon-bedrock (Claude): interleaved_thinking (boolean, default true). anthropic: thinking_display ('summarized', 'omitted', 'updates', or 'display') controls whether thinking blocks are returned in responses when thinking is enabled. Claude Opus 4.7 hides thinking by default ('omitted'); set thinking_display: summarized to receive thinking blocks. 'display' (full thinking blocks) is only accepted by pre-4.6 token-thinking models (e.g. Sonnet 4.5, Haiku 4.5); models from the adaptive-thinking generation onward (Opus/Sonnet 4.6+, Sonnet 5, Fable 5) reject it, and docker-agent fails fast with a configuration error (fallbacks models are validated too); fallbacks (array of model ID strings, in priority order; enables the server-side-fallback beta so requests refused by safety classifiers, e.g. on Claude Fable 5, are retried with the listed models in a single round trip). OpenAI-compatible APIs: service_tier (string, forwarded unchanged to Chat Completions and Responses, including WebSocket and reranking; 'fast' or 'priority' enables Fast mode at premium pricing on supported models; omitted or empty leaves the API default, non-string values are ignored). openai/chatgpt: preserve_reasoning (boolean, default false) preserves ordered Responses output and encrypted reasoning for stateless continuation; native_tool_search also enables output replay. openai: cache_diagnostics (boolean, default false) logs Responses prompt-cache comparison results with --debug on GPT-5.6+; comparisons are scoped to the current session and resolved model; ignored for chatgpt and custom base_url endpoints. transport ('sse' or 'websocket') to choose between SSE and WebSocket streaming for the Responses API; native_tool_search (boolean, default false; also enables ordered output replay) declares the agent's deferred tools with defer_loading and a server-executed tool_search tool so OpenAI's hosted tool search discovers them (only openai models supporting deferred tools, gpt-5.4+; ignored on chatgpt, OpenAI-compatible endpoints including a custom base_url, and Chat Completions requests). openai/anthropic/google: rerank_prompt (string) to fully override the system prompt used for RAG reranking (advanced - prefer using results.reranking.criteria for domain-specific guidance). Google: google_search (boolean) enables Google Search grounding, google_maps (boolean) enables Google Maps grounding, code_execution (boolean) enables server-side code execution, url_context (boolean) enables reading public URLs during generation, output_dimensionality (positive integer) truncates Gemini embedding vectors to that size when the model is used as a RAG embedding_model; service_tier (string, forwarded unchanged as the top-level serviceTier of every generateContent request, including reranking, title generation, and compaction, on the Gemini API, Vertex AI, and the Docker models gateway; 'flex' for discounted, queued processing that may wait up to 15 minutes before the first byte, 'standard' for the default tier, 'priority' for premium processing; omitted or empty leaves the API default, non-string values are ignored; cost estimates are not tier-adjusted, set the model's cost override).
	ProviderOpts map[string]interface{} `pulumi:"providerOpts"`
	// Routing rules for request-based model selection. When configured, this model becomes a router that selects the best model based on the user's input. The model's provider/model fields define the fallback model.
	Routing []RoutingRule `pulumi:"routing"`
	// Total-token budget for an agentic task (`task_budget`), forwarded to Anthropic as `output_config.task_budget`. The object form `{type: tokens, total: N}` is the same as `N`; `tokens` is the only type.
	TaskBudget *int `pulumi:"taskBudget"`
	// Sampling temperature
	Temperature *float64 `pulumi:"temperature"`
	// Reasoning effort (`thinking_budget`) as a level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<level>`. Mutually exclusive with `thinkingBudgetTokens`.
	ThinkingBudget *string `pulumi:"thinkingBudget"`
	// Reasoning budget (`thinking_budget`) as a number of tokens. Mutually exclusive with `thinkingBudget`.
	ThinkingBudgetTokens *int `pulumi:"thinkingBudgetTokens"`
	// Model used to generate session titles when an agent runs with this model. Lets a heavyweight primary model delegate the cheap title-generation call to a smaller/faster model. Value can be a model name from the models section or an inline 'provider/model' spec. When omitted, title generation reuses the agent's own model.
	TitleModel *string `pulumi:"titleModel"`
	// Token key for authentication. Never put the secret itself in the configuration.
	TokenKey *string `pulumi:"tokenKey"`
	// Top-p sampling parameter
	TopP *float64 `pulumi:"topP"`
	// Whether to track usage
	TrackUsage *bool `pulumi:"trackUsage"`
}

Configuration for a model

type ModelDefArgs

type ModelDefArgs struct {
	// Non-API-key authentication scheme for this model. When set, takes precedence over both the provider's API-key path and any auth defined on the referenced ProviderConfig.
	Auth ModelAuthPtrInput `pulumi:"auth"`
	// Base URL for the model API. Accepts ${env.VAR} / ${VAR} references, substituted from the environment when the model is loaded.
	BaseUrl pulumi.StringPtrInput `pulumi:"baseUrl"`
	// When true, this model connects directly to its provider, ignoring any configured models gateway (--models-gateway / DOCKER_AGENT_MODELS_GATEWAY). The model then authenticates with the provider's own credentials (e.g. OPENAI_API_KEY, ANTHROPIC_API_KEY, or token_key) instead of routing through the gateway. A custom base_url (set on the model or inherited from a custom provider definition) implies this bypass even when the flag is false.
	BypassModelsGateway pulumi.BoolPtrInput `pulumi:"bypassModelsGateway"`
	// Explicit attachment capability override for models the models.dev catalogue does not describe correctly (custom OpenAI-compatible providers, local models like Ollama, or dropped model versions). When set, the declared flags are authoritative and no models.dev lookup is performed; when omitted, capabilities are detected automatically. Without it, such models fall back to text-only and their image/PDF/audio/video attachments are silently dropped.
	Capabilities ModelCapabilitiesPtrInput `pulumi:"capabilities"`
	// Model used to summarize the conversation when this model's session is compacted (manual /compact, the proactive threshold trigger, or post-overflow recovery). The summary call ingests the whole conversation and is the slowest, most expensive call in a session; pointing this at a smaller/faster model makes compaction cheaper and more reliable without changing the model that runs the conversation. Value can be a model name from the models section or an inline 'provider/model' spec. The agent-level compaction_model takes precedence over this value, which in turn takes precedence over a provider-level default; when all are omitted, compaction reuses the agent's own model. If the compaction model has a smaller context window than the primary, compaction is triggered against the smaller window so the summary call can always ingest the conversation it must compact.
	CompactionModel pulumi.StringPtrInput `pulumi:"compactionModel"`
	// Fraction of the context window at which proactive auto-compaction triggers for agents running this model. Must be greater than 0 and at most 1. Defaults to 0.9 (90% of the context window). Takes precedence over the agent-level compaction_threshold. Cannot be combined with first_available.
	CompactionThreshold pulumi.Float64PtrInput `pulumi:"compactionThreshold"`
	// Explicit token pricing (USD per 1M tokens), overriding the models.dev catalogue. Used for per-turn cost computation, session cost tracking, the /model picker, and the after_llm_call hook's cost field. Makes an uncatalogued model (custom base_url provider, local or private deployment) 'priced' instead of billing $0. Prices must not be negative; an all-zero table means 'priced, free'. Cannot be combined with first_available.
	Cost CostPtrInput `pulumi:"cost"`
	// Optional human-readable summary of the model's purpose or strengths (e.g. 'fast and cheap, good for summaries')
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Candidate model references in priority order. At load time docker-agent selects the first candidate whose credentials are configured. Candidates may be named models or inline 'provider/model' specs. Local providers (dmr, ollama) need no credentials and make reliable final fallbacks. Mutually exclusive with other model configuration fields.
	FirstAvailable pulumi.StringArrayInput `pulumi:"firstAvailable"`
	// Frequency penalty
	FrequencyPenalty pulumi.Float64PtrInput `pulumi:"frequencyPenalty"`
	// Maximum output tokens per response (the completion budget), NOT the context window. OpenAI-compatible servers require prompt_tokens + max_tokens to fit the context window, so a value close to the window leaves no room for the prompt. Set provider_opts.context_size to declare the window.
	MaxTokens pulumi.IntPtrInput `pulumi:"maxTokens"`
	// Model name
	Model pulumi.StringPtrInput `pulumi:"model"`
	// Optional generative output capability override for this model. Resolution precedence is explicit false, explicit true, then the exact models.dev record's Modalities.Output=image for an omitted image flag (including an empty block). Unknown or unavailable catalogue metadata stays disabled; model names are never used to infer capability. Cannot be combined with first_available (set output_capabilities.image on the candidate models instead).
	OutputCapabilities ModelOutputCapabilitiesPtrInput `pulumi:"outputCapabilities"`
	// Whether to enable parallel tool calls
	ParallelToolCalls pulumi.BoolPtrInput `pulumi:"parallelToolCalls"`
	// Presence penalty
	PresencePenalty pulumi.Float64PtrInput `pulumi:"presencePenalty"`
	// Model provider (e.g., openai, anthropic, dmr)
	Provider pulumi.StringPtrInput `pulumi:"provider"`
	// Provider-specific options. Anthropic: thinking_prefix_mismatch (error or drop_block; defaults to drop_block on Fable/Mythos 5.1), strict_tools (true for eligible schemas or a tool-name array requiring strict mode), cache_diagnostics (boolean; Claude API only), native_compaction (boolean; synchronous whole-history signed compaction on Claude API), cache_preserving_updates (boolean; native system/tool/effort changes with turn-scoped reminders on supported models), thinking_display: updates (progress updates beta on Fable 5+ and Mythos 5.1). Sampling parameters: top_k (integer, supported by anthropic, google, amazon-bedrock, and custom OpenAI-compatible providers like vLLM/Ollama), repetition_penalty (float, forwarded to custom OpenAI-compatible providers), min_p (float, forwarded to custom providers), seed (integer, forwarded to OpenAI). Lifecycle: unload_api (string) overrides the unload endpoint inherited from the provider config (relative path resolved against base_url's scheme+host, or an absolute URL); used by the runtime's `unload` on_agent_switch builtin hook to release model resources between agent switches. Infrastructure options: http_headers (map of string to string, adds custom HTTP headers to every request; used for OpenAI-compatible providers like github-copilot which requires Copilot-Integration-Id). dmr: runtime_flags; supports_images (boolean) and supports_pdf (boolean) declare which document attachment types the local model accepts. DMR-hosted models are not in the models.dev catalog, so attachment capabilities cannot be detected automatically and default to text-only; set supports_images: true for a vision model so image attachments are forwarded instead of silently dropped. anthropic/amazon-bedrock (Claude): interleaved_thinking (boolean, default true). anthropic: thinking_display ('summarized', 'omitted', 'updates', or 'display') controls whether thinking blocks are returned in responses when thinking is enabled. Claude Opus 4.7 hides thinking by default ('omitted'); set thinking_display: summarized to receive thinking blocks. 'display' (full thinking blocks) is only accepted by pre-4.6 token-thinking models (e.g. Sonnet 4.5, Haiku 4.5); models from the adaptive-thinking generation onward (Opus/Sonnet 4.6+, Sonnet 5, Fable 5) reject it, and docker-agent fails fast with a configuration error (fallbacks models are validated too); fallbacks (array of model ID strings, in priority order; enables the server-side-fallback beta so requests refused by safety classifiers, e.g. on Claude Fable 5, are retried with the listed models in a single round trip). OpenAI-compatible APIs: service_tier (string, forwarded unchanged to Chat Completions and Responses, including WebSocket and reranking; 'fast' or 'priority' enables Fast mode at premium pricing on supported models; omitted or empty leaves the API default, non-string values are ignored). openai/chatgpt: preserve_reasoning (boolean, default false) preserves ordered Responses output and encrypted reasoning for stateless continuation; native_tool_search also enables output replay. openai: cache_diagnostics (boolean, default false) logs Responses prompt-cache comparison results with --debug on GPT-5.6+; comparisons are scoped to the current session and resolved model; ignored for chatgpt and custom base_url endpoints. transport ('sse' or 'websocket') to choose between SSE and WebSocket streaming for the Responses API; native_tool_search (boolean, default false; also enables ordered output replay) declares the agent's deferred tools with defer_loading and a server-executed tool_search tool so OpenAI's hosted tool search discovers them (only openai models supporting deferred tools, gpt-5.4+; ignored on chatgpt, OpenAI-compatible endpoints including a custom base_url, and Chat Completions requests). openai/anthropic/google: rerank_prompt (string) to fully override the system prompt used for RAG reranking (advanced - prefer using results.reranking.criteria for domain-specific guidance). Google: google_search (boolean) enables Google Search grounding, google_maps (boolean) enables Google Maps grounding, code_execution (boolean) enables server-side code execution, url_context (boolean) enables reading public URLs during generation, output_dimensionality (positive integer) truncates Gemini embedding vectors to that size when the model is used as a RAG embedding_model; service_tier (string, forwarded unchanged as the top-level serviceTier of every generateContent request, including reranking, title generation, and compaction, on the Gemini API, Vertex AI, and the Docker models gateway; 'flex' for discounted, queued processing that may wait up to 15 minutes before the first byte, 'standard' for the default tier, 'priority' for premium processing; omitted or empty leaves the API default, non-string values are ignored; cost estimates are not tier-adjusted, set the model's cost override).
	ProviderOpts pulumi.MapInput `pulumi:"providerOpts"`
	// Routing rules for request-based model selection. When configured, this model becomes a router that selects the best model based on the user's input. The model's provider/model fields define the fallback model.
	Routing RoutingRuleArrayInput `pulumi:"routing"`
	// Total-token budget for an agentic task (`task_budget`), forwarded to Anthropic as `output_config.task_budget`. The object form `{type: tokens, total: N}` is the same as `N`; `tokens` is the only type.
	TaskBudget pulumi.IntPtrInput `pulumi:"taskBudget"`
	// Sampling temperature
	Temperature pulumi.Float64PtrInput `pulumi:"temperature"`
	// Reasoning effort (`thinking_budget`) as a level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<level>`. Mutually exclusive with `thinkingBudgetTokens`.
	ThinkingBudget pulumi.StringPtrInput `pulumi:"thinkingBudget"`
	// Reasoning budget (`thinking_budget`) as a number of tokens. Mutually exclusive with `thinkingBudget`.
	ThinkingBudgetTokens pulumi.IntPtrInput `pulumi:"thinkingBudgetTokens"`
	// Model used to generate session titles when an agent runs with this model. Lets a heavyweight primary model delegate the cheap title-generation call to a smaller/faster model. Value can be a model name from the models section or an inline 'provider/model' spec. When omitted, title generation reuses the agent's own model.
	TitleModel pulumi.StringPtrInput `pulumi:"titleModel"`
	// Token key for authentication. Never put the secret itself in the configuration.
	TokenKey pulumi.StringPtrInput `pulumi:"tokenKey"`
	// Top-p sampling parameter
	TopP pulumi.Float64PtrInput `pulumi:"topP"`
	// Whether to track usage
	TrackUsage pulumi.BoolPtrInput `pulumi:"trackUsage"`
}

Configuration for a model

func (ModelDefArgs) ElementType

func (ModelDefArgs) ElementType() reflect.Type

func (ModelDefArgs) ToModelDefOutput

func (i ModelDefArgs) ToModelDefOutput() ModelDefOutput

func (ModelDefArgs) ToModelDefOutputWithContext

func (i ModelDefArgs) ToModelDefOutputWithContext(ctx context.Context) ModelDefOutput

type ModelDefInput

type ModelDefInput interface {
	pulumi.Input

	ToModelDefOutput() ModelDefOutput
	ToModelDefOutputWithContext(context.Context) ModelDefOutput
}

ModelDefInput is an input type that accepts ModelDefArgs and ModelDefOutput values. You can construct a concrete instance of `ModelDefInput` via:

ModelDefArgs{...}

type ModelDefMap

type ModelDefMap map[string]ModelDefInput

func (ModelDefMap) ElementType

func (ModelDefMap) ElementType() reflect.Type

func (ModelDefMap) ToModelDefMapOutput

func (i ModelDefMap) ToModelDefMapOutput() ModelDefMapOutput

func (ModelDefMap) ToModelDefMapOutputWithContext

func (i ModelDefMap) ToModelDefMapOutputWithContext(ctx context.Context) ModelDefMapOutput

type ModelDefMapInput

type ModelDefMapInput interface {
	pulumi.Input

	ToModelDefMapOutput() ModelDefMapOutput
	ToModelDefMapOutputWithContext(context.Context) ModelDefMapOutput
}

ModelDefMapInput is an input type that accepts ModelDefMap and ModelDefMapOutput values. You can construct a concrete instance of `ModelDefMapInput` via:

ModelDefMap{ "key": ModelDefArgs{...} }

type ModelDefMapOutput

type ModelDefMapOutput struct{ *pulumi.OutputState }

func (ModelDefMapOutput) ElementType

func (ModelDefMapOutput) ElementType() reflect.Type

func (ModelDefMapOutput) MapIndex

func (ModelDefMapOutput) ToModelDefMapOutput

func (o ModelDefMapOutput) ToModelDefMapOutput() ModelDefMapOutput

func (ModelDefMapOutput) ToModelDefMapOutputWithContext

func (o ModelDefMapOutput) ToModelDefMapOutputWithContext(ctx context.Context) ModelDefMapOutput

type ModelDefOutput

type ModelDefOutput struct{ *pulumi.OutputState }

Configuration for a model

func (ModelDefOutput) Auth

Non-API-key authentication scheme for this model. When set, takes precedence over both the provider's API-key path and any auth defined on the referenced ProviderConfig.

func (ModelDefOutput) BaseUrl

Base URL for the model API. Accepts ${env.VAR} / ${VAR} references, substituted from the environment when the model is loaded.

func (ModelDefOutput) BypassModelsGateway

func (o ModelDefOutput) BypassModelsGateway() pulumi.BoolPtrOutput

When true, this model connects directly to its provider, ignoring any configured models gateway (--models-gateway / DOCKER_AGENT_MODELS_GATEWAY). The model then authenticates with the provider's own credentials (e.g. OPENAI_API_KEY, ANTHROPIC_API_KEY, or token_key) instead of routing through the gateway. A custom base_url (set on the model or inherited from a custom provider definition) implies this bypass even when the flag is false.

func (ModelDefOutput) Capabilities

func (o ModelDefOutput) Capabilities() ModelCapabilitiesPtrOutput

Explicit attachment capability override for models the models.dev catalogue does not describe correctly (custom OpenAI-compatible providers, local models like Ollama, or dropped model versions). When set, the declared flags are authoritative and no models.dev lookup is performed; when omitted, capabilities are detected automatically. Without it, such models fall back to text-only and their image/PDF/audio/video attachments are silently dropped.

func (ModelDefOutput) CompactionModel

func (o ModelDefOutput) CompactionModel() pulumi.StringPtrOutput

Model used to summarize the conversation when this model's session is compacted (manual /compact, the proactive threshold trigger, or post-overflow recovery). The summary call ingests the whole conversation and is the slowest, most expensive call in a session; pointing this at a smaller/faster model makes compaction cheaper and more reliable without changing the model that runs the conversation. Value can be a model name from the models section or an inline 'provider/model' spec. The agent-level compaction_model takes precedence over this value, which in turn takes precedence over a provider-level default; when all are omitted, compaction reuses the agent's own model. If the compaction model has a smaller context window than the primary, compaction is triggered against the smaller window so the summary call can always ingest the conversation it must compact.

func (ModelDefOutput) CompactionThreshold

func (o ModelDefOutput) CompactionThreshold() pulumi.Float64PtrOutput

Fraction of the context window at which proactive auto-compaction triggers for agents running this model. Must be greater than 0 and at most 1. Defaults to 0.9 (90% of the context window). Takes precedence over the agent-level compaction_threshold. Cannot be combined with first_available.

func (ModelDefOutput) Cost

func (o ModelDefOutput) Cost() CostPtrOutput

Explicit token pricing (USD per 1M tokens), overriding the models.dev catalogue. Used for per-turn cost computation, session cost tracking, the /model picker, and the after_llm_call hook's cost field. Makes an uncatalogued model (custom base_url provider, local or private deployment) 'priced' instead of billing $0. Prices must not be negative; an all-zero table means 'priced, free'. Cannot be combined with first_available.

func (ModelDefOutput) Description

func (o ModelDefOutput) Description() pulumi.StringPtrOutput

Optional human-readable summary of the model's purpose or strengths (e.g. 'fast and cheap, good for summaries')

func (ModelDefOutput) ElementType

func (ModelDefOutput) ElementType() reflect.Type

func (ModelDefOutput) Extra

func (o ModelDefOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ModelDefOutput) FirstAvailable

func (o ModelDefOutput) FirstAvailable() pulumi.StringArrayOutput

Candidate model references in priority order. At load time docker-agent selects the first candidate whose credentials are configured. Candidates may be named models or inline 'provider/model' specs. Local providers (dmr, ollama) need no credentials and make reliable final fallbacks. Mutually exclusive with other model configuration fields.

func (ModelDefOutput) FrequencyPenalty

func (o ModelDefOutput) FrequencyPenalty() pulumi.Float64PtrOutput

Frequency penalty

func (ModelDefOutput) MaxTokens

func (o ModelDefOutput) MaxTokens() pulumi.IntPtrOutput

Maximum output tokens per response (the completion budget), NOT the context window. OpenAI-compatible servers require prompt_tokens + max_tokens to fit the context window, so a value close to the window leaves no room for the prompt. Set provider_opts.context_size to declare the window.

func (ModelDefOutput) Model

Model name

func (ModelDefOutput) OutputCapabilities

func (o ModelDefOutput) OutputCapabilities() ModelOutputCapabilitiesPtrOutput

Optional generative output capability override for this model. Resolution precedence is explicit false, explicit true, then the exact models.dev record's Modalities.Output=image for an omitted image flag (including an empty block). Unknown or unavailable catalogue metadata stays disabled; model names are never used to infer capability. Cannot be combined with first_available (set output_capabilities.image on the candidate models instead).

func (ModelDefOutput) ParallelToolCalls

func (o ModelDefOutput) ParallelToolCalls() pulumi.BoolPtrOutput

Whether to enable parallel tool calls

func (ModelDefOutput) PresencePenalty

func (o ModelDefOutput) PresencePenalty() pulumi.Float64PtrOutput

Presence penalty

func (ModelDefOutput) Provider

func (o ModelDefOutput) Provider() pulumi.StringPtrOutput

Model provider (e.g., openai, anthropic, dmr)

func (ModelDefOutput) ProviderOpts

func (o ModelDefOutput) ProviderOpts() pulumi.MapOutput

Provider-specific options. Anthropic: thinking_prefix_mismatch (error or drop_block; defaults to drop_block on Fable/Mythos 5.1), strict_tools (true for eligible schemas or a tool-name array requiring strict mode), cache_diagnostics (boolean; Claude API only), native_compaction (boolean; synchronous whole-history signed compaction on Claude API), cache_preserving_updates (boolean; native system/tool/effort changes with turn-scoped reminders on supported models), thinking_display: updates (progress updates beta on Fable 5+ and Mythos 5.1). Sampling parameters: top_k (integer, supported by anthropic, google, amazon-bedrock, and custom OpenAI-compatible providers like vLLM/Ollama), repetition_penalty (float, forwarded to custom OpenAI-compatible providers), min_p (float, forwarded to custom providers), seed (integer, forwarded to OpenAI). Lifecycle: unload_api (string) overrides the unload endpoint inherited from the provider config (relative path resolved against base_url's scheme+host, or an absolute URL); used by the runtime's `unload` on_agent_switch builtin hook to release model resources between agent switches. Infrastructure options: http_headers (map of string to string, adds custom HTTP headers to every request; used for OpenAI-compatible providers like github-copilot which requires Copilot-Integration-Id). dmr: runtime_flags; supports_images (boolean) and supports_pdf (boolean) declare which document attachment types the local model accepts. DMR-hosted models are not in the models.dev catalog, so attachment capabilities cannot be detected automatically and default to text-only; set supports_images: true for a vision model so image attachments are forwarded instead of silently dropped. anthropic/amazon-bedrock (Claude): interleaved_thinking (boolean, default true). anthropic: thinking_display ('summarized', 'omitted', 'updates', or 'display') controls whether thinking blocks are returned in responses when thinking is enabled. Claude Opus 4.7 hides thinking by default ('omitted'); set thinking_display: summarized to receive thinking blocks. 'display' (full thinking blocks) is only accepted by pre-4.6 token-thinking models (e.g. Sonnet 4.5, Haiku 4.5); models from the adaptive-thinking generation onward (Opus/Sonnet 4.6+, Sonnet 5, Fable 5) reject it, and docker-agent fails fast with a configuration error (fallbacks models are validated too); fallbacks (array of model ID strings, in priority order; enables the server-side-fallback beta so requests refused by safety classifiers, e.g. on Claude Fable 5, are retried with the listed models in a single round trip). OpenAI-compatible APIs: service_tier (string, forwarded unchanged to Chat Completions and Responses, including WebSocket and reranking; 'fast' or 'priority' enables Fast mode at premium pricing on supported models; omitted or empty leaves the API default, non-string values are ignored). openai/chatgpt: preserve_reasoning (boolean, default false) preserves ordered Responses output and encrypted reasoning for stateless continuation; native_tool_search also enables output replay. openai: cache_diagnostics (boolean, default false) logs Responses prompt-cache comparison results with --debug on GPT-5.6+; comparisons are scoped to the current session and resolved model; ignored for chatgpt and custom base_url endpoints. transport ('sse' or 'websocket') to choose between SSE and WebSocket streaming for the Responses API; native_tool_search (boolean, default false; also enables ordered output replay) declares the agent's deferred tools with defer_loading and a server-executed tool_search tool so OpenAI's hosted tool search discovers them (only openai models supporting deferred tools, gpt-5.4+; ignored on chatgpt, OpenAI-compatible endpoints including a custom base_url, and Chat Completions requests). openai/anthropic/google: rerank_prompt (string) to fully override the system prompt used for RAG reranking (advanced - prefer using results.reranking.criteria for domain-specific guidance). Google: google_search (boolean) enables Google Search grounding, google_maps (boolean) enables Google Maps grounding, code_execution (boolean) enables server-side code execution, url_context (boolean) enables reading public URLs during generation, output_dimensionality (positive integer) truncates Gemini embedding vectors to that size when the model is used as a RAG embedding_model; service_tier (string, forwarded unchanged as the top-level serviceTier of every generateContent request, including reranking, title generation, and compaction, on the Gemini API, Vertex AI, and the Docker models gateway; 'flex' for discounted, queued processing that may wait up to 15 minutes before the first byte, 'standard' for the default tier, 'priority' for premium processing; omitted or empty leaves the API default, non-string values are ignored; cost estimates are not tier-adjusted, set the model's cost override).

func (ModelDefOutput) Routing

Routing rules for request-based model selection. When configured, this model becomes a router that selects the best model based on the user's input. The model's provider/model fields define the fallback model.

func (ModelDefOutput) TaskBudget

func (o ModelDefOutput) TaskBudget() pulumi.IntPtrOutput

Total-token budget for an agentic task (`task_budget`), forwarded to Anthropic as `output_config.task_budget`. The object form `{type: tokens, total: N}` is the same as `N`; `tokens` is the only type.

func (ModelDefOutput) Temperature

func (o ModelDefOutput) Temperature() pulumi.Float64PtrOutput

Sampling temperature

func (ModelDefOutput) ThinkingBudget

func (o ModelDefOutput) ThinkingBudget() pulumi.StringPtrOutput

Reasoning effort (`thinking_budget`) as a level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<level>`. Mutually exclusive with `thinkingBudgetTokens`.

func (ModelDefOutput) ThinkingBudgetTokens

func (o ModelDefOutput) ThinkingBudgetTokens() pulumi.IntPtrOutput

Reasoning budget (`thinking_budget`) as a number of tokens. Mutually exclusive with `thinkingBudget`.

func (ModelDefOutput) TitleModel

func (o ModelDefOutput) TitleModel() pulumi.StringPtrOutput

Model used to generate session titles when an agent runs with this model. Lets a heavyweight primary model delegate the cheap title-generation call to a smaller/faster model. Value can be a model name from the models section or an inline 'provider/model' spec. When omitted, title generation reuses the agent's own model.

func (ModelDefOutput) ToModelDefOutput

func (o ModelDefOutput) ToModelDefOutput() ModelDefOutput

func (ModelDefOutput) ToModelDefOutputWithContext

func (o ModelDefOutput) ToModelDefOutputWithContext(ctx context.Context) ModelDefOutput

func (ModelDefOutput) TokenKey

func (o ModelDefOutput) TokenKey() pulumi.StringPtrOutput

Token key for authentication. Never put the secret itself in the configuration.

func (ModelDefOutput) TopP

Top-p sampling parameter

func (ModelDefOutput) TrackUsage

func (o ModelDefOutput) TrackUsage() pulumi.BoolPtrOutput

Whether to track usage

type ModelOutputCapabilities

type ModelOutputCapabilities struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Whether the model can generate image output. Explicit false takes precedence over explicit true; when omitted, Docker Agent uses the exact models.dev record's output modalities and otherwise leaves image output disabled.
	Image *bool `pulumi:"image"`
}

Generative output capability overrides for a model. Resolution precedence is explicit false, explicit true, then the exact models.dev record's Modalities.Output=image when the image flag is omitted, including an empty block. Unknown or unavailable catalogue metadata stays disabled; model names are never used to infer capability.

type ModelOutputCapabilitiesArgs

type ModelOutputCapabilitiesArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Whether the model can generate image output. Explicit false takes precedence over explicit true; when omitted, Docker Agent uses the exact models.dev record's output modalities and otherwise leaves image output disabled.
	Image pulumi.BoolPtrInput `pulumi:"image"`
}

Generative output capability overrides for a model. Resolution precedence is explicit false, explicit true, then the exact models.dev record's Modalities.Output=image when the image flag is omitted, including an empty block. Unknown or unavailable catalogue metadata stays disabled; model names are never used to infer capability.

func (ModelOutputCapabilitiesArgs) ElementType

func (ModelOutputCapabilitiesArgs) ToModelOutputCapabilitiesOutput

func (i ModelOutputCapabilitiesArgs) ToModelOutputCapabilitiesOutput() ModelOutputCapabilitiesOutput

func (ModelOutputCapabilitiesArgs) ToModelOutputCapabilitiesOutputWithContext

func (i ModelOutputCapabilitiesArgs) ToModelOutputCapabilitiesOutputWithContext(ctx context.Context) ModelOutputCapabilitiesOutput

func (ModelOutputCapabilitiesArgs) ToModelOutputCapabilitiesPtrOutput

func (i ModelOutputCapabilitiesArgs) ToModelOutputCapabilitiesPtrOutput() ModelOutputCapabilitiesPtrOutput

func (ModelOutputCapabilitiesArgs) ToModelOutputCapabilitiesPtrOutputWithContext

func (i ModelOutputCapabilitiesArgs) ToModelOutputCapabilitiesPtrOutputWithContext(ctx context.Context) ModelOutputCapabilitiesPtrOutput

type ModelOutputCapabilitiesInput

type ModelOutputCapabilitiesInput interface {
	pulumi.Input

	ToModelOutputCapabilitiesOutput() ModelOutputCapabilitiesOutput
	ToModelOutputCapabilitiesOutputWithContext(context.Context) ModelOutputCapabilitiesOutput
}

ModelOutputCapabilitiesInput is an input type that accepts ModelOutputCapabilitiesArgs and ModelOutputCapabilitiesOutput values. You can construct a concrete instance of `ModelOutputCapabilitiesInput` via:

ModelOutputCapabilitiesArgs{...}

type ModelOutputCapabilitiesOutput

type ModelOutputCapabilitiesOutput struct{ *pulumi.OutputState }

Generative output capability overrides for a model. Resolution precedence is explicit false, explicit true, then the exact models.dev record's Modalities.Output=image when the image flag is omitted, including an empty block. Unknown or unavailable catalogue metadata stays disabled; model names are never used to infer capability.

func (ModelOutputCapabilitiesOutput) ElementType

func (ModelOutputCapabilitiesOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ModelOutputCapabilitiesOutput) Image

Whether the model can generate image output. Explicit false takes precedence over explicit true; when omitted, Docker Agent uses the exact models.dev record's output modalities and otherwise leaves image output disabled.

func (ModelOutputCapabilitiesOutput) ToModelOutputCapabilitiesOutput

func (o ModelOutputCapabilitiesOutput) ToModelOutputCapabilitiesOutput() ModelOutputCapabilitiesOutput

func (ModelOutputCapabilitiesOutput) ToModelOutputCapabilitiesOutputWithContext

func (o ModelOutputCapabilitiesOutput) ToModelOutputCapabilitiesOutputWithContext(ctx context.Context) ModelOutputCapabilitiesOutput

func (ModelOutputCapabilitiesOutput) ToModelOutputCapabilitiesPtrOutput

func (o ModelOutputCapabilitiesOutput) ToModelOutputCapabilitiesPtrOutput() ModelOutputCapabilitiesPtrOutput

func (ModelOutputCapabilitiesOutput) ToModelOutputCapabilitiesPtrOutputWithContext

func (o ModelOutputCapabilitiesOutput) ToModelOutputCapabilitiesPtrOutputWithContext(ctx context.Context) ModelOutputCapabilitiesPtrOutput

type ModelOutputCapabilitiesPtrInput

type ModelOutputCapabilitiesPtrInput interface {
	pulumi.Input

	ToModelOutputCapabilitiesPtrOutput() ModelOutputCapabilitiesPtrOutput
	ToModelOutputCapabilitiesPtrOutputWithContext(context.Context) ModelOutputCapabilitiesPtrOutput
}

ModelOutputCapabilitiesPtrInput is an input type that accepts ModelOutputCapabilitiesArgs, ModelOutputCapabilitiesPtr and ModelOutputCapabilitiesPtrOutput values. You can construct a concrete instance of `ModelOutputCapabilitiesPtrInput` via:

        ModelOutputCapabilitiesArgs{...}

or:

        nil

type ModelOutputCapabilitiesPtrOutput

type ModelOutputCapabilitiesPtrOutput struct{ *pulumi.OutputState }

func (ModelOutputCapabilitiesPtrOutput) Elem

func (ModelOutputCapabilitiesPtrOutput) ElementType

func (ModelOutputCapabilitiesPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ModelOutputCapabilitiesPtrOutput) Image

Whether the model can generate image output. Explicit false takes precedence over explicit true; when omitted, Docker Agent uses the exact models.dev record's output modalities and otherwise leaves image output disabled.

func (ModelOutputCapabilitiesPtrOutput) ToModelOutputCapabilitiesPtrOutput

func (o ModelOutputCapabilitiesPtrOutput) ToModelOutputCapabilitiesPtrOutput() ModelOutputCapabilitiesPtrOutput

func (ModelOutputCapabilitiesPtrOutput) ToModelOutputCapabilitiesPtrOutputWithContext

func (o ModelOutputCapabilitiesPtrOutput) ToModelOutputCapabilitiesPtrOutputWithContext(ctx context.Context) ModelOutputCapabilitiesPtrOutput

type Permissions

type Permissions struct {
	// Tool patterns that are auto-approved without user confirmation. Supports tool names with glob patterns (e.g., 'read_*') and argument matching (e.g., 'shell:cmd=ls*' to allow shell commands starting with 'ls'). MCP tools can use qualified names (e.g., 'mcp:github:*').
	Allow []string `pulumi:"allow"`
	// Tool patterns that always require user confirmation, even for tools that are normally auto-approved (e.g. read-only tools). Supports the same pattern syntax as allow: tool names with globs and argument matching (e.g., 'fetch' to always ask before fetching URLs).
	Ask []string `pulumi:"ask"`
	// Tool patterns that are always rejected. Takes priority over allow patterns. Supports the same pattern syntax as allow: tool names with globs and argument matching (e.g., 'shell:cmd=rm -rf*' to block dangerous rm commands).
	Deny []string `pulumi:"deny"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
}

Tool permission configuration. Controls tool call approval behavior with optional argument matching.

type PermissionsArgs

type PermissionsArgs struct {
	// Tool patterns that are auto-approved without user confirmation. Supports tool names with glob patterns (e.g., 'read_*') and argument matching (e.g., 'shell:cmd=ls*' to allow shell commands starting with 'ls'). MCP tools can use qualified names (e.g., 'mcp:github:*').
	Allow pulumi.StringArrayInput `pulumi:"allow"`
	// Tool patterns that always require user confirmation, even for tools that are normally auto-approved (e.g. read-only tools). Supports the same pattern syntax as allow: tool names with globs and argument matching (e.g., 'fetch' to always ask before fetching URLs).
	Ask pulumi.StringArrayInput `pulumi:"ask"`
	// Tool patterns that are always rejected. Takes priority over allow patterns. Supports the same pattern syntax as allow: tool names with globs and argument matching (e.g., 'shell:cmd=rm -rf*' to block dangerous rm commands).
	Deny pulumi.StringArrayInput `pulumi:"deny"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
}

Tool permission configuration. Controls tool call approval behavior with optional argument matching.

func (PermissionsArgs) ElementType

func (PermissionsArgs) ElementType() reflect.Type

func (PermissionsArgs) ToPermissionsOutput

func (i PermissionsArgs) ToPermissionsOutput() PermissionsOutput

func (PermissionsArgs) ToPermissionsOutputWithContext

func (i PermissionsArgs) ToPermissionsOutputWithContext(ctx context.Context) PermissionsOutput

func (PermissionsArgs) ToPermissionsPtrOutput

func (i PermissionsArgs) ToPermissionsPtrOutput() PermissionsPtrOutput

func (PermissionsArgs) ToPermissionsPtrOutputWithContext

func (i PermissionsArgs) ToPermissionsPtrOutputWithContext(ctx context.Context) PermissionsPtrOutput

type PermissionsInput

type PermissionsInput interface {
	pulumi.Input

	ToPermissionsOutput() PermissionsOutput
	ToPermissionsOutputWithContext(context.Context) PermissionsOutput
}

PermissionsInput is an input type that accepts PermissionsArgs and PermissionsOutput values. You can construct a concrete instance of `PermissionsInput` via:

PermissionsArgs{...}

type PermissionsOutput

type PermissionsOutput struct{ *pulumi.OutputState }

Tool permission configuration. Controls tool call approval behavior with optional argument matching.

func (PermissionsOutput) Allow

Tool patterns that are auto-approved without user confirmation. Supports tool names with glob patterns (e.g., 'read_*') and argument matching (e.g., 'shell:cmd=ls*' to allow shell commands starting with 'ls'). MCP tools can use qualified names (e.g., 'mcp:github:*').

func (PermissionsOutput) Ask

Tool patterns that always require user confirmation, even for tools that are normally auto-approved (e.g. read-only tools). Supports the same pattern syntax as allow: tool names with globs and argument matching (e.g., 'fetch' to always ask before fetching URLs).

func (PermissionsOutput) Deny

Tool patterns that are always rejected. Takes priority over allow patterns. Supports the same pattern syntax as allow: tool names with globs and argument matching (e.g., 'shell:cmd=rm -rf*' to block dangerous rm commands).

func (PermissionsOutput) ElementType

func (PermissionsOutput) ElementType() reflect.Type

func (PermissionsOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (PermissionsOutput) ToPermissionsOutput

func (o PermissionsOutput) ToPermissionsOutput() PermissionsOutput

func (PermissionsOutput) ToPermissionsOutputWithContext

func (o PermissionsOutput) ToPermissionsOutputWithContext(ctx context.Context) PermissionsOutput

func (PermissionsOutput) ToPermissionsPtrOutput

func (o PermissionsOutput) ToPermissionsPtrOutput() PermissionsPtrOutput

func (PermissionsOutput) ToPermissionsPtrOutputWithContext

func (o PermissionsOutput) ToPermissionsPtrOutputWithContext(ctx context.Context) PermissionsPtrOutput

type PermissionsPtrInput

type PermissionsPtrInput interface {
	pulumi.Input

	ToPermissionsPtrOutput() PermissionsPtrOutput
	ToPermissionsPtrOutputWithContext(context.Context) PermissionsPtrOutput
}

PermissionsPtrInput is an input type that accepts PermissionsArgs, PermissionsPtr and PermissionsPtrOutput values. You can construct a concrete instance of `PermissionsPtrInput` via:

        PermissionsArgs{...}

or:

        nil

func PermissionsPtr

func PermissionsPtr(v *PermissionsArgs) PermissionsPtrInput

type PermissionsPtrOutput

type PermissionsPtrOutput struct{ *pulumi.OutputState }

func (PermissionsPtrOutput) Allow

Tool patterns that are auto-approved without user confirmation. Supports tool names with glob patterns (e.g., 'read_*') and argument matching (e.g., 'shell:cmd=ls*' to allow shell commands starting with 'ls'). MCP tools can use qualified names (e.g., 'mcp:github:*').

func (PermissionsPtrOutput) Ask

Tool patterns that always require user confirmation, even for tools that are normally auto-approved (e.g. read-only tools). Supports the same pattern syntax as allow: tool names with globs and argument matching (e.g., 'fetch' to always ask before fetching URLs).

func (PermissionsPtrOutput) Deny

Tool patterns that are always rejected. Takes priority over allow patterns. Supports the same pattern syntax as allow: tool names with globs and argument matching (e.g., 'shell:cmd=rm -rf*' to block dangerous rm commands).

func (PermissionsPtrOutput) Elem

func (PermissionsPtrOutput) ElementType

func (PermissionsPtrOutput) ElementType() reflect.Type

func (PermissionsPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (PermissionsPtrOutput) ToPermissionsPtrOutput

func (o PermissionsPtrOutput) ToPermissionsPtrOutput() PermissionsPtrOutput

func (PermissionsPtrOutput) ToPermissionsPtrOutputWithContext

func (o PermissionsPtrOutput) ToPermissionsPtrOutputWithContext(ctx context.Context) PermissionsPtrOutput

type PostEdit

type PostEdit struct {
	// Command to execute after edit
	Cmd string `pulumi:"cmd"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Path pattern for files to apply post-edit command
	Path string `pulumi:"path"`
}

Post-edit command configuration

type PostEditArgs

type PostEditArgs struct {
	// Command to execute after edit
	Cmd pulumi.StringInput `pulumi:"cmd"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Path pattern for files to apply post-edit command
	Path pulumi.StringInput `pulumi:"path"`
}

Post-edit command configuration

func (PostEditArgs) ElementType

func (PostEditArgs) ElementType() reflect.Type

func (PostEditArgs) ToPostEditOutput

func (i PostEditArgs) ToPostEditOutput() PostEditOutput

func (PostEditArgs) ToPostEditOutputWithContext

func (i PostEditArgs) ToPostEditOutputWithContext(ctx context.Context) PostEditOutput

type PostEditArray

type PostEditArray []PostEditInput

func (PostEditArray) ElementType

func (PostEditArray) ElementType() reflect.Type

func (PostEditArray) ToPostEditArrayOutput

func (i PostEditArray) ToPostEditArrayOutput() PostEditArrayOutput

func (PostEditArray) ToPostEditArrayOutputWithContext

func (i PostEditArray) ToPostEditArrayOutputWithContext(ctx context.Context) PostEditArrayOutput

type PostEditArrayInput

type PostEditArrayInput interface {
	pulumi.Input

	ToPostEditArrayOutput() PostEditArrayOutput
	ToPostEditArrayOutputWithContext(context.Context) PostEditArrayOutput
}

PostEditArrayInput is an input type that accepts PostEditArray and PostEditArrayOutput values. You can construct a concrete instance of `PostEditArrayInput` via:

PostEditArray{ PostEditArgs{...} }

type PostEditArrayOutput

type PostEditArrayOutput struct{ *pulumi.OutputState }

func (PostEditArrayOutput) ElementType

func (PostEditArrayOutput) ElementType() reflect.Type

func (PostEditArrayOutput) Index

func (PostEditArrayOutput) ToPostEditArrayOutput

func (o PostEditArrayOutput) ToPostEditArrayOutput() PostEditArrayOutput

func (PostEditArrayOutput) ToPostEditArrayOutputWithContext

func (o PostEditArrayOutput) ToPostEditArrayOutputWithContext(ctx context.Context) PostEditArrayOutput

type PostEditInput

type PostEditInput interface {
	pulumi.Input

	ToPostEditOutput() PostEditOutput
	ToPostEditOutputWithContext(context.Context) PostEditOutput
}

PostEditInput is an input type that accepts PostEditArgs and PostEditOutput values. You can construct a concrete instance of `PostEditInput` via:

PostEditArgs{...}

type PostEditOutput

type PostEditOutput struct{ *pulumi.OutputState }

Post-edit command configuration

func (PostEditOutput) Cmd

Command to execute after edit

func (PostEditOutput) ElementType

func (PostEditOutput) ElementType() reflect.Type

func (PostEditOutput) Extra

func (o PostEditOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (PostEditOutput) Path

Path pattern for files to apply post-edit command

func (PostEditOutput) ToPostEditOutput

func (o PostEditOutput) ToPostEditOutput() PostEditOutput

func (PostEditOutput) ToPostEditOutputWithContext

func (o PostEditOutput) ToPostEditOutputWithContext(ctx context.Context) PostEditOutput

type Provider

type Provider struct {
	pulumi.ProviderResourceState
}

func NewProvider

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs

type ProviderArgs struct {
	// Refuse plain-HTTP connections to registries. Like the `docker agent` CLI, the provider tries HTTPS first and falls back to plain HTTP for `localhost`, `*.localhost`, loopback and private (RFC 1918: 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) addresses, which sends registry credentials unencrypted. With `forceHttps` only localhost and loopback registries may use plain HTTP; set `insecure: true` on a resource or `getAgent` call to allow it for a specific registry.
	ForceHttps pulumi.BoolPtrInput
	// Credentials for OCI registries, used to push, pull and delete agent artifacts. They are sent from the first request to a matching registry. Registries without an entry fall back to the Docker credential store (`~/.docker/config.json` or `$DOCKER_CONFIG`, including credential helpers), so `docker login` is enough for most setups.
	RegistryAuth RegistryAuthArrayInput
	// Skip validating agent configurations and user settings with the bundled docker-agent library for every resource of this provider. Use it when your configuration relies on docker-agent features newer than the library version the provider was built with.
	SkipValidation pulumi.BoolPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType

func (ProviderArgs) ElementType() reflect.Type

type ProviderDef

type ProviderDef struct {
	// The API schema type to use. Only applicable for OpenAI-compatible providers. Defaults to `openai_chatcompletions`.
	ApiType *ApiType `pulumi:"apiType"`
	// Non-API-key authentication scheme. When set, the provider's regular API-key path is bypassed.
	Auth *ModelAuth `pulumi:"auth"`
	// Base URL for the provider's API endpoint. Required for OpenAI-compatible providers, optional for native providers. Accepts ${env.VAR} / ${VAR} references, substituted from the environment when a model using this provider is loaded.
	BaseUrl *string `pulumi:"baseUrl"`
	// Default model used to summarize the conversation when the session of an agent whose model uses this provider is compacted. Value can be a model name from the models section or an inline 'provider/model' spec. Lowest priority in the resolution chain: an agent-level compaction_model wins, then a model-level one, then this provider-level default; when all are omitted, compaction reuses the agent's own model.
	CompactionModel *string `pulumi:"compactionModel"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Default frequency penalty.
	FrequencyPenalty *float64 `pulumi:"frequencyPenalty"`
	// Default maximum output tokens per response for models using this provider. This is the completion budget, NOT the context window: OpenAI-compatible servers require prompt_tokens + max_tokens to fit the context window, so a value close to the window leaves no room for the prompt. Set provider_opts.context_size to declare the window.
	MaxTokens *int `pulumi:"maxTokens"`
	// Whether to enable parallel tool calls by default.
	ParallelToolCalls *bool `pulumi:"parallelToolCalls"`
	// Default presence penalty.
	PresencePenalty *float64 `pulumi:"presencePenalty"`
	// The underlying provider type. Defaults to "openai" when not set. Supported values: openai, anthropic, google, amazon-bedrock, dmr, and any built-in alias (requesty, openrouter, azure, xai, ollama, mistral, baseten, daoxe, ovhcloud, groq, fireworks-ai, deepseek, cerebras, togetherai, huggingface, moonshotai, vercel, cloudflare-workers-ai, cloudflare-ai-gateway, nvidia, github-copilot, chatgpt, opencode, opencode-go, etc.).
	Provider *string `pulumi:"provider"`
	// Provider-specific options passed through to the underlying client. Anthropic: thinking_prefix_mismatch (error or drop_block), thinking_display (including updates on supported Fable/Mythos models), strict_tools (boolean or list of tool names), cache_diagnostics (boolean), native_compaction (boolean), cache_preserving_updates (boolean). OpenAI-compatible APIs: service_tier (string) selects the processing tier for Chat Completions and Responses requests; use 'fast' or 'priority' for Fast mode at premium pricing on supported models. Google (Gemini): service_tier (string) selects the Gemini API service tier ('flex', 'standard', or 'priority'). Model-level options override these defaults.
	ProviderOpts map[string]interface{} `pulumi:"providerOpts"`
	// Total-token budget for an agentic task (`task_budget`), forwarded to Anthropic as `output_config.task_budget`. The object form `{type: tokens, total: N}` is the same as `N`; `tokens` is the only type.
	TaskBudget *int `pulumi:"taskBudget"`
	// Default sampling temperature for models using this provider.
	Temperature *float64 `pulumi:"temperature"`
	// Reasoning effort (`thinking_budget`) as a level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<level>`. Mutually exclusive with `thinkingBudgetTokens`.
	ThinkingBudget *string `pulumi:"thinkingBudget"`
	// Reasoning budget (`thinking_budget`) as a number of tokens. Mutually exclusive with `thinkingBudget`.
	ThinkingBudgetTokens *int `pulumi:"thinkingBudgetTokens"`
	// Environment variable name containing the API token. If not set, requests will use the default token for the provider type. Never put the secret itself in the configuration.
	TokenKey *string `pulumi:"tokenKey"`
	// Default top-p (nucleus) sampling parameter.
	TopP *float64 `pulumi:"topP"`
	// Whether to track token usage by default.
	TrackUsage *bool `pulumi:"trackUsage"`
	// Optional path (or absolute URL) to the provider's model-unload endpoint. POSTed with `{"model": "<id>"}` when the agent wires the `unload` builtin into its `on_agent_switch` hook chain, to free GPU/RAM held by the previous model. Today only Docker Model Runner exposes such an endpoint; the `unload` builtin is a pure HTTP hook that silently skips non-DMR providers. A relative path is resolved against the scheme+host of base_url; an absolute URL is used verbatim.
	UnloadApi *string `pulumi:"unloadApi"`
}

Configuration for a model provider. Defines reusable defaults that models can inherit by referencing the provider name. Supports any provider type (openai, anthropic, google, amazon-bedrock, etc.).

type ProviderDefArgs

type ProviderDefArgs struct {
	// The API schema type to use. Only applicable for OpenAI-compatible providers. Defaults to `openai_chatcompletions`.
	ApiType ApiTypePtrInput `pulumi:"apiType"`
	// Non-API-key authentication scheme. When set, the provider's regular API-key path is bypassed.
	Auth ModelAuthPtrInput `pulumi:"auth"`
	// Base URL for the provider's API endpoint. Required for OpenAI-compatible providers, optional for native providers. Accepts ${env.VAR} / ${VAR} references, substituted from the environment when a model using this provider is loaded.
	BaseUrl pulumi.StringPtrInput `pulumi:"baseUrl"`
	// Default model used to summarize the conversation when the session of an agent whose model uses this provider is compacted. Value can be a model name from the models section or an inline 'provider/model' spec. Lowest priority in the resolution chain: an agent-level compaction_model wins, then a model-level one, then this provider-level default; when all are omitted, compaction reuses the agent's own model.
	CompactionModel pulumi.StringPtrInput `pulumi:"compactionModel"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Default frequency penalty.
	FrequencyPenalty pulumi.Float64PtrInput `pulumi:"frequencyPenalty"`
	// Default maximum output tokens per response for models using this provider. This is the completion budget, NOT the context window: OpenAI-compatible servers require prompt_tokens + max_tokens to fit the context window, so a value close to the window leaves no room for the prompt. Set provider_opts.context_size to declare the window.
	MaxTokens pulumi.IntPtrInput `pulumi:"maxTokens"`
	// Whether to enable parallel tool calls by default.
	ParallelToolCalls pulumi.BoolPtrInput `pulumi:"parallelToolCalls"`
	// Default presence penalty.
	PresencePenalty pulumi.Float64PtrInput `pulumi:"presencePenalty"`
	// The underlying provider type. Defaults to "openai" when not set. Supported values: openai, anthropic, google, amazon-bedrock, dmr, and any built-in alias (requesty, openrouter, azure, xai, ollama, mistral, baseten, daoxe, ovhcloud, groq, fireworks-ai, deepseek, cerebras, togetherai, huggingface, moonshotai, vercel, cloudflare-workers-ai, cloudflare-ai-gateway, nvidia, github-copilot, chatgpt, opencode, opencode-go, etc.).
	Provider pulumi.StringPtrInput `pulumi:"provider"`
	// Provider-specific options passed through to the underlying client. Anthropic: thinking_prefix_mismatch (error or drop_block), thinking_display (including updates on supported Fable/Mythos models), strict_tools (boolean or list of tool names), cache_diagnostics (boolean), native_compaction (boolean), cache_preserving_updates (boolean). OpenAI-compatible APIs: service_tier (string) selects the processing tier for Chat Completions and Responses requests; use 'fast' or 'priority' for Fast mode at premium pricing on supported models. Google (Gemini): service_tier (string) selects the Gemini API service tier ('flex', 'standard', or 'priority'). Model-level options override these defaults.
	ProviderOpts pulumi.MapInput `pulumi:"providerOpts"`
	// Total-token budget for an agentic task (`task_budget`), forwarded to Anthropic as `output_config.task_budget`. The object form `{type: tokens, total: N}` is the same as `N`; `tokens` is the only type.
	TaskBudget pulumi.IntPtrInput `pulumi:"taskBudget"`
	// Default sampling temperature for models using this provider.
	Temperature pulumi.Float64PtrInput `pulumi:"temperature"`
	// Reasoning effort (`thinking_budget`) as a level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<level>`. Mutually exclusive with `thinkingBudgetTokens`.
	ThinkingBudget pulumi.StringPtrInput `pulumi:"thinkingBudget"`
	// Reasoning budget (`thinking_budget`) as a number of tokens. Mutually exclusive with `thinkingBudget`.
	ThinkingBudgetTokens pulumi.IntPtrInput `pulumi:"thinkingBudgetTokens"`
	// Environment variable name containing the API token. If not set, requests will use the default token for the provider type. Never put the secret itself in the configuration.
	TokenKey pulumi.StringPtrInput `pulumi:"tokenKey"`
	// Default top-p (nucleus) sampling parameter.
	TopP pulumi.Float64PtrInput `pulumi:"topP"`
	// Whether to track token usage by default.
	TrackUsage pulumi.BoolPtrInput `pulumi:"trackUsage"`
	// Optional path (or absolute URL) to the provider's model-unload endpoint. POSTed with `{"model": "<id>"}` when the agent wires the `unload` builtin into its `on_agent_switch` hook chain, to free GPU/RAM held by the previous model. Today only Docker Model Runner exposes such an endpoint; the `unload` builtin is a pure HTTP hook that silently skips non-DMR providers. A relative path is resolved against the scheme+host of base_url; an absolute URL is used verbatim.
	UnloadApi pulumi.StringPtrInput `pulumi:"unloadApi"`
}

Configuration for a model provider. Defines reusable defaults that models can inherit by referencing the provider name. Supports any provider type (openai, anthropic, google, amazon-bedrock, etc.).

func (ProviderDefArgs) ElementType

func (ProviderDefArgs) ElementType() reflect.Type

func (ProviderDefArgs) ToProviderDefOutput

func (i ProviderDefArgs) ToProviderDefOutput() ProviderDefOutput

func (ProviderDefArgs) ToProviderDefOutputWithContext

func (i ProviderDefArgs) ToProviderDefOutputWithContext(ctx context.Context) ProviderDefOutput

type ProviderDefInput

type ProviderDefInput interface {
	pulumi.Input

	ToProviderDefOutput() ProviderDefOutput
	ToProviderDefOutputWithContext(context.Context) ProviderDefOutput
}

ProviderDefInput is an input type that accepts ProviderDefArgs and ProviderDefOutput values. You can construct a concrete instance of `ProviderDefInput` via:

ProviderDefArgs{...}

type ProviderDefMap

type ProviderDefMap map[string]ProviderDefInput

func (ProviderDefMap) ElementType

func (ProviderDefMap) ElementType() reflect.Type

func (ProviderDefMap) ToProviderDefMapOutput

func (i ProviderDefMap) ToProviderDefMapOutput() ProviderDefMapOutput

func (ProviderDefMap) ToProviderDefMapOutputWithContext

func (i ProviderDefMap) ToProviderDefMapOutputWithContext(ctx context.Context) ProviderDefMapOutput

type ProviderDefMapInput

type ProviderDefMapInput interface {
	pulumi.Input

	ToProviderDefMapOutput() ProviderDefMapOutput
	ToProviderDefMapOutputWithContext(context.Context) ProviderDefMapOutput
}

ProviderDefMapInput is an input type that accepts ProviderDefMap and ProviderDefMapOutput values. You can construct a concrete instance of `ProviderDefMapInput` via:

ProviderDefMap{ "key": ProviderDefArgs{...} }

type ProviderDefMapOutput

type ProviderDefMapOutput struct{ *pulumi.OutputState }

func (ProviderDefMapOutput) ElementType

func (ProviderDefMapOutput) ElementType() reflect.Type

func (ProviderDefMapOutput) MapIndex

func (ProviderDefMapOutput) ToProviderDefMapOutput

func (o ProviderDefMapOutput) ToProviderDefMapOutput() ProviderDefMapOutput

func (ProviderDefMapOutput) ToProviderDefMapOutputWithContext

func (o ProviderDefMapOutput) ToProviderDefMapOutputWithContext(ctx context.Context) ProviderDefMapOutput

type ProviderDefOutput

type ProviderDefOutput struct{ *pulumi.OutputState }

Configuration for a model provider. Defines reusable defaults that models can inherit by referencing the provider name. Supports any provider type (openai, anthropic, google, amazon-bedrock, etc.).

func (ProviderDefOutput) ApiType

func (o ProviderDefOutput) ApiType() ApiTypePtrOutput

The API schema type to use. Only applicable for OpenAI-compatible providers. Defaults to `openai_chatcompletions`.

func (ProviderDefOutput) Auth

Non-API-key authentication scheme. When set, the provider's regular API-key path is bypassed.

func (ProviderDefOutput) BaseUrl

Base URL for the provider's API endpoint. Required for OpenAI-compatible providers, optional for native providers. Accepts ${env.VAR} / ${VAR} references, substituted from the environment when a model using this provider is loaded.

func (ProviderDefOutput) CompactionModel

func (o ProviderDefOutput) CompactionModel() pulumi.StringPtrOutput

Default model used to summarize the conversation when the session of an agent whose model uses this provider is compacted. Value can be a model name from the models section or an inline 'provider/model' spec. Lowest priority in the resolution chain: an agent-level compaction_model wins, then a model-level one, then this provider-level default; when all are omitted, compaction reuses the agent's own model.

func (ProviderDefOutput) ElementType

func (ProviderDefOutput) ElementType() reflect.Type

func (ProviderDefOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ProviderDefOutput) FrequencyPenalty

func (o ProviderDefOutput) FrequencyPenalty() pulumi.Float64PtrOutput

Default frequency penalty.

func (ProviderDefOutput) MaxTokens

func (o ProviderDefOutput) MaxTokens() pulumi.IntPtrOutput

Default maximum output tokens per response for models using this provider. This is the completion budget, NOT the context window: OpenAI-compatible servers require prompt_tokens + max_tokens to fit the context window, so a value close to the window leaves no room for the prompt. Set provider_opts.context_size to declare the window.

func (ProviderDefOutput) ParallelToolCalls

func (o ProviderDefOutput) ParallelToolCalls() pulumi.BoolPtrOutput

Whether to enable parallel tool calls by default.

func (ProviderDefOutput) PresencePenalty

func (o ProviderDefOutput) PresencePenalty() pulumi.Float64PtrOutput

Default presence penalty.

func (ProviderDefOutput) Provider

The underlying provider type. Defaults to "openai" when not set. Supported values: openai, anthropic, google, amazon-bedrock, dmr, and any built-in alias (requesty, openrouter, azure, xai, ollama, mistral, baseten, daoxe, ovhcloud, groq, fireworks-ai, deepseek, cerebras, togetherai, huggingface, moonshotai, vercel, cloudflare-workers-ai, cloudflare-ai-gateway, nvidia, github-copilot, chatgpt, opencode, opencode-go, etc.).

func (ProviderDefOutput) ProviderOpts

func (o ProviderDefOutput) ProviderOpts() pulumi.MapOutput

Provider-specific options passed through to the underlying client. Anthropic: thinking_prefix_mismatch (error or drop_block), thinking_display (including updates on supported Fable/Mythos models), strict_tools (boolean or list of tool names), cache_diagnostics (boolean), native_compaction (boolean), cache_preserving_updates (boolean). OpenAI-compatible APIs: service_tier (string) selects the processing tier for Chat Completions and Responses requests; use 'fast' or 'priority' for Fast mode at premium pricing on supported models. Google (Gemini): service_tier (string) selects the Gemini API service tier ('flex', 'standard', or 'priority'). Model-level options override these defaults.

func (ProviderDefOutput) TaskBudget

func (o ProviderDefOutput) TaskBudget() pulumi.IntPtrOutput

Total-token budget for an agentic task (`task_budget`), forwarded to Anthropic as `output_config.task_budget`. The object form `{type: tokens, total: N}` is the same as `N`; `tokens` is the only type.

func (ProviderDefOutput) Temperature

func (o ProviderDefOutput) Temperature() pulumi.Float64PtrOutput

Default sampling temperature for models using this provider.

func (ProviderDefOutput) ThinkingBudget

func (o ProviderDefOutput) ThinkingBudget() pulumi.StringPtrOutput

Reasoning effort (`thinking_budget`) as a level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<level>`. Mutually exclusive with `thinkingBudgetTokens`.

func (ProviderDefOutput) ThinkingBudgetTokens

func (o ProviderDefOutput) ThinkingBudgetTokens() pulumi.IntPtrOutput

Reasoning budget (`thinking_budget`) as a number of tokens. Mutually exclusive with `thinkingBudget`.

func (ProviderDefOutput) ToProviderDefOutput

func (o ProviderDefOutput) ToProviderDefOutput() ProviderDefOutput

func (ProviderDefOutput) ToProviderDefOutputWithContext

func (o ProviderDefOutput) ToProviderDefOutputWithContext(ctx context.Context) ProviderDefOutput

func (ProviderDefOutput) TokenKey

Environment variable name containing the API token. If not set, requests will use the default token for the provider type. Never put the secret itself in the configuration.

func (ProviderDefOutput) TopP

Default top-p (nucleus) sampling parameter.

func (ProviderDefOutput) TrackUsage

func (o ProviderDefOutput) TrackUsage() pulumi.BoolPtrOutput

Whether to track token usage by default.

func (ProviderDefOutput) UnloadApi

Optional path (or absolute URL) to the provider's model-unload endpoint. POSTed with `{"model": "<id>"}` when the agent wires the `unload` builtin into its `on_agent_switch` hook chain, to free GPU/RAM held by the previous model. Today only Docker Model Runner exposes such an endpoint; the `unload` builtin is a pure HTTP hook that silently skips non-DMR providers. A relative path is resolved against the scheme+host of base_url; an absolute URL is used verbatim.

type ProviderInput

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ElementType

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) ToProviderOutput

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type RagChunking

type RagChunking struct {
	// Enable code-aware chunking for source files. When true, the chunking strategy will prefer AST-based or language-aware processors when available (tree-sitter based), and fall back to plain text chunking for unsupported languages.
	CodeAware *bool `pulumi:"codeAware"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Overlap between chunks in characters. If unset, defaults to 75 in the implementation.
	Overlap *int `pulumi:"overlap"`
	// When true, chunks will split on the nearest whitespace boundary instead of at the exact character limit, preventing words from being truncated.
	RespectWordBoundaries *bool `pulumi:"respectWordBoundaries"`
	// Chunk size in characters. If unset, defaults to 1000 in the implementation.
	Size *int `pulumi:"size"`
}

Text chunking configuration

type RagChunkingArgs

type RagChunkingArgs struct {
	// Enable code-aware chunking for source files. When true, the chunking strategy will prefer AST-based or language-aware processors when available (tree-sitter based), and fall back to plain text chunking for unsupported languages.
	CodeAware pulumi.BoolPtrInput `pulumi:"codeAware"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Overlap between chunks in characters. If unset, defaults to 75 in the implementation.
	Overlap pulumi.IntPtrInput `pulumi:"overlap"`
	// When true, chunks will split on the nearest whitespace boundary instead of at the exact character limit, preventing words from being truncated.
	RespectWordBoundaries pulumi.BoolPtrInput `pulumi:"respectWordBoundaries"`
	// Chunk size in characters. If unset, defaults to 1000 in the implementation.
	Size pulumi.IntPtrInput `pulumi:"size"`
}

Text chunking configuration

func (RagChunkingArgs) ElementType

func (RagChunkingArgs) ElementType() reflect.Type

func (RagChunkingArgs) ToRagChunkingOutput

func (i RagChunkingArgs) ToRagChunkingOutput() RagChunkingOutput

func (RagChunkingArgs) ToRagChunkingOutputWithContext

func (i RagChunkingArgs) ToRagChunkingOutputWithContext(ctx context.Context) RagChunkingOutput

func (RagChunkingArgs) ToRagChunkingPtrOutput

func (i RagChunkingArgs) ToRagChunkingPtrOutput() RagChunkingPtrOutput

func (RagChunkingArgs) ToRagChunkingPtrOutputWithContext

func (i RagChunkingArgs) ToRagChunkingPtrOutputWithContext(ctx context.Context) RagChunkingPtrOutput

type RagChunkingInput

type RagChunkingInput interface {
	pulumi.Input

	ToRagChunkingOutput() RagChunkingOutput
	ToRagChunkingOutputWithContext(context.Context) RagChunkingOutput
}

RagChunkingInput is an input type that accepts RagChunkingArgs and RagChunkingOutput values. You can construct a concrete instance of `RagChunkingInput` via:

RagChunkingArgs{...}

type RagChunkingOutput

type RagChunkingOutput struct{ *pulumi.OutputState }

Text chunking configuration

func (RagChunkingOutput) CodeAware

func (o RagChunkingOutput) CodeAware() pulumi.BoolPtrOutput

Enable code-aware chunking for source files. When true, the chunking strategy will prefer AST-based or language-aware processors when available (tree-sitter based), and fall back to plain text chunking for unsupported languages.

func (RagChunkingOutput) ElementType

func (RagChunkingOutput) ElementType() reflect.Type

func (RagChunkingOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagChunkingOutput) Overlap

Overlap between chunks in characters. If unset, defaults to 75 in the implementation.

func (RagChunkingOutput) RespectWordBoundaries

func (o RagChunkingOutput) RespectWordBoundaries() pulumi.BoolPtrOutput

When true, chunks will split on the nearest whitespace boundary instead of at the exact character limit, preventing words from being truncated.

func (RagChunkingOutput) Size

Chunk size in characters. If unset, defaults to 1000 in the implementation.

func (RagChunkingOutput) ToRagChunkingOutput

func (o RagChunkingOutput) ToRagChunkingOutput() RagChunkingOutput

func (RagChunkingOutput) ToRagChunkingOutputWithContext

func (o RagChunkingOutput) ToRagChunkingOutputWithContext(ctx context.Context) RagChunkingOutput

func (RagChunkingOutput) ToRagChunkingPtrOutput

func (o RagChunkingOutput) ToRagChunkingPtrOutput() RagChunkingPtrOutput

func (RagChunkingOutput) ToRagChunkingPtrOutputWithContext

func (o RagChunkingOutput) ToRagChunkingPtrOutputWithContext(ctx context.Context) RagChunkingPtrOutput

type RagChunkingPtrInput

type RagChunkingPtrInput interface {
	pulumi.Input

	ToRagChunkingPtrOutput() RagChunkingPtrOutput
	ToRagChunkingPtrOutputWithContext(context.Context) RagChunkingPtrOutput
}

RagChunkingPtrInput is an input type that accepts RagChunkingArgs, RagChunkingPtr and RagChunkingPtrOutput values. You can construct a concrete instance of `RagChunkingPtrInput` via:

        RagChunkingArgs{...}

or:

        nil

func RagChunkingPtr

func RagChunkingPtr(v *RagChunkingArgs) RagChunkingPtrInput

type RagChunkingPtrOutput

type RagChunkingPtrOutput struct{ *pulumi.OutputState }

func (RagChunkingPtrOutput) CodeAware

Enable code-aware chunking for source files. When true, the chunking strategy will prefer AST-based or language-aware processors when available (tree-sitter based), and fall back to plain text chunking for unsupported languages.

func (RagChunkingPtrOutput) Elem

func (RagChunkingPtrOutput) ElementType

func (RagChunkingPtrOutput) ElementType() reflect.Type

func (RagChunkingPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagChunkingPtrOutput) Overlap

Overlap between chunks in characters. If unset, defaults to 75 in the implementation.

func (RagChunkingPtrOutput) RespectWordBoundaries

func (o RagChunkingPtrOutput) RespectWordBoundaries() pulumi.BoolPtrOutput

When true, chunks will split on the nearest whitespace boundary instead of at the exact character limit, preventing words from being truncated.

func (RagChunkingPtrOutput) Size

Chunk size in characters. If unset, defaults to 1000 in the implementation.

func (RagChunkingPtrOutput) ToRagChunkingPtrOutput

func (o RagChunkingPtrOutput) ToRagChunkingPtrOutput() RagChunkingPtrOutput

func (RagChunkingPtrOutput) ToRagChunkingPtrOutputWithContext

func (o RagChunkingPtrOutput) ToRagChunkingPtrOutputWithContext(ctx context.Context) RagChunkingPtrOutput

type RagConfig

type RagConfig struct {
	// Shared document paths or directories indexed by all strategies
	Docs []string `pulumi:"docs"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Cap on a single indexing run started by this RAG source, detached from the much shorter 30s toolset-start wait budget: indexing keeps running in the background past that budget and the tool appears once it is ready, resuming from per-file progress on a later start. Go duration format (e.g. '30m', '2h'). Default '30m' when omitted; '0s' means no bound.
	IndexingTimeout *string `pulumi:"indexingTimeout"`
	// Whether to respect VCS ignore files (e.g., .gitignore) when collecting documents for indexing. When true (default), files matching ignore patterns will be excluded. Can be overridden per-strategy.
	RespectVcs *bool `pulumi:"respectVcs"`
	// Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.
	Results *RagResults `pulumi:"results"`
	// Array of retrieval strategy configurations. Each strategy can have different parameters based on its type.
	Strategies []RagStrategy `pulumi:"strategies"`
	// Tool configuration for the RAG source
	Tool *RagTool `pulumi:"tool"`
}

RAG (Retrieval-Augmented Generation) configuration for document search and retrieval with pluggable strategies. Multiple strategies enable hybrid retrieval and reranking.

type RagConfigArgs

type RagConfigArgs struct {
	// Shared document paths or directories indexed by all strategies
	Docs pulumi.StringArrayInput `pulumi:"docs"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Cap on a single indexing run started by this RAG source, detached from the much shorter 30s toolset-start wait budget: indexing keeps running in the background past that budget and the tool appears once it is ready, resuming from per-file progress on a later start. Go duration format (e.g. '30m', '2h'). Default '30m' when omitted; '0s' means no bound.
	IndexingTimeout pulumi.StringPtrInput `pulumi:"indexingTimeout"`
	// Whether to respect VCS ignore files (e.g., .gitignore) when collecting documents for indexing. When true (default), files matching ignore patterns will be excluded. Can be overridden per-strategy.
	RespectVcs pulumi.BoolPtrInput `pulumi:"respectVcs"`
	// Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.
	Results RagResultsPtrInput `pulumi:"results"`
	// Array of retrieval strategy configurations. Each strategy can have different parameters based on its type.
	Strategies RagStrategyArrayInput `pulumi:"strategies"`
	// Tool configuration for the RAG source
	Tool RagToolPtrInput `pulumi:"tool"`
}

RAG (Retrieval-Augmented Generation) configuration for document search and retrieval with pluggable strategies. Multiple strategies enable hybrid retrieval and reranking.

func (RagConfigArgs) ElementType

func (RagConfigArgs) ElementType() reflect.Type

func (RagConfigArgs) ToRagConfigOutput

func (i RagConfigArgs) ToRagConfigOutput() RagConfigOutput

func (RagConfigArgs) ToRagConfigOutputWithContext

func (i RagConfigArgs) ToRagConfigOutputWithContext(ctx context.Context) RagConfigOutput

func (RagConfigArgs) ToRagConfigPtrOutput

func (i RagConfigArgs) ToRagConfigPtrOutput() RagConfigPtrOutput

func (RagConfigArgs) ToRagConfigPtrOutputWithContext

func (i RagConfigArgs) ToRagConfigPtrOutputWithContext(ctx context.Context) RagConfigPtrOutput

type RagConfigInput

type RagConfigInput interface {
	pulumi.Input

	ToRagConfigOutput() RagConfigOutput
	ToRagConfigOutputWithContext(context.Context) RagConfigOutput
}

RagConfigInput is an input type that accepts RagConfigArgs and RagConfigOutput values. You can construct a concrete instance of `RagConfigInput` via:

RagConfigArgs{...}

type RagConfigOutput

type RagConfigOutput struct{ *pulumi.OutputState }

RAG (Retrieval-Augmented Generation) configuration for document search and retrieval with pluggable strategies. Multiple strategies enable hybrid retrieval and reranking.

func (RagConfigOutput) Docs

Shared document paths or directories indexed by all strategies

func (RagConfigOutput) ElementType

func (RagConfigOutput) ElementType() reflect.Type

func (RagConfigOutput) Extra

func (o RagConfigOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagConfigOutput) IndexingTimeout

func (o RagConfigOutput) IndexingTimeout() pulumi.StringPtrOutput

Cap on a single indexing run started by this RAG source, detached from the much shorter 30s toolset-start wait budget: indexing keeps running in the background past that budget and the tool appears once it is ready, resuming from per-file progress on a later start. Go duration format (e.g. '30m', '2h'). Default '30m' when omitted; '0s' means no bound.

func (RagConfigOutput) RespectVcs

func (o RagConfigOutput) RespectVcs() pulumi.BoolPtrOutput

Whether to respect VCS ignore files (e.g., .gitignore) when collecting documents for indexing. When true (default), files matching ignore patterns will be excluded. Can be overridden per-strategy.

func (RagConfigOutput) Results

Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.

func (RagConfigOutput) Strategies

func (o RagConfigOutput) Strategies() RagStrategyArrayOutput

Array of retrieval strategy configurations. Each strategy can have different parameters based on its type.

func (RagConfigOutput) ToRagConfigOutput

func (o RagConfigOutput) ToRagConfigOutput() RagConfigOutput

func (RagConfigOutput) ToRagConfigOutputWithContext

func (o RagConfigOutput) ToRagConfigOutputWithContext(ctx context.Context) RagConfigOutput

func (RagConfigOutput) ToRagConfigPtrOutput

func (o RagConfigOutput) ToRagConfigPtrOutput() RagConfigPtrOutput

func (RagConfigOutput) ToRagConfigPtrOutputWithContext

func (o RagConfigOutput) ToRagConfigPtrOutputWithContext(ctx context.Context) RagConfigPtrOutput

func (RagConfigOutput) Tool

Tool configuration for the RAG source

type RagConfigPtrInput

type RagConfigPtrInput interface {
	pulumi.Input

	ToRagConfigPtrOutput() RagConfigPtrOutput
	ToRagConfigPtrOutputWithContext(context.Context) RagConfigPtrOutput
}

RagConfigPtrInput is an input type that accepts RagConfigArgs, RagConfigPtr and RagConfigPtrOutput values. You can construct a concrete instance of `RagConfigPtrInput` via:

        RagConfigArgs{...}

or:

        nil

func RagConfigPtr

func RagConfigPtr(v *RagConfigArgs) RagConfigPtrInput

type RagConfigPtrOutput

type RagConfigPtrOutput struct{ *pulumi.OutputState }

func (RagConfigPtrOutput) Docs

Shared document paths or directories indexed by all strategies

func (RagConfigPtrOutput) Elem

func (RagConfigPtrOutput) ElementType

func (RagConfigPtrOutput) ElementType() reflect.Type

func (RagConfigPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagConfigPtrOutput) IndexingTimeout

func (o RagConfigPtrOutput) IndexingTimeout() pulumi.StringPtrOutput

Cap on a single indexing run started by this RAG source, detached from the much shorter 30s toolset-start wait budget: indexing keeps running in the background past that budget and the tool appears once it is ready, resuming from per-file progress on a later start. Go duration format (e.g. '30m', '2h'). Default '30m' when omitted; '0s' means no bound.

func (RagConfigPtrOutput) RespectVcs

func (o RagConfigPtrOutput) RespectVcs() pulumi.BoolPtrOutput

Whether to respect VCS ignore files (e.g., .gitignore) when collecting documents for indexing. When true (default), files matching ignore patterns will be excluded. Can be overridden per-strategy.

func (RagConfigPtrOutput) Results

Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.

func (RagConfigPtrOutput) Strategies

Array of retrieval strategy configurations. Each strategy can have different parameters based on its type.

func (RagConfigPtrOutput) ToRagConfigPtrOutput

func (o RagConfigPtrOutput) ToRagConfigPtrOutput() RagConfigPtrOutput

func (RagConfigPtrOutput) ToRagConfigPtrOutputWithContext

func (o RagConfigPtrOutput) ToRagConfigPtrOutputWithContext(ctx context.Context) RagConfigPtrOutput

func (RagConfigPtrOutput) Tool

Tool configuration for the RAG source

type RagFusion

type RagFusion struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// RRF smoothing parameter k (only for RRF strategy) Defaults to `60`.
	K *int `pulumi:"k"`
	// Fusion strategy to use. Defaults to `rrf`.
	Strategy *RagFusionStrategy `pulumi:"strategy"`
	// Strategy weights for weighted fusion (strategy name -> weight)
	Weights map[string]float64 `pulumi:"weights"`
}

Configuration for combining results from multiple strategies. If omitted and multiple strategies are configured, Reciprocal Rank Fusion (rrf) with k=60 is used.

type RagFusionArgs

type RagFusionArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// RRF smoothing parameter k (only for RRF strategy) Defaults to `60`.
	K pulumi.IntPtrInput `pulumi:"k"`
	// Fusion strategy to use. Defaults to `rrf`.
	Strategy RagFusionStrategyPtrInput `pulumi:"strategy"`
	// Strategy weights for weighted fusion (strategy name -> weight)
	Weights pulumi.Float64MapInput `pulumi:"weights"`
}

Configuration for combining results from multiple strategies. If omitted and multiple strategies are configured, Reciprocal Rank Fusion (rrf) with k=60 is used.

func (RagFusionArgs) ElementType

func (RagFusionArgs) ElementType() reflect.Type

func (RagFusionArgs) ToRagFusionOutput

func (i RagFusionArgs) ToRagFusionOutput() RagFusionOutput

func (RagFusionArgs) ToRagFusionOutputWithContext

func (i RagFusionArgs) ToRagFusionOutputWithContext(ctx context.Context) RagFusionOutput

func (RagFusionArgs) ToRagFusionPtrOutput

func (i RagFusionArgs) ToRagFusionPtrOutput() RagFusionPtrOutput

func (RagFusionArgs) ToRagFusionPtrOutputWithContext

func (i RagFusionArgs) ToRagFusionPtrOutputWithContext(ctx context.Context) RagFusionPtrOutput

type RagFusionInput

type RagFusionInput interface {
	pulumi.Input

	ToRagFusionOutput() RagFusionOutput
	ToRagFusionOutputWithContext(context.Context) RagFusionOutput
}

RagFusionInput is an input type that accepts RagFusionArgs and RagFusionOutput values. You can construct a concrete instance of `RagFusionInput` via:

RagFusionArgs{...}

type RagFusionOutput

type RagFusionOutput struct{ *pulumi.OutputState }

Configuration for combining results from multiple strategies. If omitted and multiple strategies are configured, Reciprocal Rank Fusion (rrf) with k=60 is used.

func (RagFusionOutput) ElementType

func (RagFusionOutput) ElementType() reflect.Type

func (RagFusionOutput) Extra

func (o RagFusionOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagFusionOutput) K

RRF smoothing parameter k (only for RRF strategy) Defaults to `60`.

func (RagFusionOutput) Strategy

Fusion strategy to use. Defaults to `rrf`.

func (RagFusionOutput) ToRagFusionOutput

func (o RagFusionOutput) ToRagFusionOutput() RagFusionOutput

func (RagFusionOutput) ToRagFusionOutputWithContext

func (o RagFusionOutput) ToRagFusionOutputWithContext(ctx context.Context) RagFusionOutput

func (RagFusionOutput) ToRagFusionPtrOutput

func (o RagFusionOutput) ToRagFusionPtrOutput() RagFusionPtrOutput

func (RagFusionOutput) ToRagFusionPtrOutputWithContext

func (o RagFusionOutput) ToRagFusionPtrOutputWithContext(ctx context.Context) RagFusionPtrOutput

func (RagFusionOutput) Weights

Strategy weights for weighted fusion (strategy name -> weight)

type RagFusionPtrInput

type RagFusionPtrInput interface {
	pulumi.Input

	ToRagFusionPtrOutput() RagFusionPtrOutput
	ToRagFusionPtrOutputWithContext(context.Context) RagFusionPtrOutput
}

RagFusionPtrInput is an input type that accepts RagFusionArgs, RagFusionPtr and RagFusionPtrOutput values. You can construct a concrete instance of `RagFusionPtrInput` via:

        RagFusionArgs{...}

or:

        nil

func RagFusionPtr

func RagFusionPtr(v *RagFusionArgs) RagFusionPtrInput

type RagFusionPtrOutput

type RagFusionPtrOutput struct{ *pulumi.OutputState }

func (RagFusionPtrOutput) Elem

func (RagFusionPtrOutput) ElementType

func (RagFusionPtrOutput) ElementType() reflect.Type

func (RagFusionPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagFusionPtrOutput) K

RRF smoothing parameter k (only for RRF strategy) Defaults to `60`.

func (RagFusionPtrOutput) Strategy

Fusion strategy to use. Defaults to `rrf`.

func (RagFusionPtrOutput) ToRagFusionPtrOutput

func (o RagFusionPtrOutput) ToRagFusionPtrOutput() RagFusionPtrOutput

func (RagFusionPtrOutput) ToRagFusionPtrOutputWithContext

func (o RagFusionPtrOutput) ToRagFusionPtrOutputWithContext(ctx context.Context) RagFusionPtrOutput

func (RagFusionPtrOutput) Weights

Strategy weights for weighted fusion (strategy name -> weight)

type RagFusionStrategy

type RagFusionStrategy string

func (RagFusionStrategy) ElementType

func (RagFusionStrategy) ElementType() reflect.Type

func (RagFusionStrategy) ToRagFusionStrategyOutput

func (e RagFusionStrategy) ToRagFusionStrategyOutput() RagFusionStrategyOutput

func (RagFusionStrategy) ToRagFusionStrategyOutputWithContext

func (e RagFusionStrategy) ToRagFusionStrategyOutputWithContext(ctx context.Context) RagFusionStrategyOutput

func (RagFusionStrategy) ToRagFusionStrategyPtrOutput

func (e RagFusionStrategy) ToRagFusionStrategyPtrOutput() RagFusionStrategyPtrOutput

func (RagFusionStrategy) ToRagFusionStrategyPtrOutputWithContext

func (e RagFusionStrategy) ToRagFusionStrategyPtrOutputWithContext(ctx context.Context) RagFusionStrategyPtrOutput

func (RagFusionStrategy) ToStringOutput

func (e RagFusionStrategy) ToStringOutput() pulumi.StringOutput

func (RagFusionStrategy) ToStringOutputWithContext

func (e RagFusionStrategy) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RagFusionStrategy) ToStringPtrOutput

func (e RagFusionStrategy) ToStringPtrOutput() pulumi.StringPtrOutput

func (RagFusionStrategy) ToStringPtrOutputWithContext

func (e RagFusionStrategy) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RagFusionStrategyInput

type RagFusionStrategyInput interface {
	pulumi.Input

	ToRagFusionStrategyOutput() RagFusionStrategyOutput
	ToRagFusionStrategyOutputWithContext(context.Context) RagFusionStrategyOutput
}

RagFusionStrategyInput is an input type that accepts values of the RagFusionStrategy enum A concrete instance of `RagFusionStrategyInput` can be one of the following:

RagFusionStrategyRRF
RagFusionStrategyReciprocalRankFusion
RagFusionStrategyWeighted
RagFusionStrategyMax

type RagFusionStrategyOutput

type RagFusionStrategyOutput struct{ *pulumi.OutputState }

func (RagFusionStrategyOutput) ElementType

func (RagFusionStrategyOutput) ElementType() reflect.Type

func (RagFusionStrategyOutput) ToRagFusionStrategyOutput

func (o RagFusionStrategyOutput) ToRagFusionStrategyOutput() RagFusionStrategyOutput

func (RagFusionStrategyOutput) ToRagFusionStrategyOutputWithContext

func (o RagFusionStrategyOutput) ToRagFusionStrategyOutputWithContext(ctx context.Context) RagFusionStrategyOutput

func (RagFusionStrategyOutput) ToRagFusionStrategyPtrOutput

func (o RagFusionStrategyOutput) ToRagFusionStrategyPtrOutput() RagFusionStrategyPtrOutput

func (RagFusionStrategyOutput) ToRagFusionStrategyPtrOutputWithContext

func (o RagFusionStrategyOutput) ToRagFusionStrategyPtrOutputWithContext(ctx context.Context) RagFusionStrategyPtrOutput

func (RagFusionStrategyOutput) ToStringOutput

func (o RagFusionStrategyOutput) ToStringOutput() pulumi.StringOutput

func (RagFusionStrategyOutput) ToStringOutputWithContext

func (o RagFusionStrategyOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RagFusionStrategyOutput) ToStringPtrOutput

func (o RagFusionStrategyOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RagFusionStrategyOutput) ToStringPtrOutputWithContext

func (o RagFusionStrategyOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RagFusionStrategyPtrInput

type RagFusionStrategyPtrInput interface {
	pulumi.Input

	ToRagFusionStrategyPtrOutput() RagFusionStrategyPtrOutput
	ToRagFusionStrategyPtrOutputWithContext(context.Context) RagFusionStrategyPtrOutput
}

func RagFusionStrategyPtr

func RagFusionStrategyPtr(v string) RagFusionStrategyPtrInput

type RagFusionStrategyPtrOutput

type RagFusionStrategyPtrOutput struct{ *pulumi.OutputState }

func (RagFusionStrategyPtrOutput) Elem

func (RagFusionStrategyPtrOutput) ElementType

func (RagFusionStrategyPtrOutput) ElementType() reflect.Type

func (RagFusionStrategyPtrOutput) ToRagFusionStrategyPtrOutput

func (o RagFusionStrategyPtrOutput) ToRagFusionStrategyPtrOutput() RagFusionStrategyPtrOutput

func (RagFusionStrategyPtrOutput) ToRagFusionStrategyPtrOutputWithContext

func (o RagFusionStrategyPtrOutput) ToRagFusionStrategyPtrOutputWithContext(ctx context.Context) RagFusionStrategyPtrOutput

func (RagFusionStrategyPtrOutput) ToStringPtrOutput

func (o RagFusionStrategyPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RagFusionStrategyPtrOutput) ToStringPtrOutputWithContext

func (o RagFusionStrategyPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RagReranking

type RagReranking struct {
	// Optional: domain-specific relevance criteria to guide scoring. This text is appended to the base reranking prompt to customize what 'relevance' means for your use case. Supported by OpenAI, Anthropic, and Gemini providers (not DMR native reranking).
	Criteria *string `pulumi:"criteria"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Model reference for reranking (can be inline like 'dmr/model-name' or a reference to a defined model)
	Model string `pulumi:"model"`
	// Optional: minimum score threshold after reranking (filter results below this score) Defaults to `0.5`.
	Threshold *float64 `pulumi:"threshold"`
	// Optional: only rerank top K results for efficiency. When unset or 0, defaults to the global results.limit (which itself defaults to 15).
	TopK *int `pulumi:"topK"`
}

Configuration for reranking results using a specialized reranking model. Reranking re-scores the retrieved results to improve relevance accuracy.

type RagRerankingArgs

type RagRerankingArgs struct {
	// Optional: domain-specific relevance criteria to guide scoring. This text is appended to the base reranking prompt to customize what 'relevance' means for your use case. Supported by OpenAI, Anthropic, and Gemini providers (not DMR native reranking).
	Criteria pulumi.StringPtrInput `pulumi:"criteria"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Model reference for reranking (can be inline like 'dmr/model-name' or a reference to a defined model)
	Model pulumi.StringInput `pulumi:"model"`
	// Optional: minimum score threshold after reranking (filter results below this score) Defaults to `0.5`.
	Threshold pulumi.Float64PtrInput `pulumi:"threshold"`
	// Optional: only rerank top K results for efficiency. When unset or 0, defaults to the global results.limit (which itself defaults to 15).
	TopK pulumi.IntPtrInput `pulumi:"topK"`
}

Configuration for reranking results using a specialized reranking model. Reranking re-scores the retrieved results to improve relevance accuracy.

func (RagRerankingArgs) ElementType

func (RagRerankingArgs) ElementType() reflect.Type

func (RagRerankingArgs) ToRagRerankingOutput

func (i RagRerankingArgs) ToRagRerankingOutput() RagRerankingOutput

func (RagRerankingArgs) ToRagRerankingOutputWithContext

func (i RagRerankingArgs) ToRagRerankingOutputWithContext(ctx context.Context) RagRerankingOutput

func (RagRerankingArgs) ToRagRerankingPtrOutput

func (i RagRerankingArgs) ToRagRerankingPtrOutput() RagRerankingPtrOutput

func (RagRerankingArgs) ToRagRerankingPtrOutputWithContext

func (i RagRerankingArgs) ToRagRerankingPtrOutputWithContext(ctx context.Context) RagRerankingPtrOutput

type RagRerankingInput

type RagRerankingInput interface {
	pulumi.Input

	ToRagRerankingOutput() RagRerankingOutput
	ToRagRerankingOutputWithContext(context.Context) RagRerankingOutput
}

RagRerankingInput is an input type that accepts RagRerankingArgs and RagRerankingOutput values. You can construct a concrete instance of `RagRerankingInput` via:

RagRerankingArgs{...}

type RagRerankingOutput

type RagRerankingOutput struct{ *pulumi.OutputState }

Configuration for reranking results using a specialized reranking model. Reranking re-scores the retrieved results to improve relevance accuracy.

func (RagRerankingOutput) Criteria

Optional: domain-specific relevance criteria to guide scoring. This text is appended to the base reranking prompt to customize what 'relevance' means for your use case. Supported by OpenAI, Anthropic, and Gemini providers (not DMR native reranking).

func (RagRerankingOutput) ElementType

func (RagRerankingOutput) ElementType() reflect.Type

func (RagRerankingOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagRerankingOutput) Model

Model reference for reranking (can be inline like 'dmr/model-name' or a reference to a defined model)

func (RagRerankingOutput) Threshold

Optional: minimum score threshold after reranking (filter results below this score) Defaults to `0.5`.

func (RagRerankingOutput) ToRagRerankingOutput

func (o RagRerankingOutput) ToRagRerankingOutput() RagRerankingOutput

func (RagRerankingOutput) ToRagRerankingOutputWithContext

func (o RagRerankingOutput) ToRagRerankingOutputWithContext(ctx context.Context) RagRerankingOutput

func (RagRerankingOutput) ToRagRerankingPtrOutput

func (o RagRerankingOutput) ToRagRerankingPtrOutput() RagRerankingPtrOutput

func (RagRerankingOutput) ToRagRerankingPtrOutputWithContext

func (o RagRerankingOutput) ToRagRerankingPtrOutputWithContext(ctx context.Context) RagRerankingPtrOutput

func (RagRerankingOutput) TopK

Optional: only rerank top K results for efficiency. When unset or 0, defaults to the global results.limit (which itself defaults to 15).

type RagRerankingPtrInput

type RagRerankingPtrInput interface {
	pulumi.Input

	ToRagRerankingPtrOutput() RagRerankingPtrOutput
	ToRagRerankingPtrOutputWithContext(context.Context) RagRerankingPtrOutput
}

RagRerankingPtrInput is an input type that accepts RagRerankingArgs, RagRerankingPtr and RagRerankingPtrOutput values. You can construct a concrete instance of `RagRerankingPtrInput` via:

        RagRerankingArgs{...}

or:

        nil

type RagRerankingPtrOutput

type RagRerankingPtrOutput struct{ *pulumi.OutputState }

func (RagRerankingPtrOutput) Criteria

Optional: domain-specific relevance criteria to guide scoring. This text is appended to the base reranking prompt to customize what 'relevance' means for your use case. Supported by OpenAI, Anthropic, and Gemini providers (not DMR native reranking).

func (RagRerankingPtrOutput) Elem

func (RagRerankingPtrOutput) ElementType

func (RagRerankingPtrOutput) ElementType() reflect.Type

func (RagRerankingPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagRerankingPtrOutput) Model

Model reference for reranking (can be inline like 'dmr/model-name' or a reference to a defined model)

func (RagRerankingPtrOutput) Threshold

Optional: minimum score threshold after reranking (filter results below this score) Defaults to `0.5`.

func (RagRerankingPtrOutput) ToRagRerankingPtrOutput

func (o RagRerankingPtrOutput) ToRagRerankingPtrOutput() RagRerankingPtrOutput

func (RagRerankingPtrOutput) ToRagRerankingPtrOutputWithContext

func (o RagRerankingPtrOutput) ToRagRerankingPtrOutputWithContext(ctx context.Context) RagRerankingPtrOutput

func (RagRerankingPtrOutput) TopK

Optional: only rerank top K results for efficiency. When unset or 0, defaults to the global results.limit (which itself defaults to 15).

type RagResults

type RagResults struct {
	// Remove duplicate documents across strategies. Defaults to `true`.
	Deduplicate *bool `pulumi:"deduplicate"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Configuration for combining results from multiple strategies. If omitted and multiple strategies are configured, Reciprocal Rank Fusion (rrf) with k=60 is used.
	Fusion *RagFusion `pulumi:"fusion"`
	// Include relevance scores in results. Defaults to `false`.
	IncludeScore *bool `pulumi:"includeScore"`
	// Maximum number of results to return (top K) Defaults to `15`.
	Limit *int `pulumi:"limit"`
	// Configuration for reranking results using a specialized reranking model. Reranking re-scores the retrieved results to improve relevance accuracy.
	Reranking *RagReranking `pulumi:"reranking"`
	// Return full document content instead of just the matched chunk. The full document is read directly from the file system. Defaults to `false`.
	ReturnFullContent *bool `pulumi:"returnFullContent"`
}

Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.

type RagResultsArgs

type RagResultsArgs struct {
	// Remove duplicate documents across strategies. Defaults to `true`.
	Deduplicate pulumi.BoolPtrInput `pulumi:"deduplicate"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Configuration for combining results from multiple strategies. If omitted and multiple strategies are configured, Reciprocal Rank Fusion (rrf) with k=60 is used.
	Fusion RagFusionPtrInput `pulumi:"fusion"`
	// Include relevance scores in results. Defaults to `false`.
	IncludeScore pulumi.BoolPtrInput `pulumi:"includeScore"`
	// Maximum number of results to return (top K) Defaults to `15`.
	Limit pulumi.IntPtrInput `pulumi:"limit"`
	// Configuration for reranking results using a specialized reranking model. Reranking re-scores the retrieved results to improve relevance accuracy.
	Reranking RagRerankingPtrInput `pulumi:"reranking"`
	// Return full document content instead of just the matched chunk. The full document is read directly from the file system. Defaults to `false`.
	ReturnFullContent pulumi.BoolPtrInput `pulumi:"returnFullContent"`
}

Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.

func (RagResultsArgs) ElementType

func (RagResultsArgs) ElementType() reflect.Type

func (RagResultsArgs) ToRagResultsOutput

func (i RagResultsArgs) ToRagResultsOutput() RagResultsOutput

func (RagResultsArgs) ToRagResultsOutputWithContext

func (i RagResultsArgs) ToRagResultsOutputWithContext(ctx context.Context) RagResultsOutput

func (RagResultsArgs) ToRagResultsPtrOutput

func (i RagResultsArgs) ToRagResultsPtrOutput() RagResultsPtrOutput

func (RagResultsArgs) ToRagResultsPtrOutputWithContext

func (i RagResultsArgs) ToRagResultsPtrOutputWithContext(ctx context.Context) RagResultsPtrOutput

type RagResultsInput

type RagResultsInput interface {
	pulumi.Input

	ToRagResultsOutput() RagResultsOutput
	ToRagResultsOutputWithContext(context.Context) RagResultsOutput
}

RagResultsInput is an input type that accepts RagResultsArgs and RagResultsOutput values. You can construct a concrete instance of `RagResultsInput` via:

RagResultsArgs{...}

type RagResultsOutput

type RagResultsOutput struct{ *pulumi.OutputState }

Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.

func (RagResultsOutput) Deduplicate

func (o RagResultsOutput) Deduplicate() pulumi.BoolPtrOutput

Remove duplicate documents across strategies. Defaults to `true`.

func (RagResultsOutput) ElementType

func (RagResultsOutput) ElementType() reflect.Type

func (RagResultsOutput) Extra

func (o RagResultsOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagResultsOutput) Fusion

Configuration for combining results from multiple strategies. If omitted and multiple strategies are configured, Reciprocal Rank Fusion (rrf) with k=60 is used.

func (RagResultsOutput) IncludeScore

func (o RagResultsOutput) IncludeScore() pulumi.BoolPtrOutput

Include relevance scores in results. Defaults to `false`.

func (RagResultsOutput) Limit

Maximum number of results to return (top K) Defaults to `15`.

func (RagResultsOutput) Reranking

Configuration for reranking results using a specialized reranking model. Reranking re-scores the retrieved results to improve relevance accuracy.

func (RagResultsOutput) ReturnFullContent

func (o RagResultsOutput) ReturnFullContent() pulumi.BoolPtrOutput

Return full document content instead of just the matched chunk. The full document is read directly from the file system. Defaults to `false`.

func (RagResultsOutput) ToRagResultsOutput

func (o RagResultsOutput) ToRagResultsOutput() RagResultsOutput

func (RagResultsOutput) ToRagResultsOutputWithContext

func (o RagResultsOutput) ToRagResultsOutputWithContext(ctx context.Context) RagResultsOutput

func (RagResultsOutput) ToRagResultsPtrOutput

func (o RagResultsOutput) ToRagResultsPtrOutput() RagResultsPtrOutput

func (RagResultsOutput) ToRagResultsPtrOutputWithContext

func (o RagResultsOutput) ToRagResultsPtrOutputWithContext(ctx context.Context) RagResultsPtrOutput

type RagResultsPtrInput

type RagResultsPtrInput interface {
	pulumi.Input

	ToRagResultsPtrOutput() RagResultsPtrOutput
	ToRagResultsPtrOutputWithContext(context.Context) RagResultsPtrOutput
}

RagResultsPtrInput is an input type that accepts RagResultsArgs, RagResultsPtr and RagResultsPtrOutput values. You can construct a concrete instance of `RagResultsPtrInput` via:

        RagResultsArgs{...}

or:

        nil

func RagResultsPtr

func RagResultsPtr(v *RagResultsArgs) RagResultsPtrInput

type RagResultsPtrOutput

type RagResultsPtrOutput struct{ *pulumi.OutputState }

func (RagResultsPtrOutput) Deduplicate

func (o RagResultsPtrOutput) Deduplicate() pulumi.BoolPtrOutput

Remove duplicate documents across strategies. Defaults to `true`.

func (RagResultsPtrOutput) Elem

func (RagResultsPtrOutput) ElementType

func (RagResultsPtrOutput) ElementType() reflect.Type

func (RagResultsPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagResultsPtrOutput) Fusion

Configuration for combining results from multiple strategies. If omitted and multiple strategies are configured, Reciprocal Rank Fusion (rrf) with k=60 is used.

func (RagResultsPtrOutput) IncludeScore

func (o RagResultsPtrOutput) IncludeScore() pulumi.BoolPtrOutput

Include relevance scores in results. Defaults to `false`.

func (RagResultsPtrOutput) Limit

Maximum number of results to return (top K) Defaults to `15`.

func (RagResultsPtrOutput) Reranking

Configuration for reranking results using a specialized reranking model. Reranking re-scores the retrieved results to improve relevance accuracy.

func (RagResultsPtrOutput) ReturnFullContent

func (o RagResultsPtrOutput) ReturnFullContent() pulumi.BoolPtrOutput

Return full document content instead of just the matched chunk. The full document is read directly from the file system. Defaults to `false`.

func (RagResultsPtrOutput) ToRagResultsPtrOutput

func (o RagResultsPtrOutput) ToRagResultsPtrOutput() RagResultsPtrOutput

func (RagResultsPtrOutput) ToRagResultsPtrOutputWithContext

func (o RagResultsPtrOutput) ToRagResultsPtrOutputWithContext(ctx context.Context) RagResultsPtrOutput

type RagSource

type RagSource struct {
	// Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.
	Defer *bool `pulumi:"defer"`
	// Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.
	DeferTools []string `pulumi:"deferTools"`
	// Shared document paths or directories indexed by all strategies
	Docs []string `pulumi:"docs"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Cap on a single indexing run started by this RAG source, detached from the much shorter 30s toolset-start wait budget: indexing keeps running in the background past that budget and the tool appears once it is ready, resuming from per-file progress on a later start. Go duration format (e.g. '30m', '2h'). Default '30m' when omitted; '0s' means no bound.
	IndexingTimeout *string `pulumi:"indexingTimeout"`
	// Custom instruction for this RAG source
	Instruction *string `pulumi:"instruction"`
	// Optional display name override for the RAG tool
	Name *string `pulumi:"name"`
	// Whether to respect VCS ignore files (e.g., .gitignore) when collecting documents for indexing. When true (default), files matching ignore patterns will be excluded. Can be overridden per-strategy.
	RespectVcs *bool `pulumi:"respectVcs"`
	// Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.
	Results *RagResults `pulumi:"results"`
	// Array of retrieval strategy configurations. Each strategy can have different parameters based on its type.
	Strategies []RagStrategy `pulumi:"strategies"`
	// Tool configuration for the RAG source
	Tool *RagTool `pulumi:"tool"`
	// Optional list of tools to expose
	Tools []string `pulumi:"tools"`
}

Reusable RAG source definition. Define once at the top level and reference by name from agent toolsets. RAG config fields (tool, docs, strategies, results, respect_vcs) are specified directly alongside toolset fields.

type RagSourceArgs

type RagSourceArgs struct {
	// Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.
	Defer pulumi.BoolPtrInput `pulumi:"defer"`
	// Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.
	DeferTools pulumi.StringArrayInput `pulumi:"deferTools"`
	// Shared document paths or directories indexed by all strategies
	Docs pulumi.StringArrayInput `pulumi:"docs"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Cap on a single indexing run started by this RAG source, detached from the much shorter 30s toolset-start wait budget: indexing keeps running in the background past that budget and the tool appears once it is ready, resuming from per-file progress on a later start. Go duration format (e.g. '30m', '2h'). Default '30m' when omitted; '0s' means no bound.
	IndexingTimeout pulumi.StringPtrInput `pulumi:"indexingTimeout"`
	// Custom instruction for this RAG source
	Instruction pulumi.StringPtrInput `pulumi:"instruction"`
	// Optional display name override for the RAG tool
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Whether to respect VCS ignore files (e.g., .gitignore) when collecting documents for indexing. When true (default), files matching ignore patterns will be excluded. Can be overridden per-strategy.
	RespectVcs pulumi.BoolPtrInput `pulumi:"respectVcs"`
	// Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.
	Results RagResultsPtrInput `pulumi:"results"`
	// Array of retrieval strategy configurations. Each strategy can have different parameters based on its type.
	Strategies RagStrategyArrayInput `pulumi:"strategies"`
	// Tool configuration for the RAG source
	Tool RagToolPtrInput `pulumi:"tool"`
	// Optional list of tools to expose
	Tools pulumi.StringArrayInput `pulumi:"tools"`
}

Reusable RAG source definition. Define once at the top level and reference by name from agent toolsets. RAG config fields (tool, docs, strategies, results, respect_vcs) are specified directly alongside toolset fields.

func (RagSourceArgs) ElementType

func (RagSourceArgs) ElementType() reflect.Type

func (RagSourceArgs) ToRagSourceOutput

func (i RagSourceArgs) ToRagSourceOutput() RagSourceOutput

func (RagSourceArgs) ToRagSourceOutputWithContext

func (i RagSourceArgs) ToRagSourceOutputWithContext(ctx context.Context) RagSourceOutput

type RagSourceInput

type RagSourceInput interface {
	pulumi.Input

	ToRagSourceOutput() RagSourceOutput
	ToRagSourceOutputWithContext(context.Context) RagSourceOutput
}

RagSourceInput is an input type that accepts RagSourceArgs and RagSourceOutput values. You can construct a concrete instance of `RagSourceInput` via:

RagSourceArgs{...}

type RagSourceMap

type RagSourceMap map[string]RagSourceInput

func (RagSourceMap) ElementType

func (RagSourceMap) ElementType() reflect.Type

func (RagSourceMap) ToRagSourceMapOutput

func (i RagSourceMap) ToRagSourceMapOutput() RagSourceMapOutput

func (RagSourceMap) ToRagSourceMapOutputWithContext

func (i RagSourceMap) ToRagSourceMapOutputWithContext(ctx context.Context) RagSourceMapOutput

type RagSourceMapInput

type RagSourceMapInput interface {
	pulumi.Input

	ToRagSourceMapOutput() RagSourceMapOutput
	ToRagSourceMapOutputWithContext(context.Context) RagSourceMapOutput
}

RagSourceMapInput is an input type that accepts RagSourceMap and RagSourceMapOutput values. You can construct a concrete instance of `RagSourceMapInput` via:

RagSourceMap{ "key": RagSourceArgs{...} }

type RagSourceMapOutput

type RagSourceMapOutput struct{ *pulumi.OutputState }

func (RagSourceMapOutput) ElementType

func (RagSourceMapOutput) ElementType() reflect.Type

func (RagSourceMapOutput) MapIndex

func (RagSourceMapOutput) ToRagSourceMapOutput

func (o RagSourceMapOutput) ToRagSourceMapOutput() RagSourceMapOutput

func (RagSourceMapOutput) ToRagSourceMapOutputWithContext

func (o RagSourceMapOutput) ToRagSourceMapOutputWithContext(ctx context.Context) RagSourceMapOutput

type RagSourceOutput

type RagSourceOutput struct{ *pulumi.OutputState }

Reusable RAG source definition. Define once at the top level and reference by name from agent toolsets. RAG config fields (tool, docs, strategies, results, respect_vcs) are specified directly alongside toolset fields.

func (RagSourceOutput) Defer

Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.

func (RagSourceOutput) DeferTools

func (o RagSourceOutput) DeferTools() pulumi.StringArrayOutput

Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.

func (RagSourceOutput) Docs

Shared document paths or directories indexed by all strategies

func (RagSourceOutput) ElementType

func (RagSourceOutput) ElementType() reflect.Type

func (RagSourceOutput) Extra

func (o RagSourceOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagSourceOutput) IndexingTimeout

func (o RagSourceOutput) IndexingTimeout() pulumi.StringPtrOutput

Cap on a single indexing run started by this RAG source, detached from the much shorter 30s toolset-start wait budget: indexing keeps running in the background past that budget and the tool appears once it is ready, resuming from per-file progress on a later start. Go duration format (e.g. '30m', '2h'). Default '30m' when omitted; '0s' means no bound.

func (RagSourceOutput) Instruction

func (o RagSourceOutput) Instruction() pulumi.StringPtrOutput

Custom instruction for this RAG source

func (RagSourceOutput) Name

Optional display name override for the RAG tool

func (RagSourceOutput) RespectVcs

func (o RagSourceOutput) RespectVcs() pulumi.BoolPtrOutput

Whether to respect VCS ignore files (e.g., .gitignore) when collecting documents for indexing. When true (default), files matching ignore patterns will be excluded. Can be overridden per-strategy.

func (RagSourceOutput) Results

Result post-processing configuration (fusion, deduplication, limiting). If omitted, sensible defaults are applied in code.

func (RagSourceOutput) Strategies

func (o RagSourceOutput) Strategies() RagStrategyArrayOutput

Array of retrieval strategy configurations. Each strategy can have different parameters based on its type.

func (RagSourceOutput) ToRagSourceOutput

func (o RagSourceOutput) ToRagSourceOutput() RagSourceOutput

func (RagSourceOutput) ToRagSourceOutputWithContext

func (o RagSourceOutput) ToRagSourceOutputWithContext(ctx context.Context) RagSourceOutput

func (RagSourceOutput) Tool

Tool configuration for the RAG source

func (RagSourceOutput) Tools

Optional list of tools to expose

type RagStrategy

type RagStrategy struct {
	// Include TreeSitter-derived AST metadata in the semantic prompt (semantic-embeddings only, requires chunking.code_aware for best results) Defaults to `false`.
	AstContext *bool `pulumi:"astContext"`
	// BM25 length normalization (bm25 only, 0-1, typically 0.75)
	B *float64 `pulumi:"b"`
	// Chat model used to generate semantic representations for each chunk (semantic-embeddings only, required)
	ChatModel *string `pulumi:"chatModel"`
	// Text chunking configuration
	Chunking *RagChunking `pulumi:"chunking"`
	// Database path or connection string. Currently only simple string values are supported (e.g., './vector.db', './bm25.db').
	Database *string `pulumi:"database"`
	// Additional documents for this strategy only (augments shared docs)
	Docs []string `pulumi:"docs"`
	// Number of text chunks to send to the embedding API in a single request (chunked-embeddings/semantic-embeddings only) Defaults to `50`.
	EmbeddingBatchSize *int `pulumi:"embeddingBatchSize"`
	// Embedding model reference for chunked-embeddings and semantic-embeddings strategies (looked up in models map, or 'auto' for automatic selection)
	EmbeddingModel *string `pulumi:"embeddingModel"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// BM25 term frequency saturation (bm25 only, typically 1.2-2.0)
	K1 *float64 `pulumi:"k1"`
	// Max results from this strategy (candidates for fusion). If unset, defaults to 5 in the implementation.
	Limit *int `pulumi:"limit"`
	// Maximum concurrent embedding batch API requests. For semantic-embeddings, also controls parallel LLM calls for generating chunk summaries. Defaults to `3`.
	MaxEmbeddingConcurrency *int `pulumi:"maxEmbeddingConcurrency"`
	// Maximum number of files to index in parallel during initialization. Defaults to `3`.
	MaxIndexingConcurrency *int `pulumi:"maxIndexingConcurrency"`
	// Override the RAG-level respect_vcs setting for this strategy only.
	RespectVcs *bool `pulumi:"respectVcs"`
	// Custom prompt template for semantic LLM. Uses JavaScript template literal syntax with the following placeholders: ${path} (full source file path), ${basename} (base name of file), ${chunk_index} (numeric chunk index), ${content} (raw chunk content), ${ast_context} (AST metadata when ast_context is enabled). Only applicable to semantic-embeddings strategy.
	SemanticPrompt *string `pulumi:"semanticPrompt"`
	// Similarity metric (chunked-embeddings only). Currently only 'cosine_similarity' is implemented. Allowed values: `cosine_similarity`.
	SimilarityMetric *string `pulumi:"similarityMetric"`
	// Minimum score threshold (0-1 for chunked-embeddings, unbounded for bm25)
	Threshold *float64 `pulumi:"threshold"`
	// Retrieval strategy type.
	Type RagStrategyType `pulumi:"type"`
	// Vector dimensions for embeddings (chunked-embeddings only). Must match your embedding model's output dimensions and is required for chunked-embeddings strategies.
	VectorDimensions *int `pulumi:"vectorDimensions"`
}

Retrieval strategy configuration with type-specific parameters. Structured fields are limited; additional parameters are passed through as-is for strategy-specific use.

type RagStrategyArgs

type RagStrategyArgs struct {
	// Include TreeSitter-derived AST metadata in the semantic prompt (semantic-embeddings only, requires chunking.code_aware for best results) Defaults to `false`.
	AstContext pulumi.BoolPtrInput `pulumi:"astContext"`
	// BM25 length normalization (bm25 only, 0-1, typically 0.75)
	B pulumi.Float64PtrInput `pulumi:"b"`
	// Chat model used to generate semantic representations for each chunk (semantic-embeddings only, required)
	ChatModel pulumi.StringPtrInput `pulumi:"chatModel"`
	// Text chunking configuration
	Chunking RagChunkingPtrInput `pulumi:"chunking"`
	// Database path or connection string. Currently only simple string values are supported (e.g., './vector.db', './bm25.db').
	Database pulumi.StringPtrInput `pulumi:"database"`
	// Additional documents for this strategy only (augments shared docs)
	Docs pulumi.StringArrayInput `pulumi:"docs"`
	// Number of text chunks to send to the embedding API in a single request (chunked-embeddings/semantic-embeddings only) Defaults to `50`.
	EmbeddingBatchSize pulumi.IntPtrInput `pulumi:"embeddingBatchSize"`
	// Embedding model reference for chunked-embeddings and semantic-embeddings strategies (looked up in models map, or 'auto' for automatic selection)
	EmbeddingModel pulumi.StringPtrInput `pulumi:"embeddingModel"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// BM25 term frequency saturation (bm25 only, typically 1.2-2.0)
	K1 pulumi.Float64PtrInput `pulumi:"k1"`
	// Max results from this strategy (candidates for fusion). If unset, defaults to 5 in the implementation.
	Limit pulumi.IntPtrInput `pulumi:"limit"`
	// Maximum concurrent embedding batch API requests. For semantic-embeddings, also controls parallel LLM calls for generating chunk summaries. Defaults to `3`.
	MaxEmbeddingConcurrency pulumi.IntPtrInput `pulumi:"maxEmbeddingConcurrency"`
	// Maximum number of files to index in parallel during initialization. Defaults to `3`.
	MaxIndexingConcurrency pulumi.IntPtrInput `pulumi:"maxIndexingConcurrency"`
	// Override the RAG-level respect_vcs setting for this strategy only.
	RespectVcs pulumi.BoolPtrInput `pulumi:"respectVcs"`
	// Custom prompt template for semantic LLM. Uses JavaScript template literal syntax with the following placeholders: ${path} (full source file path), ${basename} (base name of file), ${chunk_index} (numeric chunk index), ${content} (raw chunk content), ${ast_context} (AST metadata when ast_context is enabled). Only applicable to semantic-embeddings strategy.
	SemanticPrompt pulumi.StringPtrInput `pulumi:"semanticPrompt"`
	// Similarity metric (chunked-embeddings only). Currently only 'cosine_similarity' is implemented. Allowed values: `cosine_similarity`.
	SimilarityMetric pulumi.StringPtrInput `pulumi:"similarityMetric"`
	// Minimum score threshold (0-1 for chunked-embeddings, unbounded for bm25)
	Threshold pulumi.Float64PtrInput `pulumi:"threshold"`
	// Retrieval strategy type.
	Type RagStrategyTypeInput `pulumi:"type"`
	// Vector dimensions for embeddings (chunked-embeddings only). Must match your embedding model's output dimensions and is required for chunked-embeddings strategies.
	VectorDimensions pulumi.IntPtrInput `pulumi:"vectorDimensions"`
}

Retrieval strategy configuration with type-specific parameters. Structured fields are limited; additional parameters are passed through as-is for strategy-specific use.

func (RagStrategyArgs) ElementType

func (RagStrategyArgs) ElementType() reflect.Type

func (RagStrategyArgs) ToRagStrategyOutput

func (i RagStrategyArgs) ToRagStrategyOutput() RagStrategyOutput

func (RagStrategyArgs) ToRagStrategyOutputWithContext

func (i RagStrategyArgs) ToRagStrategyOutputWithContext(ctx context.Context) RagStrategyOutput

type RagStrategyArray

type RagStrategyArray []RagStrategyInput

func (RagStrategyArray) ElementType

func (RagStrategyArray) ElementType() reflect.Type

func (RagStrategyArray) ToRagStrategyArrayOutput

func (i RagStrategyArray) ToRagStrategyArrayOutput() RagStrategyArrayOutput

func (RagStrategyArray) ToRagStrategyArrayOutputWithContext

func (i RagStrategyArray) ToRagStrategyArrayOutputWithContext(ctx context.Context) RagStrategyArrayOutput

type RagStrategyArrayInput

type RagStrategyArrayInput interface {
	pulumi.Input

	ToRagStrategyArrayOutput() RagStrategyArrayOutput
	ToRagStrategyArrayOutputWithContext(context.Context) RagStrategyArrayOutput
}

RagStrategyArrayInput is an input type that accepts RagStrategyArray and RagStrategyArrayOutput values. You can construct a concrete instance of `RagStrategyArrayInput` via:

RagStrategyArray{ RagStrategyArgs{...} }

type RagStrategyArrayOutput

type RagStrategyArrayOutput struct{ *pulumi.OutputState }

func (RagStrategyArrayOutput) ElementType

func (RagStrategyArrayOutput) ElementType() reflect.Type

func (RagStrategyArrayOutput) Index

func (RagStrategyArrayOutput) ToRagStrategyArrayOutput

func (o RagStrategyArrayOutput) ToRagStrategyArrayOutput() RagStrategyArrayOutput

func (RagStrategyArrayOutput) ToRagStrategyArrayOutputWithContext

func (o RagStrategyArrayOutput) ToRagStrategyArrayOutputWithContext(ctx context.Context) RagStrategyArrayOutput

type RagStrategyInput

type RagStrategyInput interface {
	pulumi.Input

	ToRagStrategyOutput() RagStrategyOutput
	ToRagStrategyOutputWithContext(context.Context) RagStrategyOutput
}

RagStrategyInput is an input type that accepts RagStrategyArgs and RagStrategyOutput values. You can construct a concrete instance of `RagStrategyInput` via:

RagStrategyArgs{...}

type RagStrategyOutput

type RagStrategyOutput struct{ *pulumi.OutputState }

Retrieval strategy configuration with type-specific parameters. Structured fields are limited; additional parameters are passed through as-is for strategy-specific use.

func (RagStrategyOutput) AstContext

func (o RagStrategyOutput) AstContext() pulumi.BoolPtrOutput

Include TreeSitter-derived AST metadata in the semantic prompt (semantic-embeddings only, requires chunking.code_aware for best results) Defaults to `false`.

func (RagStrategyOutput) B

BM25 length normalization (bm25 only, 0-1, typically 0.75)

func (RagStrategyOutput) ChatModel

Chat model used to generate semantic representations for each chunk (semantic-embeddings only, required)

func (RagStrategyOutput) Chunking

Text chunking configuration

func (RagStrategyOutput) Database

Database path or connection string. Currently only simple string values are supported (e.g., './vector.db', './bm25.db').

func (RagStrategyOutput) Docs

Additional documents for this strategy only (augments shared docs)

func (RagStrategyOutput) ElementType

func (RagStrategyOutput) ElementType() reflect.Type

func (RagStrategyOutput) EmbeddingBatchSize

func (o RagStrategyOutput) EmbeddingBatchSize() pulumi.IntPtrOutput

Number of text chunks to send to the embedding API in a single request (chunked-embeddings/semantic-embeddings only) Defaults to `50`.

func (RagStrategyOutput) EmbeddingModel

func (o RagStrategyOutput) EmbeddingModel() pulumi.StringPtrOutput

Embedding model reference for chunked-embeddings and semantic-embeddings strategies (looked up in models map, or 'auto' for automatic selection)

func (RagStrategyOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagStrategyOutput) K1

BM25 term frequency saturation (bm25 only, typically 1.2-2.0)

func (RagStrategyOutput) Limit

Max results from this strategy (candidates for fusion). If unset, defaults to 5 in the implementation.

func (RagStrategyOutput) MaxEmbeddingConcurrency

func (o RagStrategyOutput) MaxEmbeddingConcurrency() pulumi.IntPtrOutput

Maximum concurrent embedding batch API requests. For semantic-embeddings, also controls parallel LLM calls for generating chunk summaries. Defaults to `3`.

func (RagStrategyOutput) MaxIndexingConcurrency

func (o RagStrategyOutput) MaxIndexingConcurrency() pulumi.IntPtrOutput

Maximum number of files to index in parallel during initialization. Defaults to `3`.

func (RagStrategyOutput) RespectVcs

func (o RagStrategyOutput) RespectVcs() pulumi.BoolPtrOutput

Override the RAG-level respect_vcs setting for this strategy only.

func (RagStrategyOutput) SemanticPrompt

func (o RagStrategyOutput) SemanticPrompt() pulumi.StringPtrOutput

Custom prompt template for semantic LLM. Uses JavaScript template literal syntax with the following placeholders: ${path} (full source file path), ${basename} (base name of file), ${chunk_index} (numeric chunk index), ${content} (raw chunk content), ${ast_context} (AST metadata when ast_context is enabled). Only applicable to semantic-embeddings strategy.

func (RagStrategyOutput) SimilarityMetric

func (o RagStrategyOutput) SimilarityMetric() pulumi.StringPtrOutput

Similarity metric (chunked-embeddings only). Currently only 'cosine_similarity' is implemented. Allowed values: `cosine_similarity`.

func (RagStrategyOutput) Threshold

Minimum score threshold (0-1 for chunked-embeddings, unbounded for bm25)

func (RagStrategyOutput) ToRagStrategyOutput

func (o RagStrategyOutput) ToRagStrategyOutput() RagStrategyOutput

func (RagStrategyOutput) ToRagStrategyOutputWithContext

func (o RagStrategyOutput) ToRagStrategyOutputWithContext(ctx context.Context) RagStrategyOutput

func (RagStrategyOutput) Type

Retrieval strategy type.

func (RagStrategyOutput) VectorDimensions

func (o RagStrategyOutput) VectorDimensions() pulumi.IntPtrOutput

Vector dimensions for embeddings (chunked-embeddings only). Must match your embedding model's output dimensions and is required for chunked-embeddings strategies.

type RagStrategyType

type RagStrategyType string

func (RagStrategyType) ElementType

func (RagStrategyType) ElementType() reflect.Type

func (RagStrategyType) ToRagStrategyTypeOutput

func (e RagStrategyType) ToRagStrategyTypeOutput() RagStrategyTypeOutput

func (RagStrategyType) ToRagStrategyTypeOutputWithContext

func (e RagStrategyType) ToRagStrategyTypeOutputWithContext(ctx context.Context) RagStrategyTypeOutput

func (RagStrategyType) ToRagStrategyTypePtrOutput

func (e RagStrategyType) ToRagStrategyTypePtrOutput() RagStrategyTypePtrOutput

func (RagStrategyType) ToRagStrategyTypePtrOutputWithContext

func (e RagStrategyType) ToRagStrategyTypePtrOutputWithContext(ctx context.Context) RagStrategyTypePtrOutput

func (RagStrategyType) ToStringOutput

func (e RagStrategyType) ToStringOutput() pulumi.StringOutput

func (RagStrategyType) ToStringOutputWithContext

func (e RagStrategyType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RagStrategyType) ToStringPtrOutput

func (e RagStrategyType) ToStringPtrOutput() pulumi.StringPtrOutput

func (RagStrategyType) ToStringPtrOutputWithContext

func (e RagStrategyType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RagStrategyTypeInput

type RagStrategyTypeInput interface {
	pulumi.Input

	ToRagStrategyTypeOutput() RagStrategyTypeOutput
	ToRagStrategyTypeOutputWithContext(context.Context) RagStrategyTypeOutput
}

RagStrategyTypeInput is an input type that accepts values of the RagStrategyType enum A concrete instance of `RagStrategyTypeInput` can be one of the following:

RagStrategyTypeBM25
RagStrategyTypeChunkedEmbeddings
RagStrategyTypeSemanticEmbeddings

type RagStrategyTypeOutput

type RagStrategyTypeOutput struct{ *pulumi.OutputState }

func (RagStrategyTypeOutput) ElementType

func (RagStrategyTypeOutput) ElementType() reflect.Type

func (RagStrategyTypeOutput) ToRagStrategyTypeOutput

func (o RagStrategyTypeOutput) ToRagStrategyTypeOutput() RagStrategyTypeOutput

func (RagStrategyTypeOutput) ToRagStrategyTypeOutputWithContext

func (o RagStrategyTypeOutput) ToRagStrategyTypeOutputWithContext(ctx context.Context) RagStrategyTypeOutput

func (RagStrategyTypeOutput) ToRagStrategyTypePtrOutput

func (o RagStrategyTypeOutput) ToRagStrategyTypePtrOutput() RagStrategyTypePtrOutput

func (RagStrategyTypeOutput) ToRagStrategyTypePtrOutputWithContext

func (o RagStrategyTypeOutput) ToRagStrategyTypePtrOutputWithContext(ctx context.Context) RagStrategyTypePtrOutput

func (RagStrategyTypeOutput) ToStringOutput

func (o RagStrategyTypeOutput) ToStringOutput() pulumi.StringOutput

func (RagStrategyTypeOutput) ToStringOutputWithContext

func (o RagStrategyTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RagStrategyTypeOutput) ToStringPtrOutput

func (o RagStrategyTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RagStrategyTypeOutput) ToStringPtrOutputWithContext

func (o RagStrategyTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RagStrategyTypePtrInput

type RagStrategyTypePtrInput interface {
	pulumi.Input

	ToRagStrategyTypePtrOutput() RagStrategyTypePtrOutput
	ToRagStrategyTypePtrOutputWithContext(context.Context) RagStrategyTypePtrOutput
}

func RagStrategyTypePtr

func RagStrategyTypePtr(v string) RagStrategyTypePtrInput

type RagStrategyTypePtrOutput

type RagStrategyTypePtrOutput struct{ *pulumi.OutputState }

func (RagStrategyTypePtrOutput) Elem

func (RagStrategyTypePtrOutput) ElementType

func (RagStrategyTypePtrOutput) ElementType() reflect.Type

func (RagStrategyTypePtrOutput) ToRagStrategyTypePtrOutput

func (o RagStrategyTypePtrOutput) ToRagStrategyTypePtrOutput() RagStrategyTypePtrOutput

func (RagStrategyTypePtrOutput) ToRagStrategyTypePtrOutputWithContext

func (o RagStrategyTypePtrOutput) ToRagStrategyTypePtrOutputWithContext(ctx context.Context) RagStrategyTypePtrOutput

func (RagStrategyTypePtrOutput) ToStringPtrOutput

func (o RagStrategyTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RagStrategyTypePtrOutput) ToStringPtrOutputWithContext

func (o RagStrategyTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RagTool

type RagTool struct {
	// Description of what the tool does (shown to the LLM when selecting tools)
	Description *string `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Instruction on how the RAG tool should be used effectively (shown in system prompt)
	Instruction *string `pulumi:"instruction"`
	// Custom name for the tool (defaults to RAG source name if not specified)
	Name *string `pulumi:"name"`
}

Tool configuration for the RAG source

type RagToolArgs

type RagToolArgs struct {
	// Description of what the tool does (shown to the LLM when selecting tools)
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Instruction on how the RAG tool should be used effectively (shown in system prompt)
	Instruction pulumi.StringPtrInput `pulumi:"instruction"`
	// Custom name for the tool (defaults to RAG source name if not specified)
	Name pulumi.StringPtrInput `pulumi:"name"`
}

Tool configuration for the RAG source

func (RagToolArgs) ElementType

func (RagToolArgs) ElementType() reflect.Type

func (RagToolArgs) ToRagToolOutput

func (i RagToolArgs) ToRagToolOutput() RagToolOutput

func (RagToolArgs) ToRagToolOutputWithContext

func (i RagToolArgs) ToRagToolOutputWithContext(ctx context.Context) RagToolOutput

func (RagToolArgs) ToRagToolPtrOutput

func (i RagToolArgs) ToRagToolPtrOutput() RagToolPtrOutput

func (RagToolArgs) ToRagToolPtrOutputWithContext

func (i RagToolArgs) ToRagToolPtrOutputWithContext(ctx context.Context) RagToolPtrOutput

type RagToolInput

type RagToolInput interface {
	pulumi.Input

	ToRagToolOutput() RagToolOutput
	ToRagToolOutputWithContext(context.Context) RagToolOutput
}

RagToolInput is an input type that accepts RagToolArgs and RagToolOutput values. You can construct a concrete instance of `RagToolInput` via:

RagToolArgs{...}

type RagToolOutput

type RagToolOutput struct{ *pulumi.OutputState }

Tool configuration for the RAG source

func (RagToolOutput) Description

func (o RagToolOutput) Description() pulumi.StringPtrOutput

Description of what the tool does (shown to the LLM when selecting tools)

func (RagToolOutput) ElementType

func (RagToolOutput) ElementType() reflect.Type

func (RagToolOutput) Extra

func (o RagToolOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagToolOutput) Instruction

func (o RagToolOutput) Instruction() pulumi.StringPtrOutput

Instruction on how the RAG tool should be used effectively (shown in system prompt)

func (RagToolOutput) Name

Custom name for the tool (defaults to RAG source name if not specified)

func (RagToolOutput) ToRagToolOutput

func (o RagToolOutput) ToRagToolOutput() RagToolOutput

func (RagToolOutput) ToRagToolOutputWithContext

func (o RagToolOutput) ToRagToolOutputWithContext(ctx context.Context) RagToolOutput

func (RagToolOutput) ToRagToolPtrOutput

func (o RagToolOutput) ToRagToolPtrOutput() RagToolPtrOutput

func (RagToolOutput) ToRagToolPtrOutputWithContext

func (o RagToolOutput) ToRagToolPtrOutputWithContext(ctx context.Context) RagToolPtrOutput

type RagToolPtrInput

type RagToolPtrInput interface {
	pulumi.Input

	ToRagToolPtrOutput() RagToolPtrOutput
	ToRagToolPtrOutputWithContext(context.Context) RagToolPtrOutput
}

RagToolPtrInput is an input type that accepts RagToolArgs, RagToolPtr and RagToolPtrOutput values. You can construct a concrete instance of `RagToolPtrInput` via:

        RagToolArgs{...}

or:

        nil

func RagToolPtr

func RagToolPtr(v *RagToolArgs) RagToolPtrInput

type RagToolPtrOutput

type RagToolPtrOutput struct{ *pulumi.OutputState }

func (RagToolPtrOutput) Description

func (o RagToolPtrOutput) Description() pulumi.StringPtrOutput

Description of what the tool does (shown to the LLM when selecting tools)

func (RagToolPtrOutput) Elem

func (RagToolPtrOutput) ElementType

func (RagToolPtrOutput) ElementType() reflect.Type

func (RagToolPtrOutput) Extra

func (o RagToolPtrOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RagToolPtrOutput) Instruction

func (o RagToolPtrOutput) Instruction() pulumi.StringPtrOutput

Instruction on how the RAG tool should be used effectively (shown in system prompt)

func (RagToolPtrOutput) Name

Custom name for the tool (defaults to RAG source name if not specified)

func (RagToolPtrOutput) ToRagToolPtrOutput

func (o RagToolPtrOutput) ToRagToolPtrOutput() RagToolPtrOutput

func (RagToolPtrOutput) ToRagToolPtrOutputWithContext

func (o RagToolPtrOutput) ToRagToolPtrOutputWithContext(ctx context.Context) RagToolPtrOutput

type RegistryAuth

type RegistryAuth struct {
	// The registry host, for example `ghcr.io`, `docker.io` or `localhost:5000`.
	Address string `pulumi:"address"`
	// The registry password or access token.
	Password *string `pulumi:"password"`
	// The registry username.
	Username *string `pulumi:"username"`
}

Credentials for an OCI registry.

type RegistryAuthArgs

type RegistryAuthArgs struct {
	// The registry host, for example `ghcr.io`, `docker.io` or `localhost:5000`.
	Address pulumi.StringInput `pulumi:"address"`
	// The registry password or access token.
	Password pulumi.StringPtrInput `pulumi:"password"`
	// The registry username.
	Username pulumi.StringPtrInput `pulumi:"username"`
}

Credentials for an OCI registry.

func (RegistryAuthArgs) ElementType

func (RegistryAuthArgs) ElementType() reflect.Type

func (RegistryAuthArgs) ToRegistryAuthOutput

func (i RegistryAuthArgs) ToRegistryAuthOutput() RegistryAuthOutput

func (RegistryAuthArgs) ToRegistryAuthOutputWithContext

func (i RegistryAuthArgs) ToRegistryAuthOutputWithContext(ctx context.Context) RegistryAuthOutput

type RegistryAuthArray

type RegistryAuthArray []RegistryAuthInput

func (RegistryAuthArray) ElementType

func (RegistryAuthArray) ElementType() reflect.Type

func (RegistryAuthArray) ToRegistryAuthArrayOutput

func (i RegistryAuthArray) ToRegistryAuthArrayOutput() RegistryAuthArrayOutput

func (RegistryAuthArray) ToRegistryAuthArrayOutputWithContext

func (i RegistryAuthArray) ToRegistryAuthArrayOutputWithContext(ctx context.Context) RegistryAuthArrayOutput

type RegistryAuthArrayInput

type RegistryAuthArrayInput interface {
	pulumi.Input

	ToRegistryAuthArrayOutput() RegistryAuthArrayOutput
	ToRegistryAuthArrayOutputWithContext(context.Context) RegistryAuthArrayOutput
}

RegistryAuthArrayInput is an input type that accepts RegistryAuthArray and RegistryAuthArrayOutput values. You can construct a concrete instance of `RegistryAuthArrayInput` via:

RegistryAuthArray{ RegistryAuthArgs{...} }

type RegistryAuthArrayOutput

type RegistryAuthArrayOutput struct{ *pulumi.OutputState }

func (RegistryAuthArrayOutput) ElementType

func (RegistryAuthArrayOutput) ElementType() reflect.Type

func (RegistryAuthArrayOutput) Index

func (RegistryAuthArrayOutput) ToRegistryAuthArrayOutput

func (o RegistryAuthArrayOutput) ToRegistryAuthArrayOutput() RegistryAuthArrayOutput

func (RegistryAuthArrayOutput) ToRegistryAuthArrayOutputWithContext

func (o RegistryAuthArrayOutput) ToRegistryAuthArrayOutputWithContext(ctx context.Context) RegistryAuthArrayOutput

type RegistryAuthInput

type RegistryAuthInput interface {
	pulumi.Input

	ToRegistryAuthOutput() RegistryAuthOutput
	ToRegistryAuthOutputWithContext(context.Context) RegistryAuthOutput
}

RegistryAuthInput is an input type that accepts RegistryAuthArgs and RegistryAuthOutput values. You can construct a concrete instance of `RegistryAuthInput` via:

RegistryAuthArgs{...}

type RegistryAuthOutput

type RegistryAuthOutput struct{ *pulumi.OutputState }

Credentials for an OCI registry.

func (RegistryAuthOutput) Address

The registry host, for example `ghcr.io`, `docker.io` or `localhost:5000`.

func (RegistryAuthOutput) ElementType

func (RegistryAuthOutput) ElementType() reflect.Type

func (RegistryAuthOutput) Password

The registry password or access token.

func (RegistryAuthOutput) ToRegistryAuthOutput

func (o RegistryAuthOutput) ToRegistryAuthOutput() RegistryAuthOutput

func (RegistryAuthOutput) ToRegistryAuthOutputWithContext

func (o RegistryAuthOutput) ToRegistryAuthOutputWithContext(ctx context.Context) RegistryAuthOutput

func (RegistryAuthOutput) Username

The registry username.

type Remote

type Remote struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// HTTP headers for remote requests
	Headers map[string]string `pulumi:"headers"`
	// Explicit OAuth credentials for servers that do not support Dynamic Client Registration
	Oauth *RemoteOAuth `pulumi:"oauth"`
	// Transport type for the remote connection
	TransportType *string `pulumi:"transportType"`
	// URL for the remote tool
	Url string `pulumi:"url"`
}

Remote tool configuration

type RemoteArgs

type RemoteArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// HTTP headers for remote requests
	Headers pulumi.StringMapInput `pulumi:"headers"`
	// Explicit OAuth credentials for servers that do not support Dynamic Client Registration
	Oauth RemoteOAuthPtrInput `pulumi:"oauth"`
	// Transport type for the remote connection
	TransportType pulumi.StringPtrInput `pulumi:"transportType"`
	// URL for the remote tool
	Url pulumi.StringInput `pulumi:"url"`
}

Remote tool configuration

func (RemoteArgs) ElementType

func (RemoteArgs) ElementType() reflect.Type

func (RemoteArgs) ToRemoteOutput

func (i RemoteArgs) ToRemoteOutput() RemoteOutput

func (RemoteArgs) ToRemoteOutputWithContext

func (i RemoteArgs) ToRemoteOutputWithContext(ctx context.Context) RemoteOutput

func (RemoteArgs) ToRemotePtrOutput

func (i RemoteArgs) ToRemotePtrOutput() RemotePtrOutput

func (RemoteArgs) ToRemotePtrOutputWithContext

func (i RemoteArgs) ToRemotePtrOutputWithContext(ctx context.Context) RemotePtrOutput

type RemoteInput

type RemoteInput interface {
	pulumi.Input

	ToRemoteOutput() RemoteOutput
	ToRemoteOutputWithContext(context.Context) RemoteOutput
}

RemoteInput is an input type that accepts RemoteArgs and RemoteOutput values. You can construct a concrete instance of `RemoteInput` via:

RemoteArgs{...}

type RemoteOAuth

type RemoteOAuth struct {
	// Fixed port for the OAuth callback server (default: random available port)
	CallbackPort *int `pulumi:"callbackPort"`
	// Optional OAuth redirect URI used in place of http://127.0.0.1:{callbackPort}/callback. The literal placeholder ${callbackPort} is replaced with the actual local callback port at runtime. The external URL is expected to redirect the browser back to the local callback server.
	CallbackRedirectURL *string `pulumi:"callbackRedirectURL"`
	// OAuth client ID. When omitted, docker-agent uses Dynamic Client Registration or prompts interactively
	ClientId *string `pulumi:"clientId"`
	// OAuth client secret
	ClientSecret *string `pulumi:"clientSecret"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// OAuth scopes to request
	Scopes []string `pulumi:"scopes"`
}

OAuth configuration for remote MCP servers. Set clientId for servers that do not support Dynamic Client Registration (RFC 7591); other fields tune the flow and also apply when the client is registered dynamically

type RemoteOAuthArgs

type RemoteOAuthArgs struct {
	// Fixed port for the OAuth callback server (default: random available port)
	CallbackPort pulumi.IntPtrInput `pulumi:"callbackPort"`
	// Optional OAuth redirect URI used in place of http://127.0.0.1:{callbackPort}/callback. The literal placeholder ${callbackPort} is replaced with the actual local callback port at runtime. The external URL is expected to redirect the browser back to the local callback server.
	CallbackRedirectURL pulumi.StringPtrInput `pulumi:"callbackRedirectURL"`
	// OAuth client ID. When omitted, docker-agent uses Dynamic Client Registration or prompts interactively
	ClientId pulumi.StringPtrInput `pulumi:"clientId"`
	// OAuth client secret
	ClientSecret pulumi.StringPtrInput `pulumi:"clientSecret"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// OAuth scopes to request
	Scopes pulumi.StringArrayInput `pulumi:"scopes"`
}

OAuth configuration for remote MCP servers. Set clientId for servers that do not support Dynamic Client Registration (RFC 7591); other fields tune the flow and also apply when the client is registered dynamically

func (RemoteOAuthArgs) ElementType

func (RemoteOAuthArgs) ElementType() reflect.Type

func (RemoteOAuthArgs) ToRemoteOAuthOutput

func (i RemoteOAuthArgs) ToRemoteOAuthOutput() RemoteOAuthOutput

func (RemoteOAuthArgs) ToRemoteOAuthOutputWithContext

func (i RemoteOAuthArgs) ToRemoteOAuthOutputWithContext(ctx context.Context) RemoteOAuthOutput

func (RemoteOAuthArgs) ToRemoteOAuthPtrOutput

func (i RemoteOAuthArgs) ToRemoteOAuthPtrOutput() RemoteOAuthPtrOutput

func (RemoteOAuthArgs) ToRemoteOAuthPtrOutputWithContext

func (i RemoteOAuthArgs) ToRemoteOAuthPtrOutputWithContext(ctx context.Context) RemoteOAuthPtrOutput

type RemoteOAuthInput

type RemoteOAuthInput interface {
	pulumi.Input

	ToRemoteOAuthOutput() RemoteOAuthOutput
	ToRemoteOAuthOutputWithContext(context.Context) RemoteOAuthOutput
}

RemoteOAuthInput is an input type that accepts RemoteOAuthArgs and RemoteOAuthOutput values. You can construct a concrete instance of `RemoteOAuthInput` via:

RemoteOAuthArgs{...}

type RemoteOAuthOutput

type RemoteOAuthOutput struct{ *pulumi.OutputState }

OAuth configuration for remote MCP servers. Set clientId for servers that do not support Dynamic Client Registration (RFC 7591); other fields tune the flow and also apply when the client is registered dynamically

func (RemoteOAuthOutput) CallbackPort

func (o RemoteOAuthOutput) CallbackPort() pulumi.IntPtrOutput

Fixed port for the OAuth callback server (default: random available port)

func (RemoteOAuthOutput) CallbackRedirectURL

func (o RemoteOAuthOutput) CallbackRedirectURL() pulumi.StringPtrOutput

Optional OAuth redirect URI used in place of http://127.0.0.1:{callbackPort}/callback. The literal placeholder ${callbackPort} is replaced with the actual local callback port at runtime. The external URL is expected to redirect the browser back to the local callback server.

func (RemoteOAuthOutput) ClientId

OAuth client ID. When omitted, docker-agent uses Dynamic Client Registration or prompts interactively

func (RemoteOAuthOutput) ClientSecret

func (o RemoteOAuthOutput) ClientSecret() pulumi.StringPtrOutput

OAuth client secret

func (RemoteOAuthOutput) ElementType

func (RemoteOAuthOutput) ElementType() reflect.Type

func (RemoteOAuthOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RemoteOAuthOutput) Scopes

OAuth scopes to request

func (RemoteOAuthOutput) ToRemoteOAuthOutput

func (o RemoteOAuthOutput) ToRemoteOAuthOutput() RemoteOAuthOutput

func (RemoteOAuthOutput) ToRemoteOAuthOutputWithContext

func (o RemoteOAuthOutput) ToRemoteOAuthOutputWithContext(ctx context.Context) RemoteOAuthOutput

func (RemoteOAuthOutput) ToRemoteOAuthPtrOutput

func (o RemoteOAuthOutput) ToRemoteOAuthPtrOutput() RemoteOAuthPtrOutput

func (RemoteOAuthOutput) ToRemoteOAuthPtrOutputWithContext

func (o RemoteOAuthOutput) ToRemoteOAuthPtrOutputWithContext(ctx context.Context) RemoteOAuthPtrOutput

type RemoteOAuthPtrInput

type RemoteOAuthPtrInput interface {
	pulumi.Input

	ToRemoteOAuthPtrOutput() RemoteOAuthPtrOutput
	ToRemoteOAuthPtrOutputWithContext(context.Context) RemoteOAuthPtrOutput
}

RemoteOAuthPtrInput is an input type that accepts RemoteOAuthArgs, RemoteOAuthPtr and RemoteOAuthPtrOutput values. You can construct a concrete instance of `RemoteOAuthPtrInput` via:

        RemoteOAuthArgs{...}

or:

        nil

func RemoteOAuthPtr

func RemoteOAuthPtr(v *RemoteOAuthArgs) RemoteOAuthPtrInput

type RemoteOAuthPtrOutput

type RemoteOAuthPtrOutput struct{ *pulumi.OutputState }

func (RemoteOAuthPtrOutput) CallbackPort

func (o RemoteOAuthPtrOutput) CallbackPort() pulumi.IntPtrOutput

Fixed port for the OAuth callback server (default: random available port)

func (RemoteOAuthPtrOutput) CallbackRedirectURL

func (o RemoteOAuthPtrOutput) CallbackRedirectURL() pulumi.StringPtrOutput

Optional OAuth redirect URI used in place of http://127.0.0.1:{callbackPort}/callback. The literal placeholder ${callbackPort} is replaced with the actual local callback port at runtime. The external URL is expected to redirect the browser back to the local callback server.

func (RemoteOAuthPtrOutput) ClientId

OAuth client ID. When omitted, docker-agent uses Dynamic Client Registration or prompts interactively

func (RemoteOAuthPtrOutput) ClientSecret

func (o RemoteOAuthPtrOutput) ClientSecret() pulumi.StringPtrOutput

OAuth client secret

func (RemoteOAuthPtrOutput) Elem

func (RemoteOAuthPtrOutput) ElementType

func (RemoteOAuthPtrOutput) ElementType() reflect.Type

func (RemoteOAuthPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RemoteOAuthPtrOutput) Scopes

OAuth scopes to request

func (RemoteOAuthPtrOutput) ToRemoteOAuthPtrOutput

func (o RemoteOAuthPtrOutput) ToRemoteOAuthPtrOutput() RemoteOAuthPtrOutput

func (RemoteOAuthPtrOutput) ToRemoteOAuthPtrOutputWithContext

func (o RemoteOAuthPtrOutput) ToRemoteOAuthPtrOutputWithContext(ctx context.Context) RemoteOAuthPtrOutput

type RemoteOutput

type RemoteOutput struct{ *pulumi.OutputState }

Remote tool configuration

func (RemoteOutput) ElementType

func (RemoteOutput) ElementType() reflect.Type

func (RemoteOutput) Extra

func (o RemoteOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RemoteOutput) Headers

func (o RemoteOutput) Headers() pulumi.StringMapOutput

HTTP headers for remote requests

func (RemoteOutput) Oauth

Explicit OAuth credentials for servers that do not support Dynamic Client Registration

func (RemoteOutput) ToRemoteOutput

func (o RemoteOutput) ToRemoteOutput() RemoteOutput

func (RemoteOutput) ToRemoteOutputWithContext

func (o RemoteOutput) ToRemoteOutputWithContext(ctx context.Context) RemoteOutput

func (RemoteOutput) ToRemotePtrOutput

func (o RemoteOutput) ToRemotePtrOutput() RemotePtrOutput

func (RemoteOutput) ToRemotePtrOutputWithContext

func (o RemoteOutput) ToRemotePtrOutputWithContext(ctx context.Context) RemotePtrOutput

func (RemoteOutput) TransportType

func (o RemoteOutput) TransportType() pulumi.StringPtrOutput

Transport type for the remote connection

func (RemoteOutput) Url

URL for the remote tool

type RemotePtrInput

type RemotePtrInput interface {
	pulumi.Input

	ToRemotePtrOutput() RemotePtrOutput
	ToRemotePtrOutputWithContext(context.Context) RemotePtrOutput
}

RemotePtrInput is an input type that accepts RemoteArgs, RemotePtr and RemotePtrOutput values. You can construct a concrete instance of `RemotePtrInput` via:

        RemoteArgs{...}

or:

        nil

func RemotePtr

func RemotePtr(v *RemoteArgs) RemotePtrInput

type RemotePtrOutput

type RemotePtrOutput struct{ *pulumi.OutputState }

func (RemotePtrOutput) Elem

func (o RemotePtrOutput) Elem() RemoteOutput

func (RemotePtrOutput) ElementType

func (RemotePtrOutput) ElementType() reflect.Type

func (RemotePtrOutput) Extra

func (o RemotePtrOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RemotePtrOutput) Headers

HTTP headers for remote requests

func (RemotePtrOutput) Oauth

Explicit OAuth credentials for servers that do not support Dynamic Client Registration

func (RemotePtrOutput) ToRemotePtrOutput

func (o RemotePtrOutput) ToRemotePtrOutput() RemotePtrOutput

func (RemotePtrOutput) ToRemotePtrOutputWithContext

func (o RemotePtrOutput) ToRemotePtrOutputWithContext(ctx context.Context) RemotePtrOutput

func (RemotePtrOutput) TransportType

func (o RemotePtrOutput) TransportType() pulumi.StringPtrOutput

Transport type for the remote connection

func (RemotePtrOutput) Url

URL for the remote tool

type RerunPolicy added in v0.1.2

type RerunPolicy string

func (RerunPolicy) ElementType added in v0.1.2

func (RerunPolicy) ElementType() reflect.Type

func (RerunPolicy) ToRerunPolicyOutput added in v0.1.2

func (e RerunPolicy) ToRerunPolicyOutput() RerunPolicyOutput

func (RerunPolicy) ToRerunPolicyOutputWithContext added in v0.1.2

func (e RerunPolicy) ToRerunPolicyOutputWithContext(ctx context.Context) RerunPolicyOutput

func (RerunPolicy) ToRerunPolicyPtrOutput added in v0.1.2

func (e RerunPolicy) ToRerunPolicyPtrOutput() RerunPolicyPtrOutput

func (RerunPolicy) ToRerunPolicyPtrOutputWithContext added in v0.1.2

func (e RerunPolicy) ToRerunPolicyPtrOutputWithContext(ctx context.Context) RerunPolicyPtrOutput

func (RerunPolicy) ToStringOutput added in v0.1.2

func (e RerunPolicy) ToStringOutput() pulumi.StringOutput

func (RerunPolicy) ToStringOutputWithContext added in v0.1.2

func (e RerunPolicy) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RerunPolicy) ToStringPtrOutput added in v0.1.2

func (e RerunPolicy) ToStringPtrOutput() pulumi.StringPtrOutput

func (RerunPolicy) ToStringPtrOutputWithContext added in v0.1.2

func (e RerunPolicy) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RerunPolicyInput added in v0.1.2

type RerunPolicyInput interface {
	pulumi.Input

	ToRerunPolicyOutput() RerunPolicyOutput
	ToRerunPolicyOutputWithContext(context.Context) RerunPolicyOutput
}

RerunPolicyInput is an input type that accepts values of the RerunPolicy enum A concrete instance of `RerunPolicyInput` can be one of the following:

RerunPolicyOnChange
RerunPolicyAlways

type RerunPolicyOutput added in v0.1.2

type RerunPolicyOutput struct{ *pulumi.OutputState }

func (RerunPolicyOutput) ElementType added in v0.1.2

func (RerunPolicyOutput) ElementType() reflect.Type

func (RerunPolicyOutput) ToRerunPolicyOutput added in v0.1.2

func (o RerunPolicyOutput) ToRerunPolicyOutput() RerunPolicyOutput

func (RerunPolicyOutput) ToRerunPolicyOutputWithContext added in v0.1.2

func (o RerunPolicyOutput) ToRerunPolicyOutputWithContext(ctx context.Context) RerunPolicyOutput

func (RerunPolicyOutput) ToRerunPolicyPtrOutput added in v0.1.2

func (o RerunPolicyOutput) ToRerunPolicyPtrOutput() RerunPolicyPtrOutput

func (RerunPolicyOutput) ToRerunPolicyPtrOutputWithContext added in v0.1.2

func (o RerunPolicyOutput) ToRerunPolicyPtrOutputWithContext(ctx context.Context) RerunPolicyPtrOutput

func (RerunPolicyOutput) ToStringOutput added in v0.1.2

func (o RerunPolicyOutput) ToStringOutput() pulumi.StringOutput

func (RerunPolicyOutput) ToStringOutputWithContext added in v0.1.2

func (o RerunPolicyOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RerunPolicyOutput) ToStringPtrOutput added in v0.1.2

func (o RerunPolicyOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RerunPolicyOutput) ToStringPtrOutputWithContext added in v0.1.2

func (o RerunPolicyOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RerunPolicyPtrInput added in v0.1.2

type RerunPolicyPtrInput interface {
	pulumi.Input

	ToRerunPolicyPtrOutput() RerunPolicyPtrOutput
	ToRerunPolicyPtrOutputWithContext(context.Context) RerunPolicyPtrOutput
}

func RerunPolicyPtr added in v0.1.2

func RerunPolicyPtr(v string) RerunPolicyPtrInput

type RerunPolicyPtrOutput added in v0.1.2

type RerunPolicyPtrOutput struct{ *pulumi.OutputState }

func (RerunPolicyPtrOutput) Elem added in v0.1.2

func (RerunPolicyPtrOutput) ElementType added in v0.1.2

func (RerunPolicyPtrOutput) ElementType() reflect.Type

func (RerunPolicyPtrOutput) ToRerunPolicyPtrOutput added in v0.1.2

func (o RerunPolicyPtrOutput) ToRerunPolicyPtrOutput() RerunPolicyPtrOutput

func (RerunPolicyPtrOutput) ToRerunPolicyPtrOutputWithContext added in v0.1.2

func (o RerunPolicyPtrOutput) ToRerunPolicyPtrOutputWithContext(ctx context.Context) RerunPolicyPtrOutput

func (RerunPolicyPtrOutput) ToStringPtrOutput added in v0.1.2

func (o RerunPolicyPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RerunPolicyPtrOutput) ToStringPtrOutputWithContext added in v0.1.2

func (o RerunPolicyPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ResponseCache

type ResponseCache struct {
	// When true, questions must match exactly (including case) to hit the cache. Default: false (case-insensitive matching).
	CaseSensitive *bool `pulumi:"caseSensitive"`
	// Set to true to enable the cache. When false (or when the cache section is omitted), no caching is performed. Defaults to `false`.
	Enabled *bool `pulumi:"enabled"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Path to a JSON file used to persist cache entries across runs. Relative paths are resolved against the agent's config directory. When empty, the cache lives only in memory.
	Path *string `pulumi:"path"`
	// When true, leading and trailing whitespace is stripped from questions before they are compared. Default: false.
	TrimSpaces *bool `pulumi:"trimSpaces"`
}

Configuration for the agent's response cache. When enabled, the assistant response produced for a given user question is stored and replayed verbatim the next time the same question is asked, skipping the model entirely. Two normalization options control what 'same question' means: case_sensitive (default false) toggles case-insensitive matching, and trim_spaces (default false) strips leading/trailing whitespace before comparison. Set 'path' to persist entries to a JSON file (relative paths resolve against the agent config directory); leave it empty to keep entries in memory only.

type ResponseCacheArgs

type ResponseCacheArgs struct {
	// When true, questions must match exactly (including case) to hit the cache. Default: false (case-insensitive matching).
	CaseSensitive pulumi.BoolPtrInput `pulumi:"caseSensitive"`
	// Set to true to enable the cache. When false (or when the cache section is omitted), no caching is performed. Defaults to `false`.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Path to a JSON file used to persist cache entries across runs. Relative paths are resolved against the agent's config directory. When empty, the cache lives only in memory.
	Path pulumi.StringPtrInput `pulumi:"path"`
	// When true, leading and trailing whitespace is stripped from questions before they are compared. Default: false.
	TrimSpaces pulumi.BoolPtrInput `pulumi:"trimSpaces"`
}

Configuration for the agent's response cache. When enabled, the assistant response produced for a given user question is stored and replayed verbatim the next time the same question is asked, skipping the model entirely. Two normalization options control what 'same question' means: case_sensitive (default false) toggles case-insensitive matching, and trim_spaces (default false) strips leading/trailing whitespace before comparison. Set 'path' to persist entries to a JSON file (relative paths resolve against the agent config directory); leave it empty to keep entries in memory only.

func (ResponseCacheArgs) ElementType

func (ResponseCacheArgs) ElementType() reflect.Type

func (ResponseCacheArgs) ToResponseCacheOutput

func (i ResponseCacheArgs) ToResponseCacheOutput() ResponseCacheOutput

func (ResponseCacheArgs) ToResponseCacheOutputWithContext

func (i ResponseCacheArgs) ToResponseCacheOutputWithContext(ctx context.Context) ResponseCacheOutput

func (ResponseCacheArgs) ToResponseCachePtrOutput

func (i ResponseCacheArgs) ToResponseCachePtrOutput() ResponseCachePtrOutput

func (ResponseCacheArgs) ToResponseCachePtrOutputWithContext

func (i ResponseCacheArgs) ToResponseCachePtrOutputWithContext(ctx context.Context) ResponseCachePtrOutput

type ResponseCacheInput

type ResponseCacheInput interface {
	pulumi.Input

	ToResponseCacheOutput() ResponseCacheOutput
	ToResponseCacheOutputWithContext(context.Context) ResponseCacheOutput
}

ResponseCacheInput is an input type that accepts ResponseCacheArgs and ResponseCacheOutput values. You can construct a concrete instance of `ResponseCacheInput` via:

ResponseCacheArgs{...}

type ResponseCacheOutput

type ResponseCacheOutput struct{ *pulumi.OutputState }

Configuration for the agent's response cache. When enabled, the assistant response produced for a given user question is stored and replayed verbatim the next time the same question is asked, skipping the model entirely. Two normalization options control what 'same question' means: case_sensitive (default false) toggles case-insensitive matching, and trim_spaces (default false) strips leading/trailing whitespace before comparison. Set 'path' to persist entries to a JSON file (relative paths resolve against the agent config directory); leave it empty to keep entries in memory only.

func (ResponseCacheOutput) CaseSensitive

func (o ResponseCacheOutput) CaseSensitive() pulumi.BoolPtrOutput

When true, questions must match exactly (including case) to hit the cache. Default: false (case-insensitive matching).

func (ResponseCacheOutput) ElementType

func (ResponseCacheOutput) ElementType() reflect.Type

func (ResponseCacheOutput) Enabled

Set to true to enable the cache. When false (or when the cache section is omitted), no caching is performed. Defaults to `false`.

func (ResponseCacheOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ResponseCacheOutput) Path

Path to a JSON file used to persist cache entries across runs. Relative paths are resolved against the agent's config directory. When empty, the cache lives only in memory.

func (ResponseCacheOutput) ToResponseCacheOutput

func (o ResponseCacheOutput) ToResponseCacheOutput() ResponseCacheOutput

func (ResponseCacheOutput) ToResponseCacheOutputWithContext

func (o ResponseCacheOutput) ToResponseCacheOutputWithContext(ctx context.Context) ResponseCacheOutput

func (ResponseCacheOutput) ToResponseCachePtrOutput

func (o ResponseCacheOutput) ToResponseCachePtrOutput() ResponseCachePtrOutput

func (ResponseCacheOutput) ToResponseCachePtrOutputWithContext

func (o ResponseCacheOutput) ToResponseCachePtrOutputWithContext(ctx context.Context) ResponseCachePtrOutput

func (ResponseCacheOutput) TrimSpaces

func (o ResponseCacheOutput) TrimSpaces() pulumi.BoolPtrOutput

When true, leading and trailing whitespace is stripped from questions before they are compared. Default: false.

type ResponseCachePtrInput

type ResponseCachePtrInput interface {
	pulumi.Input

	ToResponseCachePtrOutput() ResponseCachePtrOutput
	ToResponseCachePtrOutputWithContext(context.Context) ResponseCachePtrOutput
}

ResponseCachePtrInput is an input type that accepts ResponseCacheArgs, ResponseCachePtr and ResponseCachePtrOutput values. You can construct a concrete instance of `ResponseCachePtrInput` via:

        ResponseCacheArgs{...}

or:

        nil

type ResponseCachePtrOutput

type ResponseCachePtrOutput struct{ *pulumi.OutputState }

func (ResponseCachePtrOutput) CaseSensitive

func (o ResponseCachePtrOutput) CaseSensitive() pulumi.BoolPtrOutput

When true, questions must match exactly (including case) to hit the cache. Default: false (case-insensitive matching).

func (ResponseCachePtrOutput) Elem

func (ResponseCachePtrOutput) ElementType

func (ResponseCachePtrOutput) ElementType() reflect.Type

func (ResponseCachePtrOutput) Enabled

Set to true to enable the cache. When false (or when the cache section is omitted), no caching is performed. Defaults to `false`.

func (ResponseCachePtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ResponseCachePtrOutput) Path

Path to a JSON file used to persist cache entries across runs. Relative paths are resolved against the agent's config directory. When empty, the cache lives only in memory.

func (ResponseCachePtrOutput) ToResponseCachePtrOutput

func (o ResponseCachePtrOutput) ToResponseCachePtrOutput() ResponseCachePtrOutput

func (ResponseCachePtrOutput) ToResponseCachePtrOutputWithContext

func (o ResponseCachePtrOutput) ToResponseCachePtrOutputWithContext(ctx context.Context) ResponseCachePtrOutput

func (ResponseCachePtrOutput) TrimSpaces

When true, leading and trailing whitespace is stripped from questions before they are compared. Default: false.

type RestartPolicy

type RestartPolicy string

func (RestartPolicy) ElementType

func (RestartPolicy) ElementType() reflect.Type

func (RestartPolicy) ToRestartPolicyOutput

func (e RestartPolicy) ToRestartPolicyOutput() RestartPolicyOutput

func (RestartPolicy) ToRestartPolicyOutputWithContext

func (e RestartPolicy) ToRestartPolicyOutputWithContext(ctx context.Context) RestartPolicyOutput

func (RestartPolicy) ToRestartPolicyPtrOutput

func (e RestartPolicy) ToRestartPolicyPtrOutput() RestartPolicyPtrOutput

func (RestartPolicy) ToRestartPolicyPtrOutputWithContext

func (e RestartPolicy) ToRestartPolicyPtrOutputWithContext(ctx context.Context) RestartPolicyPtrOutput

func (RestartPolicy) ToStringOutput

func (e RestartPolicy) ToStringOutput() pulumi.StringOutput

func (RestartPolicy) ToStringOutputWithContext

func (e RestartPolicy) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RestartPolicy) ToStringPtrOutput

func (e RestartPolicy) ToStringPtrOutput() pulumi.StringPtrOutput

func (RestartPolicy) ToStringPtrOutputWithContext

func (e RestartPolicy) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RestartPolicyInput

type RestartPolicyInput interface {
	pulumi.Input

	ToRestartPolicyOutput() RestartPolicyOutput
	ToRestartPolicyOutputWithContext(context.Context) RestartPolicyOutput
}

RestartPolicyInput is an input type that accepts values of the RestartPolicy enum A concrete instance of `RestartPolicyInput` can be one of the following:

RestartPolicyNever
RestartPolicyOnFailure
RestartPolicyAlways

type RestartPolicyOutput

type RestartPolicyOutput struct{ *pulumi.OutputState }

func (RestartPolicyOutput) ElementType

func (RestartPolicyOutput) ElementType() reflect.Type

func (RestartPolicyOutput) ToRestartPolicyOutput

func (o RestartPolicyOutput) ToRestartPolicyOutput() RestartPolicyOutput

func (RestartPolicyOutput) ToRestartPolicyOutputWithContext

func (o RestartPolicyOutput) ToRestartPolicyOutputWithContext(ctx context.Context) RestartPolicyOutput

func (RestartPolicyOutput) ToRestartPolicyPtrOutput

func (o RestartPolicyOutput) ToRestartPolicyPtrOutput() RestartPolicyPtrOutput

func (RestartPolicyOutput) ToRestartPolicyPtrOutputWithContext

func (o RestartPolicyOutput) ToRestartPolicyPtrOutputWithContext(ctx context.Context) RestartPolicyPtrOutput

func (RestartPolicyOutput) ToStringOutput

func (o RestartPolicyOutput) ToStringOutput() pulumi.StringOutput

func (RestartPolicyOutput) ToStringOutputWithContext

func (o RestartPolicyOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (RestartPolicyOutput) ToStringPtrOutput

func (o RestartPolicyOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RestartPolicyOutput) ToStringPtrOutputWithContext

func (o RestartPolicyOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RestartPolicyPtrInput

type RestartPolicyPtrInput interface {
	pulumi.Input

	ToRestartPolicyPtrOutput() RestartPolicyPtrOutput
	ToRestartPolicyPtrOutputWithContext(context.Context) RestartPolicyPtrOutput
}

func RestartPolicyPtr

func RestartPolicyPtr(v string) RestartPolicyPtrInput

type RestartPolicyPtrOutput

type RestartPolicyPtrOutput struct{ *pulumi.OutputState }

func (RestartPolicyPtrOutput) Elem

func (RestartPolicyPtrOutput) ElementType

func (RestartPolicyPtrOutput) ElementType() reflect.Type

func (RestartPolicyPtrOutput) ToRestartPolicyPtrOutput

func (o RestartPolicyPtrOutput) ToRestartPolicyPtrOutput() RestartPolicyPtrOutput

func (RestartPolicyPtrOutput) ToRestartPolicyPtrOutputWithContext

func (o RestartPolicyPtrOutput) ToRestartPolicyPtrOutputWithContext(ctx context.Context) RestartPolicyPtrOutput

func (RestartPolicyPtrOutput) ToStringPtrOutput

func (o RestartPolicyPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (RestartPolicyPtrOutput) ToStringPtrOutputWithContext

func (o RestartPolicyPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type RoutingPolicy

type RoutingPolicy struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Minimum selected-choice probability required to use its route. Enforced by the runtime, not the evaluator prompt; calibrate on representative requests.
	MinProbability float64 `pulumi:"minProbability"`
	// Every evaluator choice mapped to an agent in routing.allowed_agents. Missing or unknown choices are configuration errors.
	Routes map[string]string `pulumi:"routes"`
}

Maps a choice evaluator's outcomes to agents. Kept apart from the evaluator so the same assessment can drive different actions.

type RoutingPolicyArgs

type RoutingPolicyArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Minimum selected-choice probability required to use its route. Enforced by the runtime, not the evaluator prompt; calibrate on representative requests.
	MinProbability pulumi.Float64Input `pulumi:"minProbability"`
	// Every evaluator choice mapped to an agent in routing.allowed_agents. Missing or unknown choices are configuration errors.
	Routes pulumi.StringMapInput `pulumi:"routes"`
}

Maps a choice evaluator's outcomes to agents. Kept apart from the evaluator so the same assessment can drive different actions.

func (RoutingPolicyArgs) ElementType

func (RoutingPolicyArgs) ElementType() reflect.Type

func (RoutingPolicyArgs) ToRoutingPolicyOutput

func (i RoutingPolicyArgs) ToRoutingPolicyOutput() RoutingPolicyOutput

func (RoutingPolicyArgs) ToRoutingPolicyOutputWithContext

func (i RoutingPolicyArgs) ToRoutingPolicyOutputWithContext(ctx context.Context) RoutingPolicyOutput

func (RoutingPolicyArgs) ToRoutingPolicyPtrOutput

func (i RoutingPolicyArgs) ToRoutingPolicyPtrOutput() RoutingPolicyPtrOutput

func (RoutingPolicyArgs) ToRoutingPolicyPtrOutputWithContext

func (i RoutingPolicyArgs) ToRoutingPolicyPtrOutputWithContext(ctx context.Context) RoutingPolicyPtrOutput

type RoutingPolicyInput

type RoutingPolicyInput interface {
	pulumi.Input

	ToRoutingPolicyOutput() RoutingPolicyOutput
	ToRoutingPolicyOutputWithContext(context.Context) RoutingPolicyOutput
}

RoutingPolicyInput is an input type that accepts RoutingPolicyArgs and RoutingPolicyOutput values. You can construct a concrete instance of `RoutingPolicyInput` via:

RoutingPolicyArgs{...}

type RoutingPolicyOutput

type RoutingPolicyOutput struct{ *pulumi.OutputState }

Maps a choice evaluator's outcomes to agents. Kept apart from the evaluator so the same assessment can drive different actions.

func (RoutingPolicyOutput) ElementType

func (RoutingPolicyOutput) ElementType() reflect.Type

func (RoutingPolicyOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RoutingPolicyOutput) MinProbability

func (o RoutingPolicyOutput) MinProbability() pulumi.Float64Output

Minimum selected-choice probability required to use its route. Enforced by the runtime, not the evaluator prompt; calibrate on representative requests.

func (RoutingPolicyOutput) Routes

Every evaluator choice mapped to an agent in routing.allowed_agents. Missing or unknown choices are configuration errors.

func (RoutingPolicyOutput) ToRoutingPolicyOutput

func (o RoutingPolicyOutput) ToRoutingPolicyOutput() RoutingPolicyOutput

func (RoutingPolicyOutput) ToRoutingPolicyOutputWithContext

func (o RoutingPolicyOutput) ToRoutingPolicyOutputWithContext(ctx context.Context) RoutingPolicyOutput

func (RoutingPolicyOutput) ToRoutingPolicyPtrOutput

func (o RoutingPolicyOutput) ToRoutingPolicyPtrOutput() RoutingPolicyPtrOutput

func (RoutingPolicyOutput) ToRoutingPolicyPtrOutputWithContext

func (o RoutingPolicyOutput) ToRoutingPolicyPtrOutputWithContext(ctx context.Context) RoutingPolicyPtrOutput

type RoutingPolicyPtrInput

type RoutingPolicyPtrInput interface {
	pulumi.Input

	ToRoutingPolicyPtrOutput() RoutingPolicyPtrOutput
	ToRoutingPolicyPtrOutputWithContext(context.Context) RoutingPolicyPtrOutput
}

RoutingPolicyPtrInput is an input type that accepts RoutingPolicyArgs, RoutingPolicyPtr and RoutingPolicyPtrOutput values. You can construct a concrete instance of `RoutingPolicyPtrInput` via:

        RoutingPolicyArgs{...}

or:

        nil

type RoutingPolicyPtrOutput

type RoutingPolicyPtrOutput struct{ *pulumi.OutputState }

func (RoutingPolicyPtrOutput) Elem

func (RoutingPolicyPtrOutput) ElementType

func (RoutingPolicyPtrOutput) ElementType() reflect.Type

func (RoutingPolicyPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RoutingPolicyPtrOutput) MinProbability

func (o RoutingPolicyPtrOutput) MinProbability() pulumi.Float64PtrOutput

Minimum selected-choice probability required to use its route. Enforced by the runtime, not the evaluator prompt; calibrate on representative requests.

func (RoutingPolicyPtrOutput) Routes

Every evaluator choice mapped to an agent in routing.allowed_agents. Missing or unknown choices are configuration errors.

func (RoutingPolicyPtrOutput) ToRoutingPolicyPtrOutput

func (o RoutingPolicyPtrOutput) ToRoutingPolicyPtrOutput() RoutingPolicyPtrOutput

func (RoutingPolicyPtrOutput) ToRoutingPolicyPtrOutputWithContext

func (o RoutingPolicyPtrOutput) ToRoutingPolicyPtrOutputWithContext(ctx context.Context) RoutingPolicyPtrOutput

type RoutingRule

type RoutingRule struct {
	// Example phrases that should trigger routing to this model
	Examples []string `pulumi:"examples"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Model reference (another model name in the models section or inline spec like 'openai/gpt-4o')
	Model string `pulumi:"model"`
}

A single routing rule that maps example phrases to a target model

type RoutingRuleArgs

type RoutingRuleArgs struct {
	// Example phrases that should trigger routing to this model
	Examples pulumi.StringArrayInput `pulumi:"examples"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Model reference (another model name in the models section or inline spec like 'openai/gpt-4o')
	Model pulumi.StringInput `pulumi:"model"`
}

A single routing rule that maps example phrases to a target model

func (RoutingRuleArgs) ElementType

func (RoutingRuleArgs) ElementType() reflect.Type

func (RoutingRuleArgs) ToRoutingRuleOutput

func (i RoutingRuleArgs) ToRoutingRuleOutput() RoutingRuleOutput

func (RoutingRuleArgs) ToRoutingRuleOutputWithContext

func (i RoutingRuleArgs) ToRoutingRuleOutputWithContext(ctx context.Context) RoutingRuleOutput

type RoutingRuleArray

type RoutingRuleArray []RoutingRuleInput

func (RoutingRuleArray) ElementType

func (RoutingRuleArray) ElementType() reflect.Type

func (RoutingRuleArray) ToRoutingRuleArrayOutput

func (i RoutingRuleArray) ToRoutingRuleArrayOutput() RoutingRuleArrayOutput

func (RoutingRuleArray) ToRoutingRuleArrayOutputWithContext

func (i RoutingRuleArray) ToRoutingRuleArrayOutputWithContext(ctx context.Context) RoutingRuleArrayOutput

type RoutingRuleArrayInput

type RoutingRuleArrayInput interface {
	pulumi.Input

	ToRoutingRuleArrayOutput() RoutingRuleArrayOutput
	ToRoutingRuleArrayOutputWithContext(context.Context) RoutingRuleArrayOutput
}

RoutingRuleArrayInput is an input type that accepts RoutingRuleArray and RoutingRuleArrayOutput values. You can construct a concrete instance of `RoutingRuleArrayInput` via:

RoutingRuleArray{ RoutingRuleArgs{...} }

type RoutingRuleArrayOutput

type RoutingRuleArrayOutput struct{ *pulumi.OutputState }

func (RoutingRuleArrayOutput) ElementType

func (RoutingRuleArrayOutput) ElementType() reflect.Type

func (RoutingRuleArrayOutput) Index

func (RoutingRuleArrayOutput) ToRoutingRuleArrayOutput

func (o RoutingRuleArrayOutput) ToRoutingRuleArrayOutput() RoutingRuleArrayOutput

func (RoutingRuleArrayOutput) ToRoutingRuleArrayOutputWithContext

func (o RoutingRuleArrayOutput) ToRoutingRuleArrayOutputWithContext(ctx context.Context) RoutingRuleArrayOutput

type RoutingRuleInput

type RoutingRuleInput interface {
	pulumi.Input

	ToRoutingRuleOutput() RoutingRuleOutput
	ToRoutingRuleOutputWithContext(context.Context) RoutingRuleOutput
}

RoutingRuleInput is an input type that accepts RoutingRuleArgs and RoutingRuleOutput values. You can construct a concrete instance of `RoutingRuleInput` via:

RoutingRuleArgs{...}

type RoutingRuleOutput

type RoutingRuleOutput struct{ *pulumi.OutputState }

A single routing rule that maps example phrases to a target model

func (RoutingRuleOutput) ElementType

func (RoutingRuleOutput) ElementType() reflect.Type

func (RoutingRuleOutput) Examples

Example phrases that should trigger routing to this model

func (RoutingRuleOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RoutingRuleOutput) Model

Model reference (another model name in the models section or inline spec like 'openai/gpt-4o')

func (RoutingRuleOutput) ToRoutingRuleOutput

func (o RoutingRuleOutput) ToRoutingRuleOutput() RoutingRuleOutput

func (RoutingRuleOutput) ToRoutingRuleOutputWithContext

func (o RoutingRuleOutput) ToRoutingRuleOutputWithContext(ctx context.Context) RoutingRuleOutput

type RuntimeDefaults

type RuntimeDefaults struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Hosts to add to the sandbox's default-deny network proxy when this agent runs in a sandbox. Each entry is a hostname with an optional ':port' suffix (e.g. 'api.example.com', 'registry.npmjs.org:443'). Unioned with the gateway and tool-install hosts the runner already opens automatically. Use this for hosts the auto-installer can't infer (custom MCP endpoints, third-party APIs, registries not covered by the aqua resolver) instead of relying on the wider fallback host set.
	NetworkAllowlist []string `pulumi:"networkAllowlist"`
	// Safety mode new sessions default to when the user has not chosen one (no --safety/--yolo flag, no alias option, no user-config setting). A per-agent 'safety' takes precedence over this config-wide default. A default only: it never overrides a user choice and never replaces the mode stored on a resumed session. 'restricted' is the fail-closed profile for unattended runs: safe calls auto-approve, every other unmatched call is denied without prompting. Trust warning: 'autonomous' auto-approves every tool call — review configs from URLs or OCI registries before running them.
	Safety *SafetyMode `pulumi:"safety"`
	// When true, run the agent inside a Docker sandbox by default — equivalent to passing --sandbox on the command line. An explicit --sandbox=false on the CLI still wins.
	Sandbox *bool `pulumi:"sandbox"`
}

Execution-time defaults baked into the agent config. Values act as defaults only; explicit CLI flags and user-config settings still take precedence.

type RuntimeDefaultsArgs

type RuntimeDefaultsArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Hosts to add to the sandbox's default-deny network proxy when this agent runs in a sandbox. Each entry is a hostname with an optional ':port' suffix (e.g. 'api.example.com', 'registry.npmjs.org:443'). Unioned with the gateway and tool-install hosts the runner already opens automatically. Use this for hosts the auto-installer can't infer (custom MCP endpoints, third-party APIs, registries not covered by the aqua resolver) instead of relying on the wider fallback host set.
	NetworkAllowlist pulumi.StringArrayInput `pulumi:"networkAllowlist"`
	// Safety mode new sessions default to when the user has not chosen one (no --safety/--yolo flag, no alias option, no user-config setting). A per-agent 'safety' takes precedence over this config-wide default. A default only: it never overrides a user choice and never replaces the mode stored on a resumed session. 'restricted' is the fail-closed profile for unattended runs: safe calls auto-approve, every other unmatched call is denied without prompting. Trust warning: 'autonomous' auto-approves every tool call — review configs from URLs or OCI registries before running them.
	Safety SafetyModePtrInput `pulumi:"safety"`
	// When true, run the agent inside a Docker sandbox by default — equivalent to passing --sandbox on the command line. An explicit --sandbox=false on the CLI still wins.
	Sandbox pulumi.BoolPtrInput `pulumi:"sandbox"`
}

Execution-time defaults baked into the agent config. Values act as defaults only; explicit CLI flags and user-config settings still take precedence.

func (RuntimeDefaultsArgs) ElementType

func (RuntimeDefaultsArgs) ElementType() reflect.Type

func (RuntimeDefaultsArgs) ToRuntimeDefaultsOutput

func (i RuntimeDefaultsArgs) ToRuntimeDefaultsOutput() RuntimeDefaultsOutput

func (RuntimeDefaultsArgs) ToRuntimeDefaultsOutputWithContext

func (i RuntimeDefaultsArgs) ToRuntimeDefaultsOutputWithContext(ctx context.Context) RuntimeDefaultsOutput

func (RuntimeDefaultsArgs) ToRuntimeDefaultsPtrOutput

func (i RuntimeDefaultsArgs) ToRuntimeDefaultsPtrOutput() RuntimeDefaultsPtrOutput

func (RuntimeDefaultsArgs) ToRuntimeDefaultsPtrOutputWithContext

func (i RuntimeDefaultsArgs) ToRuntimeDefaultsPtrOutputWithContext(ctx context.Context) RuntimeDefaultsPtrOutput

type RuntimeDefaultsInput

type RuntimeDefaultsInput interface {
	pulumi.Input

	ToRuntimeDefaultsOutput() RuntimeDefaultsOutput
	ToRuntimeDefaultsOutputWithContext(context.Context) RuntimeDefaultsOutput
}

RuntimeDefaultsInput is an input type that accepts RuntimeDefaultsArgs and RuntimeDefaultsOutput values. You can construct a concrete instance of `RuntimeDefaultsInput` via:

RuntimeDefaultsArgs{...}

type RuntimeDefaultsOutput

type RuntimeDefaultsOutput struct{ *pulumi.OutputState }

Execution-time defaults baked into the agent config. Values act as defaults only; explicit CLI flags and user-config settings still take precedence.

func (RuntimeDefaultsOutput) ElementType

func (RuntimeDefaultsOutput) ElementType() reflect.Type

func (RuntimeDefaultsOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RuntimeDefaultsOutput) NetworkAllowlist

func (o RuntimeDefaultsOutput) NetworkAllowlist() pulumi.StringArrayOutput

Hosts to add to the sandbox's default-deny network proxy when this agent runs in a sandbox. Each entry is a hostname with an optional ':port' suffix (e.g. 'api.example.com', 'registry.npmjs.org:443'). Unioned with the gateway and tool-install hosts the runner already opens automatically. Use this for hosts the auto-installer can't infer (custom MCP endpoints, third-party APIs, registries not covered by the aqua resolver) instead of relying on the wider fallback host set.

func (RuntimeDefaultsOutput) Safety

Safety mode new sessions default to when the user has not chosen one (no --safety/--yolo flag, no alias option, no user-config setting). A per-agent 'safety' takes precedence over this config-wide default. A default only: it never overrides a user choice and never replaces the mode stored on a resumed session. 'restricted' is the fail-closed profile for unattended runs: safe calls auto-approve, every other unmatched call is denied without prompting. Trust warning: 'autonomous' auto-approves every tool call — review configs from URLs or OCI registries before running them.

func (RuntimeDefaultsOutput) Sandbox

When true, run the agent inside a Docker sandbox by default — equivalent to passing --sandbox on the command line. An explicit --sandbox=false on the CLI still wins.

func (RuntimeDefaultsOutput) ToRuntimeDefaultsOutput

func (o RuntimeDefaultsOutput) ToRuntimeDefaultsOutput() RuntimeDefaultsOutput

func (RuntimeDefaultsOutput) ToRuntimeDefaultsOutputWithContext

func (o RuntimeDefaultsOutput) ToRuntimeDefaultsOutputWithContext(ctx context.Context) RuntimeDefaultsOutput

func (RuntimeDefaultsOutput) ToRuntimeDefaultsPtrOutput

func (o RuntimeDefaultsOutput) ToRuntimeDefaultsPtrOutput() RuntimeDefaultsPtrOutput

func (RuntimeDefaultsOutput) ToRuntimeDefaultsPtrOutputWithContext

func (o RuntimeDefaultsOutput) ToRuntimeDefaultsPtrOutputWithContext(ctx context.Context) RuntimeDefaultsPtrOutput

type RuntimeDefaultsPtrInput

type RuntimeDefaultsPtrInput interface {
	pulumi.Input

	ToRuntimeDefaultsPtrOutput() RuntimeDefaultsPtrOutput
	ToRuntimeDefaultsPtrOutputWithContext(context.Context) RuntimeDefaultsPtrOutput
}

RuntimeDefaultsPtrInput is an input type that accepts RuntimeDefaultsArgs, RuntimeDefaultsPtr and RuntimeDefaultsPtrOutput values. You can construct a concrete instance of `RuntimeDefaultsPtrInput` via:

        RuntimeDefaultsArgs{...}

or:

        nil

type RuntimeDefaultsPtrOutput

type RuntimeDefaultsPtrOutput struct{ *pulumi.OutputState }

func (RuntimeDefaultsPtrOutput) Elem

func (RuntimeDefaultsPtrOutput) ElementType

func (RuntimeDefaultsPtrOutput) ElementType() reflect.Type

func (RuntimeDefaultsPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (RuntimeDefaultsPtrOutput) NetworkAllowlist

func (o RuntimeDefaultsPtrOutput) NetworkAllowlist() pulumi.StringArrayOutput

Hosts to add to the sandbox's default-deny network proxy when this agent runs in a sandbox. Each entry is a hostname with an optional ':port' suffix (e.g. 'api.example.com', 'registry.npmjs.org:443'). Unioned with the gateway and tool-install hosts the runner already opens automatically. Use this for hosts the auto-installer can't infer (custom MCP endpoints, third-party APIs, registries not covered by the aqua resolver) instead of relying on the wider fallback host set.

func (RuntimeDefaultsPtrOutput) Safety

Safety mode new sessions default to when the user has not chosen one (no --safety/--yolo flag, no alias option, no user-config setting). A per-agent 'safety' takes precedence over this config-wide default. A default only: it never overrides a user choice and never replaces the mode stored on a resumed session. 'restricted' is the fail-closed profile for unattended runs: safe calls auto-approve, every other unmatched call is denied without prompting. Trust warning: 'autonomous' auto-approves every tool call — review configs from URLs or OCI registries before running them.

func (RuntimeDefaultsPtrOutput) Sandbox

When true, run the agent inside a Docker sandbox by default — equivalent to passing --sandbox on the command line. An explicit --sandbox=false on the CLI still wins.

func (RuntimeDefaultsPtrOutput) ToRuntimeDefaultsPtrOutput

func (o RuntimeDefaultsPtrOutput) ToRuntimeDefaultsPtrOutput() RuntimeDefaultsPtrOutput

func (RuntimeDefaultsPtrOutput) ToRuntimeDefaultsPtrOutputWithContext

func (o RuntimeDefaultsPtrOutput) ToRuntimeDefaultsPtrOutputWithContext(ctx context.Context) RuntimeDefaultsPtrOutput

type SafetyMode

type SafetyMode string

func (SafetyMode) ElementType

func (SafetyMode) ElementType() reflect.Type

func (SafetyMode) ToSafetyModeOutput

func (e SafetyMode) ToSafetyModeOutput() SafetyModeOutput

func (SafetyMode) ToSafetyModeOutputWithContext

func (e SafetyMode) ToSafetyModeOutputWithContext(ctx context.Context) SafetyModeOutput

func (SafetyMode) ToSafetyModePtrOutput

func (e SafetyMode) ToSafetyModePtrOutput() SafetyModePtrOutput

func (SafetyMode) ToSafetyModePtrOutputWithContext

func (e SafetyMode) ToSafetyModePtrOutputWithContext(ctx context.Context) SafetyModePtrOutput

func (SafetyMode) ToStringOutput

func (e SafetyMode) ToStringOutput() pulumi.StringOutput

func (SafetyMode) ToStringOutputWithContext

func (e SafetyMode) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (SafetyMode) ToStringPtrOutput

func (e SafetyMode) ToStringPtrOutput() pulumi.StringPtrOutput

func (SafetyMode) ToStringPtrOutputWithContext

func (e SafetyMode) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SafetyModeInput

type SafetyModeInput interface {
	pulumi.Input

	ToSafetyModeOutput() SafetyModeOutput
	ToSafetyModeOutputWithContext(context.Context) SafetyModeOutput
}

SafetyModeInput is an input type that accepts values of the SafetyMode enum A concrete instance of `SafetyModeInput` can be one of the following:

SafetyModeStrict
SafetyModeBalanced
SafetyModeRestricted
SafetyModeAutonomous

type SafetyModeOutput

type SafetyModeOutput struct{ *pulumi.OutputState }

func (SafetyModeOutput) ElementType

func (SafetyModeOutput) ElementType() reflect.Type

func (SafetyModeOutput) ToSafetyModeOutput

func (o SafetyModeOutput) ToSafetyModeOutput() SafetyModeOutput

func (SafetyModeOutput) ToSafetyModeOutputWithContext

func (o SafetyModeOutput) ToSafetyModeOutputWithContext(ctx context.Context) SafetyModeOutput

func (SafetyModeOutput) ToSafetyModePtrOutput

func (o SafetyModeOutput) ToSafetyModePtrOutput() SafetyModePtrOutput

func (SafetyModeOutput) ToSafetyModePtrOutputWithContext

func (o SafetyModeOutput) ToSafetyModePtrOutputWithContext(ctx context.Context) SafetyModePtrOutput

func (SafetyModeOutput) ToStringOutput

func (o SafetyModeOutput) ToStringOutput() pulumi.StringOutput

func (SafetyModeOutput) ToStringOutputWithContext

func (o SafetyModeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (SafetyModeOutput) ToStringPtrOutput

func (o SafetyModeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SafetyModeOutput) ToStringPtrOutputWithContext

func (o SafetyModeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SafetyModePtrInput

type SafetyModePtrInput interface {
	pulumi.Input

	ToSafetyModePtrOutput() SafetyModePtrOutput
	ToSafetyModePtrOutputWithContext(context.Context) SafetyModePtrOutput
}

func SafetyModePtr

func SafetyModePtr(v string) SafetyModePtrInput

type SafetyModePtrOutput

type SafetyModePtrOutput struct{ *pulumi.OutputState }

func (SafetyModePtrOutput) Elem

func (SafetyModePtrOutput) ElementType

func (SafetyModePtrOutput) ElementType() reflect.Type

func (SafetyModePtrOutput) ToSafetyModePtrOutput

func (o SafetyModePtrOutput) ToSafetyModePtrOutput() SafetyModePtrOutput

func (SafetyModePtrOutput) ToSafetyModePtrOutputWithContext

func (o SafetyModePtrOutput) ToSafetyModePtrOutputWithContext(ctx context.Context) SafetyModePtrOutput

func (SafetyModePtrOutput) ToStringPtrOutput

func (o SafetyModePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SafetyModePtrOutput) ToStringPtrOutputWithContext

func (o SafetyModePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ScriptShellTool

type ScriptShellTool struct {
	// Arguments schema (passed as properties in JSON schema)
	Args map[string]interface{} `pulumi:"args"`
	// Command to execute
	Cmd *string `pulumi:"cmd"`
	// Description of the shell tool
	Description *string `pulumi:"description"`
	// Environment variables for the command, layered over the toolset-level env. Values expand the plain ${env.VAR} form from the OS environment; any other $ is kept literal. Keys must not collide with args.
	Env map[string]string `pulumi:"env"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Required arguments
	Required []string `pulumi:"required"`
	// Working directory for the command. Accepts ~, $VAR, ${VAR} and ${env.VAR}.
	WorkingDir *string `pulumi:"workingDir"`
}

Configuration for custom shell tool

type ScriptShellToolArgs

type ScriptShellToolArgs struct {
	// Arguments schema (passed as properties in JSON schema)
	Args pulumi.MapInput `pulumi:"args"`
	// Command to execute
	Cmd pulumi.StringPtrInput `pulumi:"cmd"`
	// Description of the shell tool
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Environment variables for the command, layered over the toolset-level env. Values expand the plain ${env.VAR} form from the OS environment; any other $ is kept literal. Keys must not collide with args.
	Env pulumi.StringMapInput `pulumi:"env"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Required arguments
	Required pulumi.StringArrayInput `pulumi:"required"`
	// Working directory for the command. Accepts ~, $VAR, ${VAR} and ${env.VAR}.
	WorkingDir pulumi.StringPtrInput `pulumi:"workingDir"`
}

Configuration for custom shell tool

func (ScriptShellToolArgs) ElementType

func (ScriptShellToolArgs) ElementType() reflect.Type

func (ScriptShellToolArgs) ToScriptShellToolOutput

func (i ScriptShellToolArgs) ToScriptShellToolOutput() ScriptShellToolOutput

func (ScriptShellToolArgs) ToScriptShellToolOutputWithContext

func (i ScriptShellToolArgs) ToScriptShellToolOutputWithContext(ctx context.Context) ScriptShellToolOutput

type ScriptShellToolInput

type ScriptShellToolInput interface {
	pulumi.Input

	ToScriptShellToolOutput() ScriptShellToolOutput
	ToScriptShellToolOutputWithContext(context.Context) ScriptShellToolOutput
}

ScriptShellToolInput is an input type that accepts ScriptShellToolArgs and ScriptShellToolOutput values. You can construct a concrete instance of `ScriptShellToolInput` via:

ScriptShellToolArgs{...}

type ScriptShellToolMap

type ScriptShellToolMap map[string]ScriptShellToolInput

func (ScriptShellToolMap) ElementType

func (ScriptShellToolMap) ElementType() reflect.Type

func (ScriptShellToolMap) ToScriptShellToolMapOutput

func (i ScriptShellToolMap) ToScriptShellToolMapOutput() ScriptShellToolMapOutput

func (ScriptShellToolMap) ToScriptShellToolMapOutputWithContext

func (i ScriptShellToolMap) ToScriptShellToolMapOutputWithContext(ctx context.Context) ScriptShellToolMapOutput

type ScriptShellToolMapInput

type ScriptShellToolMapInput interface {
	pulumi.Input

	ToScriptShellToolMapOutput() ScriptShellToolMapOutput
	ToScriptShellToolMapOutputWithContext(context.Context) ScriptShellToolMapOutput
}

ScriptShellToolMapInput is an input type that accepts ScriptShellToolMap and ScriptShellToolMapOutput values. You can construct a concrete instance of `ScriptShellToolMapInput` via:

ScriptShellToolMap{ "key": ScriptShellToolArgs{...} }

type ScriptShellToolMapOutput

type ScriptShellToolMapOutput struct{ *pulumi.OutputState }

func (ScriptShellToolMapOutput) ElementType

func (ScriptShellToolMapOutput) ElementType() reflect.Type

func (ScriptShellToolMapOutput) MapIndex

func (ScriptShellToolMapOutput) ToScriptShellToolMapOutput

func (o ScriptShellToolMapOutput) ToScriptShellToolMapOutput() ScriptShellToolMapOutput

func (ScriptShellToolMapOutput) ToScriptShellToolMapOutputWithContext

func (o ScriptShellToolMapOutput) ToScriptShellToolMapOutputWithContext(ctx context.Context) ScriptShellToolMapOutput

type ScriptShellToolOutput

type ScriptShellToolOutput struct{ *pulumi.OutputState }

Configuration for custom shell tool

func (ScriptShellToolOutput) Args

Arguments schema (passed as properties in JSON schema)

func (ScriptShellToolOutput) Cmd

Command to execute

func (ScriptShellToolOutput) Description

Description of the shell tool

func (ScriptShellToolOutput) ElementType

func (ScriptShellToolOutput) ElementType() reflect.Type

func (ScriptShellToolOutput) Env

Environment variables for the command, layered over the toolset-level env. Values expand the plain ${env.VAR} form from the OS environment; any other $ is kept literal. Keys must not collide with args.

func (ScriptShellToolOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ScriptShellToolOutput) Required

Required arguments

func (ScriptShellToolOutput) ToScriptShellToolOutput

func (o ScriptShellToolOutput) ToScriptShellToolOutput() ScriptShellToolOutput

func (ScriptShellToolOutput) ToScriptShellToolOutputWithContext

func (o ScriptShellToolOutput) ToScriptShellToolOutputWithContext(ctx context.Context) ScriptShellToolOutput

func (ScriptShellToolOutput) WorkingDir

Working directory for the command. Accepts ~, $VAR, ${VAR} and ${env.VAR}.

type SectionSpacing

type SectionSpacing string

func (SectionSpacing) ElementType

func (SectionSpacing) ElementType() reflect.Type

func (SectionSpacing) ToSectionSpacingOutput

func (e SectionSpacing) ToSectionSpacingOutput() SectionSpacingOutput

func (SectionSpacing) ToSectionSpacingOutputWithContext

func (e SectionSpacing) ToSectionSpacingOutputWithContext(ctx context.Context) SectionSpacingOutput

func (SectionSpacing) ToSectionSpacingPtrOutput

func (e SectionSpacing) ToSectionSpacingPtrOutput() SectionSpacingPtrOutput

func (SectionSpacing) ToSectionSpacingPtrOutputWithContext

func (e SectionSpacing) ToSectionSpacingPtrOutputWithContext(ctx context.Context) SectionSpacingPtrOutput

func (SectionSpacing) ToStringOutput

func (e SectionSpacing) ToStringOutput() pulumi.StringOutput

func (SectionSpacing) ToStringOutputWithContext

func (e SectionSpacing) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (SectionSpacing) ToStringPtrOutput

func (e SectionSpacing) ToStringPtrOutput() pulumi.StringPtrOutput

func (SectionSpacing) ToStringPtrOutputWithContext

func (e SectionSpacing) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SectionSpacingInput

type SectionSpacingInput interface {
	pulumi.Input

	ToSectionSpacingOutput() SectionSpacingOutput
	ToSectionSpacingOutputWithContext(context.Context) SectionSpacingOutput
}

SectionSpacingInput is an input type that accepts values of the SectionSpacing enum A concrete instance of `SectionSpacingInput` can be one of the following:

SectionSpacingNormal
SectionSpacingCompact
SectionSpacingRelaxed

type SectionSpacingOutput

type SectionSpacingOutput struct{ *pulumi.OutputState }

func (SectionSpacingOutput) ElementType

func (SectionSpacingOutput) ElementType() reflect.Type

func (SectionSpacingOutput) ToSectionSpacingOutput

func (o SectionSpacingOutput) ToSectionSpacingOutput() SectionSpacingOutput

func (SectionSpacingOutput) ToSectionSpacingOutputWithContext

func (o SectionSpacingOutput) ToSectionSpacingOutputWithContext(ctx context.Context) SectionSpacingOutput

func (SectionSpacingOutput) ToSectionSpacingPtrOutput

func (o SectionSpacingOutput) ToSectionSpacingPtrOutput() SectionSpacingPtrOutput

func (SectionSpacingOutput) ToSectionSpacingPtrOutputWithContext

func (o SectionSpacingOutput) ToSectionSpacingPtrOutputWithContext(ctx context.Context) SectionSpacingPtrOutput

func (SectionSpacingOutput) ToStringOutput

func (o SectionSpacingOutput) ToStringOutput() pulumi.StringOutput

func (SectionSpacingOutput) ToStringOutputWithContext

func (o SectionSpacingOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (SectionSpacingOutput) ToStringPtrOutput

func (o SectionSpacingOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SectionSpacingOutput) ToStringPtrOutputWithContext

func (o SectionSpacingOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SectionSpacingPtrInput

type SectionSpacingPtrInput interface {
	pulumi.Input

	ToSectionSpacingPtrOutput() SectionSpacingPtrOutput
	ToSectionSpacingPtrOutputWithContext(context.Context) SectionSpacingPtrOutput
}

func SectionSpacingPtr

func SectionSpacingPtr(v string) SectionSpacingPtrInput

type SectionSpacingPtrOutput

type SectionSpacingPtrOutput struct{ *pulumi.OutputState }

func (SectionSpacingPtrOutput) Elem

func (SectionSpacingPtrOutput) ElementType

func (SectionSpacingPtrOutput) ElementType() reflect.Type

func (SectionSpacingPtrOutput) ToSectionSpacingPtrOutput

func (o SectionSpacingPtrOutput) ToSectionSpacingPtrOutput() SectionSpacingPtrOutput

func (SectionSpacingPtrOutput) ToSectionSpacingPtrOutputWithContext

func (o SectionSpacingPtrOutput) ToSectionSpacingPtrOutputWithContext(ctx context.Context) SectionSpacingPtrOutput

func (SectionSpacingPtrOutput) ToStringPtrOutput

func (o SectionSpacingPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SectionSpacingPtrOutput) ToStringPtrOutputWithContext

func (o SectionSpacingPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SidebarInfoMode

type SidebarInfoMode string

func (SidebarInfoMode) ElementType

func (SidebarInfoMode) ElementType() reflect.Type

func (SidebarInfoMode) ToSidebarInfoModeOutput

func (e SidebarInfoMode) ToSidebarInfoModeOutput() SidebarInfoModeOutput

func (SidebarInfoMode) ToSidebarInfoModeOutputWithContext

func (e SidebarInfoMode) ToSidebarInfoModeOutputWithContext(ctx context.Context) SidebarInfoModeOutput

func (SidebarInfoMode) ToSidebarInfoModePtrOutput

func (e SidebarInfoMode) ToSidebarInfoModePtrOutput() SidebarInfoModePtrOutput

func (SidebarInfoMode) ToSidebarInfoModePtrOutputWithContext

func (e SidebarInfoMode) ToSidebarInfoModePtrOutputWithContext(ctx context.Context) SidebarInfoModePtrOutput

func (SidebarInfoMode) ToStringOutput

func (e SidebarInfoMode) ToStringOutput() pulumi.StringOutput

func (SidebarInfoMode) ToStringOutputWithContext

func (e SidebarInfoMode) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (SidebarInfoMode) ToStringPtrOutput

func (e SidebarInfoMode) ToStringPtrOutput() pulumi.StringPtrOutput

func (SidebarInfoMode) ToStringPtrOutputWithContext

func (e SidebarInfoMode) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SidebarInfoModeInput

type SidebarInfoModeInput interface {
	pulumi.Input

	ToSidebarInfoModeOutput() SidebarInfoModeOutput
	ToSidebarInfoModeOutputWithContext(context.Context) SidebarInfoModeOutput
}

SidebarInfoModeInput is an input type that accepts values of the SidebarInfoMode enum A concrete instance of `SidebarInfoModeInput` can be one of the following:

SidebarInfoModeCompact
SidebarInfoModeDetailed

type SidebarInfoModeOutput

type SidebarInfoModeOutput struct{ *pulumi.OutputState }

func (SidebarInfoModeOutput) ElementType

func (SidebarInfoModeOutput) ElementType() reflect.Type

func (SidebarInfoModeOutput) ToSidebarInfoModeOutput

func (o SidebarInfoModeOutput) ToSidebarInfoModeOutput() SidebarInfoModeOutput

func (SidebarInfoModeOutput) ToSidebarInfoModeOutputWithContext

func (o SidebarInfoModeOutput) ToSidebarInfoModeOutputWithContext(ctx context.Context) SidebarInfoModeOutput

func (SidebarInfoModeOutput) ToSidebarInfoModePtrOutput

func (o SidebarInfoModeOutput) ToSidebarInfoModePtrOutput() SidebarInfoModePtrOutput

func (SidebarInfoModeOutput) ToSidebarInfoModePtrOutputWithContext

func (o SidebarInfoModeOutput) ToSidebarInfoModePtrOutputWithContext(ctx context.Context) SidebarInfoModePtrOutput

func (SidebarInfoModeOutput) ToStringOutput

func (o SidebarInfoModeOutput) ToStringOutput() pulumi.StringOutput

func (SidebarInfoModeOutput) ToStringOutputWithContext

func (o SidebarInfoModeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (SidebarInfoModeOutput) ToStringPtrOutput

func (o SidebarInfoModeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SidebarInfoModeOutput) ToStringPtrOutputWithContext

func (o SidebarInfoModeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SidebarInfoModePtrInput

type SidebarInfoModePtrInput interface {
	pulumi.Input

	ToSidebarInfoModePtrOutput() SidebarInfoModePtrOutput
	ToSidebarInfoModePtrOutputWithContext(context.Context) SidebarInfoModePtrOutput
}

func SidebarInfoModePtr

func SidebarInfoModePtr(v string) SidebarInfoModePtrInput

type SidebarInfoModePtrOutput

type SidebarInfoModePtrOutput struct{ *pulumi.OutputState }

func (SidebarInfoModePtrOutput) Elem

func (SidebarInfoModePtrOutput) ElementType

func (SidebarInfoModePtrOutput) ElementType() reflect.Type

func (SidebarInfoModePtrOutput) ToSidebarInfoModePtrOutput

func (o SidebarInfoModePtrOutput) ToSidebarInfoModePtrOutput() SidebarInfoModePtrOutput

func (SidebarInfoModePtrOutput) ToSidebarInfoModePtrOutputWithContext

func (o SidebarInfoModePtrOutput) ToSidebarInfoModePtrOutputWithContext(ctx context.Context) SidebarInfoModePtrOutput

func (SidebarInfoModePtrOutput) ToStringPtrOutput

func (o SidebarInfoModePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SidebarInfoModePtrOutput) ToStringPtrOutputWithContext

func (o SidebarInfoModePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SidebarPosition

type SidebarPosition string

func (SidebarPosition) ElementType

func (SidebarPosition) ElementType() reflect.Type

func (SidebarPosition) ToSidebarPositionOutput

func (e SidebarPosition) ToSidebarPositionOutput() SidebarPositionOutput

func (SidebarPosition) ToSidebarPositionOutputWithContext

func (e SidebarPosition) ToSidebarPositionOutputWithContext(ctx context.Context) SidebarPositionOutput

func (SidebarPosition) ToSidebarPositionPtrOutput

func (e SidebarPosition) ToSidebarPositionPtrOutput() SidebarPositionPtrOutput

func (SidebarPosition) ToSidebarPositionPtrOutputWithContext

func (e SidebarPosition) ToSidebarPositionPtrOutputWithContext(ctx context.Context) SidebarPositionPtrOutput

func (SidebarPosition) ToStringOutput

func (e SidebarPosition) ToStringOutput() pulumi.StringOutput

func (SidebarPosition) ToStringOutputWithContext

func (e SidebarPosition) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (SidebarPosition) ToStringPtrOutput

func (e SidebarPosition) ToStringPtrOutput() pulumi.StringPtrOutput

func (SidebarPosition) ToStringPtrOutputWithContext

func (e SidebarPosition) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SidebarPositionInput

type SidebarPositionInput interface {
	pulumi.Input

	ToSidebarPositionOutput() SidebarPositionOutput
	ToSidebarPositionOutputWithContext(context.Context) SidebarPositionOutput
}

SidebarPositionInput is an input type that accepts values of the SidebarPosition enum A concrete instance of `SidebarPositionInput` can be one of the following:

SidebarPositionRight
SidebarPositionLeft
SidebarPositionTop
SidebarPositionBottom

type SidebarPositionOutput

type SidebarPositionOutput struct{ *pulumi.OutputState }

func (SidebarPositionOutput) ElementType

func (SidebarPositionOutput) ElementType() reflect.Type

func (SidebarPositionOutput) ToSidebarPositionOutput

func (o SidebarPositionOutput) ToSidebarPositionOutput() SidebarPositionOutput

func (SidebarPositionOutput) ToSidebarPositionOutputWithContext

func (o SidebarPositionOutput) ToSidebarPositionOutputWithContext(ctx context.Context) SidebarPositionOutput

func (SidebarPositionOutput) ToSidebarPositionPtrOutput

func (o SidebarPositionOutput) ToSidebarPositionPtrOutput() SidebarPositionPtrOutput

func (SidebarPositionOutput) ToSidebarPositionPtrOutputWithContext

func (o SidebarPositionOutput) ToSidebarPositionPtrOutputWithContext(ctx context.Context) SidebarPositionPtrOutput

func (SidebarPositionOutput) ToStringOutput

func (o SidebarPositionOutput) ToStringOutput() pulumi.StringOutput

func (SidebarPositionOutput) ToStringOutputWithContext

func (o SidebarPositionOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (SidebarPositionOutput) ToStringPtrOutput

func (o SidebarPositionOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SidebarPositionOutput) ToStringPtrOutputWithContext

func (o SidebarPositionOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SidebarPositionPtrInput

type SidebarPositionPtrInput interface {
	pulumi.Input

	ToSidebarPositionPtrOutput() SidebarPositionPtrOutput
	ToSidebarPositionPtrOutputWithContext(context.Context) SidebarPositionPtrOutput
}

func SidebarPositionPtr

func SidebarPositionPtr(v string) SidebarPositionPtrInput

type SidebarPositionPtrOutput

type SidebarPositionPtrOutput struct{ *pulumi.OutputState }

func (SidebarPositionPtrOutput) Elem

func (SidebarPositionPtrOutput) ElementType

func (SidebarPositionPtrOutput) ElementType() reflect.Type

func (SidebarPositionPtrOutput) ToSidebarPositionPtrOutput

func (o SidebarPositionPtrOutput) ToSidebarPositionPtrOutput() SidebarPositionPtrOutput

func (SidebarPositionPtrOutput) ToSidebarPositionPtrOutputWithContext

func (o SidebarPositionPtrOutput) ToSidebarPositionPtrOutputWithContext(ctx context.Context) SidebarPositionPtrOutput

func (SidebarPositionPtrOutput) ToStringPtrOutput

func (o SidebarPositionPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (SidebarPositionPtrOutput) ToStringPtrOutputWithContext

func (o SidebarPositionPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type SkillSet

type SkillSet struct {
	// Skills defined inline. Rendered after the entries of `skills`.
	InlineSkills []InlineSkill `pulumi:"inlineSkills"`
	// Skill sources and names: `local`, HTTP/HTTPS URLs or names of skills to include. `["local"]` is the same as `true`.
	Skills []string `pulumi:"skills"`
}

A named group of skills (a value of the top-level `skills` map), merged into the agents that list the group in `useSkills`. Set `skills` and/or `inlineSkills`; they are rendered together into one value.

type SkillSetArgs

type SkillSetArgs struct {
	// Skills defined inline. Rendered after the entries of `skills`.
	InlineSkills InlineSkillArrayInput `pulumi:"inlineSkills"`
	// Skill sources and names: `local`, HTTP/HTTPS URLs or names of skills to include. `["local"]` is the same as `true`.
	Skills pulumi.StringArrayInput `pulumi:"skills"`
}

A named group of skills (a value of the top-level `skills` map), merged into the agents that list the group in `useSkills`. Set `skills` and/or `inlineSkills`; they are rendered together into one value.

func (SkillSetArgs) ElementType

func (SkillSetArgs) ElementType() reflect.Type

func (SkillSetArgs) ToSkillSetOutput

func (i SkillSetArgs) ToSkillSetOutput() SkillSetOutput

func (SkillSetArgs) ToSkillSetOutputWithContext

func (i SkillSetArgs) ToSkillSetOutputWithContext(ctx context.Context) SkillSetOutput

type SkillSetInput

type SkillSetInput interface {
	pulumi.Input

	ToSkillSetOutput() SkillSetOutput
	ToSkillSetOutputWithContext(context.Context) SkillSetOutput
}

SkillSetInput is an input type that accepts SkillSetArgs and SkillSetOutput values. You can construct a concrete instance of `SkillSetInput` via:

SkillSetArgs{...}

type SkillSetMap

type SkillSetMap map[string]SkillSetInput

func (SkillSetMap) ElementType

func (SkillSetMap) ElementType() reflect.Type

func (SkillSetMap) ToSkillSetMapOutput

func (i SkillSetMap) ToSkillSetMapOutput() SkillSetMapOutput

func (SkillSetMap) ToSkillSetMapOutputWithContext

func (i SkillSetMap) ToSkillSetMapOutputWithContext(ctx context.Context) SkillSetMapOutput

type SkillSetMapInput

type SkillSetMapInput interface {
	pulumi.Input

	ToSkillSetMapOutput() SkillSetMapOutput
	ToSkillSetMapOutputWithContext(context.Context) SkillSetMapOutput
}

SkillSetMapInput is an input type that accepts SkillSetMap and SkillSetMapOutput values. You can construct a concrete instance of `SkillSetMapInput` via:

SkillSetMap{ "key": SkillSetArgs{...} }

type SkillSetMapOutput

type SkillSetMapOutput struct{ *pulumi.OutputState }

func (SkillSetMapOutput) ElementType

func (SkillSetMapOutput) ElementType() reflect.Type

func (SkillSetMapOutput) MapIndex

func (SkillSetMapOutput) ToSkillSetMapOutput

func (o SkillSetMapOutput) ToSkillSetMapOutput() SkillSetMapOutput

func (SkillSetMapOutput) ToSkillSetMapOutputWithContext

func (o SkillSetMapOutput) ToSkillSetMapOutputWithContext(ctx context.Context) SkillSetMapOutput

type SkillSetOutput

type SkillSetOutput struct{ *pulumi.OutputState }

A named group of skills (a value of the top-level `skills` map), merged into the agents that list the group in `useSkills`. Set `skills` and/or `inlineSkills`; they are rendered together into one value.

func (SkillSetOutput) ElementType

func (SkillSetOutput) ElementType() reflect.Type

func (SkillSetOutput) InlineSkills

func (o SkillSetOutput) InlineSkills() InlineSkillArrayOutput

Skills defined inline. Rendered after the entries of `skills`.

func (SkillSetOutput) Skills

Skill sources and names: `local`, HTTP/HTTPS URLs or names of skills to include. `["local"]` is the same as `true`.

func (SkillSetOutput) ToSkillSetOutput

func (o SkillSetOutput) ToSkillSetOutput() SkillSetOutput

func (SkillSetOutput) ToSkillSetOutputWithContext

func (o SkillSetOutput) ToSkillSetOutputWithContext(ctx context.Context) SkillSetOutput

type StructuredOutput

type StructuredOutput struct {
	// Optional description of what the schema represents
	Description *string `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// How the schema is enforced. 'native' (default) passes it to the provider's native structured-output support. 'tool' exposes an internal tool the model must call with the final JSON; the runtime validates the arguments against the schema. Works with any tool-calling provider.
	Mode *StructuredOutputMode `pulumi:"mode"`
	// Name of the response format schema
	Name string `pulumi:"name"`
	// JSON Schema object defining the structure of the response. Must include type, properties, and required fields.
	Schema map[string]interface{} `pulumi:"schema"`
	// Enable strict schema adherence (OpenAI only). When true, all properties must be in required array. Defaults to `false`.
	Strict *bool `pulumi:"strict"`
}

Structured output configuration for constraining model responses to a specific JSON schema. Supported by OpenAI (native) and Google Gemini (native). Anthropic requires prompt engineering or tool-based approaches.

type StructuredOutputArgs

type StructuredOutputArgs struct {
	// Optional description of what the schema represents
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// How the schema is enforced. 'native' (default) passes it to the provider's native structured-output support. 'tool' exposes an internal tool the model must call with the final JSON; the runtime validates the arguments against the schema. Works with any tool-calling provider.
	Mode StructuredOutputModePtrInput `pulumi:"mode"`
	// Name of the response format schema
	Name pulumi.StringInput `pulumi:"name"`
	// JSON Schema object defining the structure of the response. Must include type, properties, and required fields.
	Schema pulumi.MapInput `pulumi:"schema"`
	// Enable strict schema adherence (OpenAI only). When true, all properties must be in required array. Defaults to `false`.
	Strict pulumi.BoolPtrInput `pulumi:"strict"`
}

Structured output configuration for constraining model responses to a specific JSON schema. Supported by OpenAI (native) and Google Gemini (native). Anthropic requires prompt engineering or tool-based approaches.

func (StructuredOutputArgs) ElementType

func (StructuredOutputArgs) ElementType() reflect.Type

func (StructuredOutputArgs) ToStructuredOutputOutput

func (i StructuredOutputArgs) ToStructuredOutputOutput() StructuredOutputOutput

func (StructuredOutputArgs) ToStructuredOutputOutputWithContext

func (i StructuredOutputArgs) ToStructuredOutputOutputWithContext(ctx context.Context) StructuredOutputOutput

func (StructuredOutputArgs) ToStructuredOutputPtrOutput

func (i StructuredOutputArgs) ToStructuredOutputPtrOutput() StructuredOutputPtrOutput

func (StructuredOutputArgs) ToStructuredOutputPtrOutputWithContext

func (i StructuredOutputArgs) ToStructuredOutputPtrOutputWithContext(ctx context.Context) StructuredOutputPtrOutput

type StructuredOutputInput

type StructuredOutputInput interface {
	pulumi.Input

	ToStructuredOutputOutput() StructuredOutputOutput
	ToStructuredOutputOutputWithContext(context.Context) StructuredOutputOutput
}

StructuredOutputInput is an input type that accepts StructuredOutputArgs and StructuredOutputOutput values. You can construct a concrete instance of `StructuredOutputInput` via:

StructuredOutputArgs{...}

type StructuredOutputMode

type StructuredOutputMode string

func (StructuredOutputMode) ElementType

func (StructuredOutputMode) ElementType() reflect.Type

func (StructuredOutputMode) ToStringOutput

func (e StructuredOutputMode) ToStringOutput() pulumi.StringOutput

func (StructuredOutputMode) ToStringOutputWithContext

func (e StructuredOutputMode) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (StructuredOutputMode) ToStringPtrOutput

func (e StructuredOutputMode) ToStringPtrOutput() pulumi.StringPtrOutput

func (StructuredOutputMode) ToStringPtrOutputWithContext

func (e StructuredOutputMode) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (StructuredOutputMode) ToStructuredOutputModeOutput

func (e StructuredOutputMode) ToStructuredOutputModeOutput() StructuredOutputModeOutput

func (StructuredOutputMode) ToStructuredOutputModeOutputWithContext

func (e StructuredOutputMode) ToStructuredOutputModeOutputWithContext(ctx context.Context) StructuredOutputModeOutput

func (StructuredOutputMode) ToStructuredOutputModePtrOutput

func (e StructuredOutputMode) ToStructuredOutputModePtrOutput() StructuredOutputModePtrOutput

func (StructuredOutputMode) ToStructuredOutputModePtrOutputWithContext

func (e StructuredOutputMode) ToStructuredOutputModePtrOutputWithContext(ctx context.Context) StructuredOutputModePtrOutput

type StructuredOutputModeInput

type StructuredOutputModeInput interface {
	pulumi.Input

	ToStructuredOutputModeOutput() StructuredOutputModeOutput
	ToStructuredOutputModeOutputWithContext(context.Context) StructuredOutputModeOutput
}

StructuredOutputModeInput is an input type that accepts values of the StructuredOutputMode enum A concrete instance of `StructuredOutputModeInput` can be one of the following:

StructuredOutputModeNative
StructuredOutputModeTool

type StructuredOutputModeOutput

type StructuredOutputModeOutput struct{ *pulumi.OutputState }

func (StructuredOutputModeOutput) ElementType

func (StructuredOutputModeOutput) ElementType() reflect.Type

func (StructuredOutputModeOutput) ToStringOutput

func (o StructuredOutputModeOutput) ToStringOutput() pulumi.StringOutput

func (StructuredOutputModeOutput) ToStringOutputWithContext

func (o StructuredOutputModeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (StructuredOutputModeOutput) ToStringPtrOutput

func (o StructuredOutputModeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (StructuredOutputModeOutput) ToStringPtrOutputWithContext

func (o StructuredOutputModeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (StructuredOutputModeOutput) ToStructuredOutputModeOutput

func (o StructuredOutputModeOutput) ToStructuredOutputModeOutput() StructuredOutputModeOutput

func (StructuredOutputModeOutput) ToStructuredOutputModeOutputWithContext

func (o StructuredOutputModeOutput) ToStructuredOutputModeOutputWithContext(ctx context.Context) StructuredOutputModeOutput

func (StructuredOutputModeOutput) ToStructuredOutputModePtrOutput

func (o StructuredOutputModeOutput) ToStructuredOutputModePtrOutput() StructuredOutputModePtrOutput

func (StructuredOutputModeOutput) ToStructuredOutputModePtrOutputWithContext

func (o StructuredOutputModeOutput) ToStructuredOutputModePtrOutputWithContext(ctx context.Context) StructuredOutputModePtrOutput

type StructuredOutputModePtrInput

type StructuredOutputModePtrInput interface {
	pulumi.Input

	ToStructuredOutputModePtrOutput() StructuredOutputModePtrOutput
	ToStructuredOutputModePtrOutputWithContext(context.Context) StructuredOutputModePtrOutput
}

func StructuredOutputModePtr

func StructuredOutputModePtr(v string) StructuredOutputModePtrInput

type StructuredOutputModePtrOutput

type StructuredOutputModePtrOutput struct{ *pulumi.OutputState }

func (StructuredOutputModePtrOutput) Elem

func (StructuredOutputModePtrOutput) ElementType

func (StructuredOutputModePtrOutput) ToStringPtrOutput

func (StructuredOutputModePtrOutput) ToStringPtrOutputWithContext

func (o StructuredOutputModePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (StructuredOutputModePtrOutput) ToStructuredOutputModePtrOutput

func (o StructuredOutputModePtrOutput) ToStructuredOutputModePtrOutput() StructuredOutputModePtrOutput

func (StructuredOutputModePtrOutput) ToStructuredOutputModePtrOutputWithContext

func (o StructuredOutputModePtrOutput) ToStructuredOutputModePtrOutputWithContext(ctx context.Context) StructuredOutputModePtrOutput

type StructuredOutputOutput

type StructuredOutputOutput struct{ *pulumi.OutputState }

Structured output configuration for constraining model responses to a specific JSON schema. Supported by OpenAI (native) and Google Gemini (native). Anthropic requires prompt engineering or tool-based approaches.

func (StructuredOutputOutput) Description

Optional description of what the schema represents

func (StructuredOutputOutput) ElementType

func (StructuredOutputOutput) ElementType() reflect.Type

func (StructuredOutputOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (StructuredOutputOutput) Mode

How the schema is enforced. 'native' (default) passes it to the provider's native structured-output support. 'tool' exposes an internal tool the model must call with the final JSON; the runtime validates the arguments against the schema. Works with any tool-calling provider.

func (StructuredOutputOutput) Name

Name of the response format schema

func (StructuredOutputOutput) Schema

JSON Schema object defining the structure of the response. Must include type, properties, and required fields.

func (StructuredOutputOutput) Strict

Enable strict schema adherence (OpenAI only). When true, all properties must be in required array. Defaults to `false`.

func (StructuredOutputOutput) ToStructuredOutputOutput

func (o StructuredOutputOutput) ToStructuredOutputOutput() StructuredOutputOutput

func (StructuredOutputOutput) ToStructuredOutputOutputWithContext

func (o StructuredOutputOutput) ToStructuredOutputOutputWithContext(ctx context.Context) StructuredOutputOutput

func (StructuredOutputOutput) ToStructuredOutputPtrOutput

func (o StructuredOutputOutput) ToStructuredOutputPtrOutput() StructuredOutputPtrOutput

func (StructuredOutputOutput) ToStructuredOutputPtrOutputWithContext

func (o StructuredOutputOutput) ToStructuredOutputPtrOutputWithContext(ctx context.Context) StructuredOutputPtrOutput

type StructuredOutputPtrInput

type StructuredOutputPtrInput interface {
	pulumi.Input

	ToStructuredOutputPtrOutput() StructuredOutputPtrOutput
	ToStructuredOutputPtrOutputWithContext(context.Context) StructuredOutputPtrOutput
}

StructuredOutputPtrInput is an input type that accepts StructuredOutputArgs, StructuredOutputPtr and StructuredOutputPtrOutput values. You can construct a concrete instance of `StructuredOutputPtrInput` via:

        StructuredOutputArgs{...}

or:

        nil

type StructuredOutputPtrOutput

type StructuredOutputPtrOutput struct{ *pulumi.OutputState }

func (StructuredOutputPtrOutput) Description

Optional description of what the schema represents

func (StructuredOutputPtrOutput) Elem

func (StructuredOutputPtrOutput) ElementType

func (StructuredOutputPtrOutput) ElementType() reflect.Type

func (StructuredOutputPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (StructuredOutputPtrOutput) Mode

How the schema is enforced. 'native' (default) passes it to the provider's native structured-output support. 'tool' exposes an internal tool the model must call with the final JSON; the runtime validates the arguments against the schema. Works with any tool-calling provider.

func (StructuredOutputPtrOutput) Name

Name of the response format schema

func (StructuredOutputPtrOutput) Schema

JSON Schema object defining the structure of the response. Must include type, properties, and required fields.

func (StructuredOutputPtrOutput) Strict

Enable strict schema adherence (OpenAI only). When true, all properties must be in required array. Defaults to `false`.

func (StructuredOutputPtrOutput) ToStructuredOutputPtrOutput

func (o StructuredOutputPtrOutput) ToStructuredOutputPtrOutput() StructuredOutputPtrOutput

func (StructuredOutputPtrOutput) ToStructuredOutputPtrOutputWithContext

func (o StructuredOutputPtrOutput) ToStructuredOutputPtrOutputWithContext(ctx context.Context) StructuredOutputPtrOutput

type ToolApproval

type ToolApproval string

func (ToolApproval) ElementType

func (ToolApproval) ElementType() reflect.Type

func (ToolApproval) ToStringOutput

func (e ToolApproval) ToStringOutput() pulumi.StringOutput

func (ToolApproval) ToStringOutputWithContext

func (e ToolApproval) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (ToolApproval) ToStringPtrOutput

func (e ToolApproval) ToStringPtrOutput() pulumi.StringPtrOutput

func (ToolApproval) ToStringPtrOutputWithContext

func (e ToolApproval) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (ToolApproval) ToToolApprovalOutput

func (e ToolApproval) ToToolApprovalOutput() ToolApprovalOutput

func (ToolApproval) ToToolApprovalOutputWithContext

func (e ToolApproval) ToToolApprovalOutputWithContext(ctx context.Context) ToolApprovalOutput

func (ToolApproval) ToToolApprovalPtrOutput

func (e ToolApproval) ToToolApprovalPtrOutput() ToolApprovalPtrOutput

func (ToolApproval) ToToolApprovalPtrOutputWithContext

func (e ToolApproval) ToToolApprovalPtrOutputWithContext(ctx context.Context) ToolApprovalPtrOutput

type ToolApprovalInput

type ToolApprovalInput interface {
	pulumi.Input

	ToToolApprovalOutput() ToolApprovalOutput
	ToToolApprovalOutputWithContext(context.Context) ToolApprovalOutput
}

ToolApprovalInput is an input type that accepts values of the ToolApproval enum A concrete instance of `ToolApprovalInput` can be one of the following:

ToolApprovalDeny
ToolApprovalAllow

type ToolApprovalOutput

type ToolApprovalOutput struct{ *pulumi.OutputState }

func (ToolApprovalOutput) ElementType

func (ToolApprovalOutput) ElementType() reflect.Type

func (ToolApprovalOutput) ToStringOutput

func (o ToolApprovalOutput) ToStringOutput() pulumi.StringOutput

func (ToolApprovalOutput) ToStringOutputWithContext

func (o ToolApprovalOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (ToolApprovalOutput) ToStringPtrOutput

func (o ToolApprovalOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (ToolApprovalOutput) ToStringPtrOutputWithContext

func (o ToolApprovalOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (ToolApprovalOutput) ToToolApprovalOutput

func (o ToolApprovalOutput) ToToolApprovalOutput() ToolApprovalOutput

func (ToolApprovalOutput) ToToolApprovalOutputWithContext

func (o ToolApprovalOutput) ToToolApprovalOutputWithContext(ctx context.Context) ToolApprovalOutput

func (ToolApprovalOutput) ToToolApprovalPtrOutput

func (o ToolApprovalOutput) ToToolApprovalPtrOutput() ToolApprovalPtrOutput

func (ToolApprovalOutput) ToToolApprovalPtrOutputWithContext

func (o ToolApprovalOutput) ToToolApprovalPtrOutputWithContext(ctx context.Context) ToolApprovalPtrOutput

type ToolApprovalPtrInput

type ToolApprovalPtrInput interface {
	pulumi.Input

	ToToolApprovalPtrOutput() ToolApprovalPtrOutput
	ToToolApprovalPtrOutputWithContext(context.Context) ToolApprovalPtrOutput
}

func ToolApprovalPtr

func ToolApprovalPtr(v string) ToolApprovalPtrInput

type ToolApprovalPtrOutput

type ToolApprovalPtrOutput struct{ *pulumi.OutputState }

func (ToolApprovalPtrOutput) Elem

func (ToolApprovalPtrOutput) ElementType

func (ToolApprovalPtrOutput) ElementType() reflect.Type

func (ToolApprovalPtrOutput) ToStringPtrOutput

func (o ToolApprovalPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (ToolApprovalPtrOutput) ToStringPtrOutputWithContext

func (o ToolApprovalPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

func (ToolApprovalPtrOutput) ToToolApprovalPtrOutput

func (o ToolApprovalPtrOutput) ToToolApprovalPtrOutput() ToolApprovalPtrOutput

func (ToolApprovalPtrOutput) ToToolApprovalPtrOutputWithContext

func (o ToolApprovalPtrOutput) ToToolApprovalPtrOutputWithContext(ctx context.Context) ToolApprovalPtrOutput

type Toolset

type Toolset struct {
	// Allow-list of directories the filesystem or file tool is permitted to access. Each entry may be '.' (the agent's working directory), '~' or '~/...' (the user's home directory), an absolute path, or a relative path (anchored at the working directory). Symlinks are followed before the containment check, so they cannot be used to escape the allow-list. An empty or omitted list preserves the default behaviour (any path the agent process can reach).
	AllowList []string `pulumi:"allowList"`
	// Opt in to dialling non-public IP addresses (valid for type 'fetch', 'api', 'openapi', 'a2a', and remote MCP toolsets). By default, on the direct path (Docker Desktop unavailable, disabled, or target host is not in the Docker-owned allowlist), protected HTTP clients refuse connections — after DNS resolution, defeating DNS rebinding — to loopback, RFC1918 private ranges, link-local (including the cloud metadata endpoint at 169.254.169.254), multicast and the unspecified address. When Docker Desktop is running, only Docker-owned hostnames (docker.com, docker.io families) go through its PAC proxy; dial-time enforcement does not apply on that path. Set this to true when an agent legitimately needs to call internal services. For fetch, 'allowed_domains' / 'blocked_domains' are evaluated independently and still apply.
	AllowPrivateIps *bool `pulumi:"allowPrivateIps"`
	// Allow-list of domains the fetch tool is permitted to fetch (only valid for type 'fetch'). Patterns are case-insensitive. A bare host ('example.com') matches the apex AND any subdomain. A leading dot ('.example.com') or wildcard ('*.example.com') matches strict subdomains only. CIDR ranges ('10.0.0.0/8', '::1/128') match when the URL host parses as an IP inside the network. Mutually exclusive with 'blocked_domains'.
	AllowedDomains []string `pulumi:"allowedDomains"`
	// Allow-list of MCP catalog server ids offered by default (only valid for type 'mcp_catalog'). When non-empty, only these servers are searchable and enableable; every other catalog entry is hidden. Combine with 'blocked_servers' to subtract individual ids (block takes precedence). An empty or omitted list offers the full catalog.
	AllowedServers []string `pulumi:"allowedServers"`
	// API tool configuration
	ApiConfig *ApiConfig `pulumi:"apiConfig"`
	// Arguments for the tool
	Args []string `pulumi:"args"`
	// Deny-list of domains the fetch tool is forbidden to fetch (only valid for type 'fetch'). Uses the same matching rules as 'allowed_domains' (bare host, leading-dot or '*.' subdomain wildcard, and CIDR ranges for IP hosts). Mutually exclusive with 'allowed_domains'.
	BlockedDomains []string `pulumi:"blockedDomains"`
	// Block-list of MCP catalog server ids removed from the offered set (only valid for type 'mcp_catalog'). Applied after 'allowed_servers', so a server listed in both is blocked. An empty or omitted list disables the block-list.
	BlockedServers []string `pulumi:"blockedServers"`
	// Command to execute for MCP tools
	Command *string `pulumi:"command"`
	// Tool-specific configuration. Free-form, rendered verbatim.
	Config interface{} `pulumi:"config"`
	// Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.
	Defer *bool `pulumi:"defer"`
	// Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.
	DeferTools []string `pulumi:"deferTools"`
	// Deny-list of directories the filesystem or file tool is forbidden to access. Uses the same expansion rules as 'allow_list'. The deny-list takes precedence over the allow-list: a path that matches both is rejected.
	DenyList []string `pulumi:"denyList"`
	// Environment variables
	Env map[string]string `pulumi:"env"`
	// Restore legacy HTML escaping of <, > and & in multi-URL JSON results (only valid for type 'fetch'). Defaults to false to reduce token usage. Decoded content and single-URL results are unchanged.
	EscapeHtml *bool `pulumi:"escapeHtml"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// File extensions this LSP server handles (e.g., [".go", ".mod"]). Only for lsp toolsets.
	FileTypes []string `pulumi:"fileTypes"`
	// HTTP headers (supports ${env.VAR} interpolation). Valid for type 'openapi', 'a2a', and 'fetch'. For 'fetch', the headers are sent on every request the toolset issues — typical use is supplying API tokens (e.g. Authorization: Bearer ${env.MY_TOKEN}). Caller-supplied values override the format-driven Accept header and the default User-Agent.
	Headers map[string]string `pulumi:"headers"`
	// Whether to ignore VCS files (.git directories and .gitignore patterns) in filesystem operations. Default: true
	IgnoreVcs *bool `pulumi:"ignoreVcs"`
	// Custom instruction for this toolset. By default, setting this field replaces the toolset's built-in instructions entirely. To enrich (rather than replace) the original instructions, include the placeholder {ORIGINAL_INSTRUCTIONS} in your text — it will be substituted with the toolset's built-in instructions at runtime. For example: '{ORIGINAL_INSTRUCTIONS}
	// Always prefer JSON output.' will prepend the original instructions and append your extra guidance.
	Instruction *string `pulumi:"instruction"`
	// Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.
	Lifecycle *Lifecycle `pulumi:"lifecycle"`
	// Maximum OpenAPI text output in bytes (only valid for type 'openapi'). Defaults to 30000 when omitted; 0 disables the text cutoff.
	MaxOutputBytes *int `pulumi:"maxOutputBytes"`
	// Model to use for the LLM turn that processes tool results from this toolset. Enables per-tool model routing: cheaper/faster models handle simple tool results (e.g. knowledge-base lookups, file reads) while the agent's primary model handles complex reasoning. Value can be a model name from the models section or an inline provider/model format (e.g. 'openai/gpt-4o-mini').
	Model *string `pulumi:"model"`
	// List of allowed models for the model_picker tool.
	Models []string `pulumi:"models"`
	// Name for the a2a tool
	Name *string `pulumi:"name"`
	// Storage path for the memory or tasks toolset
	Path *string `pulumi:"path"`
	// Post-edit commands for filesystem and file tools
	PostEdit []PostEdit `pulumi:"postEdit"`
	// RAG configuration for type: rag toolsets
	RagConfig *RagConfig `pulumi:"ragConfig"`
	// When true, restricts this toolset to tools whose annotations carry a read-only hint. Every other (mutating) tool is filtered out, so the agent can only list and call the non-mutating subset of the toolset.
	Readonly *bool `pulumi:"readonly"`
	// Opt in to background-job recall for the background_jobs toolset (only valid for type 'background_jobs'). When enabled, run_background_job exposes a recall boolean parameter. If the agent sets recall=true for a background job, the runtime injects a steering message with a short completion sentence and the job output when the job finishes. Default false.
	Recall *bool `pulumi:"recall"`
	// Reference to a Docker MCP tool (e.g., 'docker:context7') or a named MCP definition from the top-level 'mcps' section
	Ref *string `pulumi:"ref"`
	// Remote tool configuration
	Remote *Remote `pulumi:"remote"`
	// Whether the tool is shared (for think tool)
	Shared *bool `pulumi:"shared"`
	// Shell script configurations (for script tool)
	Shell map[string]ScriptShellTool `pulumi:"shell"`
	// Opt in to a sudo privilege escalation flow for the shell toolset (only valid for type 'shell'). When enabled, sudo commands prompt the user for their password through the host UI via SUDO_ASKPASS; in non-interactive runs the prompt is declined automatically. Only a bare 'sudo ...' invocation in a POSIX shell is handled. No effect on Windows. Default false.
	SudoAskpass *bool `pulumi:"sudoAskpass"`
	// HTTP timeout in seconds (valid for type 'fetch', 'api', and 'openapi'). Defaults to 30 seconds when omitted.
	Timeout *int `pulumi:"timeout"`
	// List of tools to include
	Tools []string `pulumi:"tools"`
	// A comma-delimited list of regular expressions of tools to toonify
	Toon *string `pulumi:"toon"`
	// Type of tool. Allowed values: `mcp`, `mcp_catalog`, `script`, `calculator`, `think`, `random`, `memory`, `filesystem`, `file`, `shell`, `background_jobs`, `tasks`, `plan`, `session_context`, `todo`, `fetch`, `api`, `a2a`, `lsp`, `user_prompt`, `openapi`, `open_url`, `model_picker`, `background_agents`, `scheduler`, `rag`, `git`, `webhook`, `environment`, `datetime`.
	Type string `pulumi:"type"`
	// URL for the a2a, openapi or open_url tool
	Url *string `pulumi:"url"`
	// Package reference for auto-installation of MCP/LSP tool binaries. Format: 'owner/repo' or 'owner/repo@version'. Set to 'false' to disable auto-install for this toolset.
	Version *string `pulumi:"version"`
	// Webhook tool configuration
	WebhookConfig *WebhookConfig `pulumi:"webhookConfig"`
	// Optional working directory for MCP/LSP toolset processes. Relative paths are resolved relative to the agent's working directory. Only valid for type 'mcp' or 'lsp', and not supported for remote MCP toolsets (no local subprocess).
	WorkingDir *string `pulumi:"workingDir"`
}

Tool configuration

type ToolsetArgs

type ToolsetArgs struct {
	// Allow-list of directories the filesystem or file tool is permitted to access. Each entry may be '.' (the agent's working directory), '~' or '~/...' (the user's home directory), an absolute path, or a relative path (anchored at the working directory). Symlinks are followed before the containment check, so they cannot be used to escape the allow-list. An empty or omitted list preserves the default behaviour (any path the agent process can reach).
	AllowList pulumi.StringArrayInput `pulumi:"allowList"`
	// Opt in to dialling non-public IP addresses (valid for type 'fetch', 'api', 'openapi', 'a2a', and remote MCP toolsets). By default, on the direct path (Docker Desktop unavailable, disabled, or target host is not in the Docker-owned allowlist), protected HTTP clients refuse connections — after DNS resolution, defeating DNS rebinding — to loopback, RFC1918 private ranges, link-local (including the cloud metadata endpoint at 169.254.169.254), multicast and the unspecified address. When Docker Desktop is running, only Docker-owned hostnames (docker.com, docker.io families) go through its PAC proxy; dial-time enforcement does not apply on that path. Set this to true when an agent legitimately needs to call internal services. For fetch, 'allowed_domains' / 'blocked_domains' are evaluated independently and still apply.
	AllowPrivateIps pulumi.BoolPtrInput `pulumi:"allowPrivateIps"`
	// Allow-list of domains the fetch tool is permitted to fetch (only valid for type 'fetch'). Patterns are case-insensitive. A bare host ('example.com') matches the apex AND any subdomain. A leading dot ('.example.com') or wildcard ('*.example.com') matches strict subdomains only. CIDR ranges ('10.0.0.0/8', '::1/128') match when the URL host parses as an IP inside the network. Mutually exclusive with 'blocked_domains'.
	AllowedDomains pulumi.StringArrayInput `pulumi:"allowedDomains"`
	// Allow-list of MCP catalog server ids offered by default (only valid for type 'mcp_catalog'). When non-empty, only these servers are searchable and enableable; every other catalog entry is hidden. Combine with 'blocked_servers' to subtract individual ids (block takes precedence). An empty or omitted list offers the full catalog.
	AllowedServers pulumi.StringArrayInput `pulumi:"allowedServers"`
	// API tool configuration
	ApiConfig ApiConfigPtrInput `pulumi:"apiConfig"`
	// Arguments for the tool
	Args pulumi.StringArrayInput `pulumi:"args"`
	// Deny-list of domains the fetch tool is forbidden to fetch (only valid for type 'fetch'). Uses the same matching rules as 'allowed_domains' (bare host, leading-dot or '*.' subdomain wildcard, and CIDR ranges for IP hosts). Mutually exclusive with 'allowed_domains'.
	BlockedDomains pulumi.StringArrayInput `pulumi:"blockedDomains"`
	// Block-list of MCP catalog server ids removed from the offered set (only valid for type 'mcp_catalog'). Applied after 'allowed_servers', so a server listed in both is blocked. An empty or omitted list disables the block-list.
	BlockedServers pulumi.StringArrayInput `pulumi:"blockedServers"`
	// Command to execute for MCP tools
	Command pulumi.StringPtrInput `pulumi:"command"`
	// Tool-specific configuration. Free-form, rendered verbatim.
	Config pulumi.Input `pulumi:"config"`
	// Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.
	Defer pulumi.BoolPtrInput `pulumi:"defer"`
	// Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.
	DeferTools pulumi.StringArrayInput `pulumi:"deferTools"`
	// Deny-list of directories the filesystem or file tool is forbidden to access. Uses the same expansion rules as 'allow_list'. The deny-list takes precedence over the allow-list: a path that matches both is rejected.
	DenyList pulumi.StringArrayInput `pulumi:"denyList"`
	// Environment variables
	Env pulumi.StringMapInput `pulumi:"env"`
	// Restore legacy HTML escaping of <, > and & in multi-URL JSON results (only valid for type 'fetch'). Defaults to false to reduce token usage. Decoded content and single-URL results are unchanged.
	EscapeHtml pulumi.BoolPtrInput `pulumi:"escapeHtml"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// File extensions this LSP server handles (e.g., [".go", ".mod"]). Only for lsp toolsets.
	FileTypes pulumi.StringArrayInput `pulumi:"fileTypes"`
	// HTTP headers (supports ${env.VAR} interpolation). Valid for type 'openapi', 'a2a', and 'fetch'. For 'fetch', the headers are sent on every request the toolset issues — typical use is supplying API tokens (e.g. Authorization: Bearer ${env.MY_TOKEN}). Caller-supplied values override the format-driven Accept header and the default User-Agent.
	Headers pulumi.StringMapInput `pulumi:"headers"`
	// Whether to ignore VCS files (.git directories and .gitignore patterns) in filesystem operations. Default: true
	IgnoreVcs pulumi.BoolPtrInput `pulumi:"ignoreVcs"`
	// Custom instruction for this toolset. By default, setting this field replaces the toolset's built-in instructions entirely. To enrich (rather than replace) the original instructions, include the placeholder {ORIGINAL_INSTRUCTIONS} in your text — it will be substituted with the toolset's built-in instructions at runtime. For example: '{ORIGINAL_INSTRUCTIONS}
	// Always prefer JSON output.' will prepend the original instructions and append your extra guidance.
	Instruction pulumi.StringPtrInput `pulumi:"instruction"`
	// Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.
	Lifecycle LifecyclePtrInput `pulumi:"lifecycle"`
	// Maximum OpenAPI text output in bytes (only valid for type 'openapi'). Defaults to 30000 when omitted; 0 disables the text cutoff.
	MaxOutputBytes pulumi.IntPtrInput `pulumi:"maxOutputBytes"`
	// Model to use for the LLM turn that processes tool results from this toolset. Enables per-tool model routing: cheaper/faster models handle simple tool results (e.g. knowledge-base lookups, file reads) while the agent's primary model handles complex reasoning. Value can be a model name from the models section or an inline provider/model format (e.g. 'openai/gpt-4o-mini').
	Model pulumi.StringPtrInput `pulumi:"model"`
	// List of allowed models for the model_picker tool.
	Models pulumi.StringArrayInput `pulumi:"models"`
	// Name for the a2a tool
	Name pulumi.StringPtrInput `pulumi:"name"`
	// Storage path for the memory or tasks toolset
	Path pulumi.StringPtrInput `pulumi:"path"`
	// Post-edit commands for filesystem and file tools
	PostEdit PostEditArrayInput `pulumi:"postEdit"`
	// RAG configuration for type: rag toolsets
	RagConfig RagConfigPtrInput `pulumi:"ragConfig"`
	// When true, restricts this toolset to tools whose annotations carry a read-only hint. Every other (mutating) tool is filtered out, so the agent can only list and call the non-mutating subset of the toolset.
	Readonly pulumi.BoolPtrInput `pulumi:"readonly"`
	// Opt in to background-job recall for the background_jobs toolset (only valid for type 'background_jobs'). When enabled, run_background_job exposes a recall boolean parameter. If the agent sets recall=true for a background job, the runtime injects a steering message with a short completion sentence and the job output when the job finishes. Default false.
	Recall pulumi.BoolPtrInput `pulumi:"recall"`
	// Reference to a Docker MCP tool (e.g., 'docker:context7') or a named MCP definition from the top-level 'mcps' section
	Ref pulumi.StringPtrInput `pulumi:"ref"`
	// Remote tool configuration
	Remote RemotePtrInput `pulumi:"remote"`
	// Whether the tool is shared (for think tool)
	Shared pulumi.BoolPtrInput `pulumi:"shared"`
	// Shell script configurations (for script tool)
	Shell ScriptShellToolMapInput `pulumi:"shell"`
	// Opt in to a sudo privilege escalation flow for the shell toolset (only valid for type 'shell'). When enabled, sudo commands prompt the user for their password through the host UI via SUDO_ASKPASS; in non-interactive runs the prompt is declined automatically. Only a bare 'sudo ...' invocation in a POSIX shell is handled. No effect on Windows. Default false.
	SudoAskpass pulumi.BoolPtrInput `pulumi:"sudoAskpass"`
	// HTTP timeout in seconds (valid for type 'fetch', 'api', and 'openapi'). Defaults to 30 seconds when omitted.
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// List of tools to include
	Tools pulumi.StringArrayInput `pulumi:"tools"`
	// A comma-delimited list of regular expressions of tools to toonify
	Toon pulumi.StringPtrInput `pulumi:"toon"`
	// Type of tool. Allowed values: `mcp`, `mcp_catalog`, `script`, `calculator`, `think`, `random`, `memory`, `filesystem`, `file`, `shell`, `background_jobs`, `tasks`, `plan`, `session_context`, `todo`, `fetch`, `api`, `a2a`, `lsp`, `user_prompt`, `openapi`, `open_url`, `model_picker`, `background_agents`, `scheduler`, `rag`, `git`, `webhook`, `environment`, `datetime`.
	Type pulumi.StringInput `pulumi:"type"`
	// URL for the a2a, openapi or open_url tool
	Url pulumi.StringPtrInput `pulumi:"url"`
	// Package reference for auto-installation of MCP/LSP tool binaries. Format: 'owner/repo' or 'owner/repo@version'. Set to 'false' to disable auto-install for this toolset.
	Version pulumi.StringPtrInput `pulumi:"version"`
	// Webhook tool configuration
	WebhookConfig WebhookConfigPtrInput `pulumi:"webhookConfig"`
	// Optional working directory for MCP/LSP toolset processes. Relative paths are resolved relative to the agent's working directory. Only valid for type 'mcp' or 'lsp', and not supported for remote MCP toolsets (no local subprocess).
	WorkingDir pulumi.StringPtrInput `pulumi:"workingDir"`
}

Tool configuration

func (ToolsetArgs) ElementType

func (ToolsetArgs) ElementType() reflect.Type

func (ToolsetArgs) ToToolsetOutput

func (i ToolsetArgs) ToToolsetOutput() ToolsetOutput

func (ToolsetArgs) ToToolsetOutputWithContext

func (i ToolsetArgs) ToToolsetOutputWithContext(ctx context.Context) ToolsetOutput

type ToolsetArray

type ToolsetArray []ToolsetInput

func (ToolsetArray) ElementType

func (ToolsetArray) ElementType() reflect.Type

func (ToolsetArray) ToToolsetArrayOutput

func (i ToolsetArray) ToToolsetArrayOutput() ToolsetArrayOutput

func (ToolsetArray) ToToolsetArrayOutputWithContext

func (i ToolsetArray) ToToolsetArrayOutputWithContext(ctx context.Context) ToolsetArrayOutput

type ToolsetArrayInput

type ToolsetArrayInput interface {
	pulumi.Input

	ToToolsetArrayOutput() ToolsetArrayOutput
	ToToolsetArrayOutputWithContext(context.Context) ToolsetArrayOutput
}

ToolsetArrayInput is an input type that accepts ToolsetArray and ToolsetArrayOutput values. You can construct a concrete instance of `ToolsetArrayInput` via:

ToolsetArray{ ToolsetArgs{...} }

type ToolsetArrayOutput

type ToolsetArrayOutput struct{ *pulumi.OutputState }

func (ToolsetArrayOutput) ElementType

func (ToolsetArrayOutput) ElementType() reflect.Type

func (ToolsetArrayOutput) Index

func (ToolsetArrayOutput) ToToolsetArrayOutput

func (o ToolsetArrayOutput) ToToolsetArrayOutput() ToolsetArrayOutput

func (ToolsetArrayOutput) ToToolsetArrayOutputWithContext

func (o ToolsetArrayOutput) ToToolsetArrayOutputWithContext(ctx context.Context) ToolsetArrayOutput

type ToolsetInput

type ToolsetInput interface {
	pulumi.Input

	ToToolsetOutput() ToolsetOutput
	ToToolsetOutputWithContext(context.Context) ToolsetOutput
}

ToolsetInput is an input type that accepts ToolsetArgs and ToolsetOutput values. You can construct a concrete instance of `ToolsetInput` via:

ToolsetArgs{...}

type ToolsetMap

type ToolsetMap map[string]ToolsetInput

func (ToolsetMap) ElementType

func (ToolsetMap) ElementType() reflect.Type

func (ToolsetMap) ToToolsetMapOutput

func (i ToolsetMap) ToToolsetMapOutput() ToolsetMapOutput

func (ToolsetMap) ToToolsetMapOutputWithContext

func (i ToolsetMap) ToToolsetMapOutputWithContext(ctx context.Context) ToolsetMapOutput

type ToolsetMapInput

type ToolsetMapInput interface {
	pulumi.Input

	ToToolsetMapOutput() ToolsetMapOutput
	ToToolsetMapOutputWithContext(context.Context) ToolsetMapOutput
}

ToolsetMapInput is an input type that accepts ToolsetMap and ToolsetMapOutput values. You can construct a concrete instance of `ToolsetMapInput` via:

ToolsetMap{ "key": ToolsetArgs{...} }

type ToolsetMapOutput

type ToolsetMapOutput struct{ *pulumi.OutputState }

func (ToolsetMapOutput) ElementType

func (ToolsetMapOutput) ElementType() reflect.Type

func (ToolsetMapOutput) MapIndex

func (ToolsetMapOutput) ToToolsetMapOutput

func (o ToolsetMapOutput) ToToolsetMapOutput() ToolsetMapOutput

func (ToolsetMapOutput) ToToolsetMapOutputWithContext

func (o ToolsetMapOutput) ToToolsetMapOutputWithContext(ctx context.Context) ToolsetMapOutput

type ToolsetOutput

type ToolsetOutput struct{ *pulumi.OutputState }

Tool configuration

func (ToolsetOutput) AllowList

func (o ToolsetOutput) AllowList() pulumi.StringArrayOutput

Allow-list of directories the filesystem or file tool is permitted to access. Each entry may be '.' (the agent's working directory), '~' or '~/...' (the user's home directory), an absolute path, or a relative path (anchored at the working directory). Symlinks are followed before the containment check, so they cannot be used to escape the allow-list. An empty or omitted list preserves the default behaviour (any path the agent process can reach).

func (ToolsetOutput) AllowPrivateIps

func (o ToolsetOutput) AllowPrivateIps() pulumi.BoolPtrOutput

Opt in to dialling non-public IP addresses (valid for type 'fetch', 'api', 'openapi', 'a2a', and remote MCP toolsets). By default, on the direct path (Docker Desktop unavailable, disabled, or target host is not in the Docker-owned allowlist), protected HTTP clients refuse connections — after DNS resolution, defeating DNS rebinding — to loopback, RFC1918 private ranges, link-local (including the cloud metadata endpoint at 169.254.169.254), multicast and the unspecified address. When Docker Desktop is running, only Docker-owned hostnames (docker.com, docker.io families) go through its PAC proxy; dial-time enforcement does not apply on that path. Set this to true when an agent legitimately needs to call internal services. For fetch, 'allowed_domains' / 'blocked_domains' are evaluated independently and still apply.

func (ToolsetOutput) AllowedDomains

func (o ToolsetOutput) AllowedDomains() pulumi.StringArrayOutput

Allow-list of domains the fetch tool is permitted to fetch (only valid for type 'fetch'). Patterns are case-insensitive. A bare host ('example.com') matches the apex AND any subdomain. A leading dot ('.example.com') or wildcard ('*.example.com') matches strict subdomains only. CIDR ranges ('10.0.0.0/8', '::1/128') match when the URL host parses as an IP inside the network. Mutually exclusive with 'blocked_domains'.

func (ToolsetOutput) AllowedServers

func (o ToolsetOutput) AllowedServers() pulumi.StringArrayOutput

Allow-list of MCP catalog server ids offered by default (only valid for type 'mcp_catalog'). When non-empty, only these servers are searchable and enableable; every other catalog entry is hidden. Combine with 'blocked_servers' to subtract individual ids (block takes precedence). An empty or omitted list offers the full catalog.

func (ToolsetOutput) ApiConfig

func (o ToolsetOutput) ApiConfig() ApiConfigPtrOutput

API tool configuration

func (ToolsetOutput) Args

Arguments for the tool

func (ToolsetOutput) BlockedDomains

func (o ToolsetOutput) BlockedDomains() pulumi.StringArrayOutput

Deny-list of domains the fetch tool is forbidden to fetch (only valid for type 'fetch'). Uses the same matching rules as 'allowed_domains' (bare host, leading-dot or '*.' subdomain wildcard, and CIDR ranges for IP hosts). Mutually exclusive with 'allowed_domains'.

func (ToolsetOutput) BlockedServers

func (o ToolsetOutput) BlockedServers() pulumi.StringArrayOutput

Block-list of MCP catalog server ids removed from the offered set (only valid for type 'mcp_catalog'). Applied after 'allowed_servers', so a server listed in both is blocked. An empty or omitted list disables the block-list.

func (ToolsetOutput) Command

func (o ToolsetOutput) Command() pulumi.StringPtrOutput

Command to execute for MCP tools

func (ToolsetOutput) Config

func (o ToolsetOutput) Config() pulumi.AnyOutput

Tool-specific configuration. Free-form, rendered verbatim.

func (ToolsetOutput) Defer

Defer loading all tools of this toolset until the model searches for them (`defer: true`). Mutually exclusive with `deferTools`.

func (ToolsetOutput) DeferTools

func (o ToolsetOutput) DeferTools() pulumi.StringArrayOutput

Defer loading only these tools until the model searches for them (`defer: [names]`). Mutually exclusive with `defer`.

func (ToolsetOutput) DenyList

func (o ToolsetOutput) DenyList() pulumi.StringArrayOutput

Deny-list of directories the filesystem or file tool is forbidden to access. Uses the same expansion rules as 'allow_list'. The deny-list takes precedence over the allow-list: a path that matches both is rejected.

func (ToolsetOutput) ElementType

func (ToolsetOutput) ElementType() reflect.Type

func (ToolsetOutput) Env

Environment variables

func (ToolsetOutput) EscapeHtml

func (o ToolsetOutput) EscapeHtml() pulumi.BoolPtrOutput

Restore legacy HTML escaping of <, > and & in multi-URL JSON results (only valid for type 'fetch'). Defaults to false to reduce token usage. Decoded content and single-URL results are unchanged.

func (ToolsetOutput) Extra

func (o ToolsetOutput) Extra() pulumi.MapOutput

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (ToolsetOutput) FileTypes

func (o ToolsetOutput) FileTypes() pulumi.StringArrayOutput

File extensions this LSP server handles (e.g., [".go", ".mod"]). Only for lsp toolsets.

func (ToolsetOutput) Headers

func (o ToolsetOutput) Headers() pulumi.StringMapOutput

HTTP headers (supports ${env.VAR} interpolation). Valid for type 'openapi', 'a2a', and 'fetch'. For 'fetch', the headers are sent on every request the toolset issues — typical use is supplying API tokens (e.g. Authorization: Bearer ${env.MY_TOKEN}). Caller-supplied values override the format-driven Accept header and the default User-Agent.

func (ToolsetOutput) IgnoreVcs

func (o ToolsetOutput) IgnoreVcs() pulumi.BoolPtrOutput

Whether to ignore VCS files (.git directories and .gitignore patterns) in filesystem operations. Default: true

func (ToolsetOutput) Instruction

func (o ToolsetOutput) Instruction() pulumi.StringPtrOutput

Custom instruction for this toolset. By default, setting this field replaces the toolset's built-in instructions entirely. To enrich (rather than replace) the original instructions, include the placeholder {ORIGINAL_INSTRUCTIONS} in your text — it will be substituted with the toolset's built-in instructions at runtime. For example: '{ORIGINAL_INSTRUCTIONS} Always prefer JSON output.' will prepend the original instructions and append your extra guidance.

func (ToolsetOutput) Lifecycle

func (o ToolsetOutput) Lifecycle() LifecyclePtrOutput

Controls how the agent supervises a long-running toolset process (MCP server, remote MCP, LSP server). All fields are optional; pick a profile that matches your taste and override individual knobs as needed.

func (ToolsetOutput) MaxOutputBytes

func (o ToolsetOutput) MaxOutputBytes() pulumi.IntPtrOutput

Maximum OpenAPI text output in bytes (only valid for type 'openapi'). Defaults to 30000 when omitted; 0 disables the text cutoff.

func (ToolsetOutput) Model

Model to use for the LLM turn that processes tool results from this toolset. Enables per-tool model routing: cheaper/faster models handle simple tool results (e.g. knowledge-base lookups, file reads) while the agent's primary model handles complex reasoning. Value can be a model name from the models section or an inline provider/model format (e.g. 'openai/gpt-4o-mini').

func (ToolsetOutput) Models

List of allowed models for the model_picker tool.

func (ToolsetOutput) Name

Name for the a2a tool

func (ToolsetOutput) Path

Storage path for the memory or tasks toolset

func (ToolsetOutput) PostEdit

func (o ToolsetOutput) PostEdit() PostEditArrayOutput

Post-edit commands for filesystem and file tools

func (ToolsetOutput) RagConfig

func (o ToolsetOutput) RagConfig() RagConfigPtrOutput

RAG configuration for type: rag toolsets

func (ToolsetOutput) Readonly

func (o ToolsetOutput) Readonly() pulumi.BoolPtrOutput

When true, restricts this toolset to tools whose annotations carry a read-only hint. Every other (mutating) tool is filtered out, so the agent can only list and call the non-mutating subset of the toolset.

func (ToolsetOutput) Recall

func (o ToolsetOutput) Recall() pulumi.BoolPtrOutput

Opt in to background-job recall for the background_jobs toolset (only valid for type 'background_jobs'). When enabled, run_background_job exposes a recall boolean parameter. If the agent sets recall=true for a background job, the runtime injects a steering message with a short completion sentence and the job output when the job finishes. Default false.

func (ToolsetOutput) Ref

Reference to a Docker MCP tool (e.g., 'docker:context7') or a named MCP definition from the top-level 'mcps' section

func (ToolsetOutput) Remote

func (o ToolsetOutput) Remote() RemotePtrOutput

Remote tool configuration

func (ToolsetOutput) Shared

func (o ToolsetOutput) Shared() pulumi.BoolPtrOutput

Whether the tool is shared (for think tool)

func (ToolsetOutput) Shell

Shell script configurations (for script tool)

func (ToolsetOutput) SudoAskpass

func (o ToolsetOutput) SudoAskpass() pulumi.BoolPtrOutput

Opt in to a sudo privilege escalation flow for the shell toolset (only valid for type 'shell'). When enabled, sudo commands prompt the user for their password through the host UI via SUDO_ASKPASS; in non-interactive runs the prompt is declined automatically. Only a bare 'sudo ...' invocation in a POSIX shell is handled. No effect on Windows. Default false.

func (ToolsetOutput) Timeout

func (o ToolsetOutput) Timeout() pulumi.IntPtrOutput

HTTP timeout in seconds (valid for type 'fetch', 'api', and 'openapi'). Defaults to 30 seconds when omitted.

func (ToolsetOutput) ToToolsetOutput

func (o ToolsetOutput) ToToolsetOutput() ToolsetOutput

func (ToolsetOutput) ToToolsetOutputWithContext

func (o ToolsetOutput) ToToolsetOutputWithContext(ctx context.Context) ToolsetOutput

func (ToolsetOutput) Tools

List of tools to include

func (ToolsetOutput) Toon

A comma-delimited list of regular expressions of tools to toonify

func (ToolsetOutput) Type

Type of tool. Allowed values: `mcp`, `mcp_catalog`, `script`, `calculator`, `think`, `random`, `memory`, `filesystem`, `file`, `shell`, `background_jobs`, `tasks`, `plan`, `session_context`, `todo`, `fetch`, `api`, `a2a`, `lsp`, `user_prompt`, `openapi`, `open_url`, `model_picker`, `background_agents`, `scheduler`, `rag`, `git`, `webhook`, `environment`, `datetime`.

func (ToolsetOutput) Url

URL for the a2a, openapi or open_url tool

func (ToolsetOutput) Version

func (o ToolsetOutput) Version() pulumi.StringPtrOutput

Package reference for auto-installation of MCP/LSP tool binaries. Format: 'owner/repo' or 'owner/repo@version'. Set to 'false' to disable auto-install for this toolset.

func (ToolsetOutput) WebhookConfig

func (o ToolsetOutput) WebhookConfig() WebhookConfigPtrOutput

Webhook tool configuration

func (ToolsetOutput) WorkingDir

func (o ToolsetOutput) WorkingDir() pulumi.StringPtrOutput

Optional working directory for MCP/LSP toolset processes. Relative paths are resolved relative to the agent's working directory. Only valid for type 'mcp' or 'lsp', and not supported for remote MCP toolsets (no local subprocess).

type UserAlias

type UserAlias struct {
	// Hide tool call results in the TUI when running the alias.
	HideToolResults *bool `pulumi:"hideToolResults"`
	// Override the agent's model, in the format `[agent=]provider/model`.
	Model *string `pulumi:"model"`
	// The agent file path or OCI reference, for example `./agent.yaml` or `docker.io/myorg/agent:latest`.
	Path string `pulumi:"path"`
	// The safety mode used when running the alias without `--safety`/`--yolo`: `strict`, `balanced`, `restricted` or `autonomous`.
	Safety *SafetyMode `pulumi:"safety"`
	// Run the alias inside a Docker sandbox by default.
	Sandbox *bool `pulumi:"sandbox"`
	// Auto-approve every tool call when running the alias. Legacy alias for `safety: autonomous`.
	Yolo *bool `pulumi:"yolo"`
}

An agent alias, as created by `docker agent alias add`: `docker agent run <alias>` runs `path` with the alias's defaults. Alias names may contain letters, digits, `-` and `_`, and start with a letter or digit.

type UserAliasArgs

type UserAliasArgs struct {
	// Hide tool call results in the TUI when running the alias.
	HideToolResults pulumi.BoolPtrInput `pulumi:"hideToolResults"`
	// Override the agent's model, in the format `[agent=]provider/model`.
	Model pulumi.StringPtrInput `pulumi:"model"`
	// The agent file path or OCI reference, for example `./agent.yaml` or `docker.io/myorg/agent:latest`.
	Path pulumi.StringInput `pulumi:"path"`
	// The safety mode used when running the alias without `--safety`/`--yolo`: `strict`, `balanced`, `restricted` or `autonomous`.
	Safety SafetyModePtrInput `pulumi:"safety"`
	// Run the alias inside a Docker sandbox by default.
	Sandbox pulumi.BoolPtrInput `pulumi:"sandbox"`
	// Auto-approve every tool call when running the alias. Legacy alias for `safety: autonomous`.
	Yolo pulumi.BoolPtrInput `pulumi:"yolo"`
}

An agent alias, as created by `docker agent alias add`: `docker agent run <alias>` runs `path` with the alias's defaults. Alias names may contain letters, digits, `-` and `_`, and start with a letter or digit.

func (UserAliasArgs) ElementType

func (UserAliasArgs) ElementType() reflect.Type

func (UserAliasArgs) ToUserAliasOutput

func (i UserAliasArgs) ToUserAliasOutput() UserAliasOutput

func (UserAliasArgs) ToUserAliasOutputWithContext

func (i UserAliasArgs) ToUserAliasOutputWithContext(ctx context.Context) UserAliasOutput

type UserAliasInput

type UserAliasInput interface {
	pulumi.Input

	ToUserAliasOutput() UserAliasOutput
	ToUserAliasOutputWithContext(context.Context) UserAliasOutput
}

UserAliasInput is an input type that accepts UserAliasArgs and UserAliasOutput values. You can construct a concrete instance of `UserAliasInput` via:

UserAliasArgs{...}

type UserAliasMap

type UserAliasMap map[string]UserAliasInput

func (UserAliasMap) ElementType

func (UserAliasMap) ElementType() reflect.Type

func (UserAliasMap) ToUserAliasMapOutput

func (i UserAliasMap) ToUserAliasMapOutput() UserAliasMapOutput

func (UserAliasMap) ToUserAliasMapOutputWithContext

func (i UserAliasMap) ToUserAliasMapOutputWithContext(ctx context.Context) UserAliasMapOutput

type UserAliasMapInput

type UserAliasMapInput interface {
	pulumi.Input

	ToUserAliasMapOutput() UserAliasMapOutput
	ToUserAliasMapOutputWithContext(context.Context) UserAliasMapOutput
}

UserAliasMapInput is an input type that accepts UserAliasMap and UserAliasMapOutput values. You can construct a concrete instance of `UserAliasMapInput` via:

UserAliasMap{ "key": UserAliasArgs{...} }

type UserAliasMapOutput

type UserAliasMapOutput struct{ *pulumi.OutputState }

func (UserAliasMapOutput) ElementType

func (UserAliasMapOutput) ElementType() reflect.Type

func (UserAliasMapOutput) MapIndex

func (UserAliasMapOutput) ToUserAliasMapOutput

func (o UserAliasMapOutput) ToUserAliasMapOutput() UserAliasMapOutput

func (UserAliasMapOutput) ToUserAliasMapOutputWithContext

func (o UserAliasMapOutput) ToUserAliasMapOutputWithContext(ctx context.Context) UserAliasMapOutput

type UserAliasOutput

type UserAliasOutput struct{ *pulumi.OutputState }

An agent alias, as created by `docker agent alias add`: `docker agent run <alias>` runs `path` with the alias's defaults. Alias names may contain letters, digits, `-` and `_`, and start with a letter or digit.

func (UserAliasOutput) ElementType

func (UserAliasOutput) ElementType() reflect.Type

func (UserAliasOutput) HideToolResults

func (o UserAliasOutput) HideToolResults() pulumi.BoolPtrOutput

Hide tool call results in the TUI when running the alias.

func (UserAliasOutput) Model

Override the agent's model, in the format `[agent=]provider/model`.

func (UserAliasOutput) Path

The agent file path or OCI reference, for example `./agent.yaml` or `docker.io/myorg/agent:latest`.

func (UserAliasOutput) Safety

The safety mode used when running the alias without `--safety`/`--yolo`: `strict`, `balanced`, `restricted` or `autonomous`.

func (UserAliasOutput) Sandbox

func (o UserAliasOutput) Sandbox() pulumi.BoolPtrOutput

Run the alias inside a Docker sandbox by default.

func (UserAliasOutput) ToUserAliasOutput

func (o UserAliasOutput) ToUserAliasOutput() UserAliasOutput

func (UserAliasOutput) ToUserAliasOutputWithContext

func (o UserAliasOutput) ToUserAliasOutputWithContext(ctx context.Context) UserAliasOutput

func (UserAliasOutput) Yolo

Auto-approve every tool call when running the alias. Legacy alias for `safety: autonomous`.

type UserBoard

type UserBoard struct {
	// The board pipeline. When a card moves forward into a column, the column's prompt is sent to the card's agent. Leave it unset to keep the default pipeline (Dev, Review, Push, Done).
	Columns []UserBoardColumn `pulumi:"columns"`
	// The repositories cards can be created against.
	Projects []UserBoardProject `pulumi:"projects"`
}

Configuration of the `docker agent board` Kanban TUI.

type UserBoardArgs

type UserBoardArgs struct {
	// The board pipeline. When a card moves forward into a column, the column's prompt is sent to the card's agent. Leave it unset to keep the default pipeline (Dev, Review, Push, Done).
	Columns UserBoardColumnArrayInput `pulumi:"columns"`
	// The repositories cards can be created against.
	Projects UserBoardProjectArrayInput `pulumi:"projects"`
}

Configuration of the `docker agent board` Kanban TUI.

func (UserBoardArgs) ElementType

func (UserBoardArgs) ElementType() reflect.Type

func (UserBoardArgs) ToUserBoardOutput

func (i UserBoardArgs) ToUserBoardOutput() UserBoardOutput

func (UserBoardArgs) ToUserBoardOutputWithContext

func (i UserBoardArgs) ToUserBoardOutputWithContext(ctx context.Context) UserBoardOutput

func (UserBoardArgs) ToUserBoardPtrOutput

func (i UserBoardArgs) ToUserBoardPtrOutput() UserBoardPtrOutput

func (UserBoardArgs) ToUserBoardPtrOutputWithContext

func (i UserBoardArgs) ToUserBoardPtrOutputWithContext(ctx context.Context) UserBoardPtrOutput

type UserBoardColumn

type UserBoardColumn struct {
	// An emoji shown next to the name.
	Emoji *string `pulumi:"emoji"`
	// The column identifier. Derived from `name` when unset; must be unique.
	Id *string `pulumi:"id"`
	// The display name. Defaults to `id`.
	Name *string `pulumi:"name"`
	// The prompt sent to the card's agent when a card moves into this column.
	Prompt *string `pulumi:"prompt"`
}

A column of the board pipeline. Set `id`, `name` or both.

type UserBoardColumnArgs

type UserBoardColumnArgs struct {
	// An emoji shown next to the name.
	Emoji pulumi.StringPtrInput `pulumi:"emoji"`
	// The column identifier. Derived from `name` when unset; must be unique.
	Id pulumi.StringPtrInput `pulumi:"id"`
	// The display name. Defaults to `id`.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The prompt sent to the card's agent when a card moves into this column.
	Prompt pulumi.StringPtrInput `pulumi:"prompt"`
}

A column of the board pipeline. Set `id`, `name` or both.

func (UserBoardColumnArgs) ElementType

func (UserBoardColumnArgs) ElementType() reflect.Type

func (UserBoardColumnArgs) ToUserBoardColumnOutput

func (i UserBoardColumnArgs) ToUserBoardColumnOutput() UserBoardColumnOutput

func (UserBoardColumnArgs) ToUserBoardColumnOutputWithContext

func (i UserBoardColumnArgs) ToUserBoardColumnOutputWithContext(ctx context.Context) UserBoardColumnOutput

type UserBoardColumnArray

type UserBoardColumnArray []UserBoardColumnInput

func (UserBoardColumnArray) ElementType

func (UserBoardColumnArray) ElementType() reflect.Type

func (UserBoardColumnArray) ToUserBoardColumnArrayOutput

func (i UserBoardColumnArray) ToUserBoardColumnArrayOutput() UserBoardColumnArrayOutput

func (UserBoardColumnArray) ToUserBoardColumnArrayOutputWithContext

func (i UserBoardColumnArray) ToUserBoardColumnArrayOutputWithContext(ctx context.Context) UserBoardColumnArrayOutput

type UserBoardColumnArrayInput

type UserBoardColumnArrayInput interface {
	pulumi.Input

	ToUserBoardColumnArrayOutput() UserBoardColumnArrayOutput
	ToUserBoardColumnArrayOutputWithContext(context.Context) UserBoardColumnArrayOutput
}

UserBoardColumnArrayInput is an input type that accepts UserBoardColumnArray and UserBoardColumnArrayOutput values. You can construct a concrete instance of `UserBoardColumnArrayInput` via:

UserBoardColumnArray{ UserBoardColumnArgs{...} }

type UserBoardColumnArrayOutput

type UserBoardColumnArrayOutput struct{ *pulumi.OutputState }

func (UserBoardColumnArrayOutput) ElementType

func (UserBoardColumnArrayOutput) ElementType() reflect.Type

func (UserBoardColumnArrayOutput) Index

func (UserBoardColumnArrayOutput) ToUserBoardColumnArrayOutput

func (o UserBoardColumnArrayOutput) ToUserBoardColumnArrayOutput() UserBoardColumnArrayOutput

func (UserBoardColumnArrayOutput) ToUserBoardColumnArrayOutputWithContext

func (o UserBoardColumnArrayOutput) ToUserBoardColumnArrayOutputWithContext(ctx context.Context) UserBoardColumnArrayOutput

type UserBoardColumnInput

type UserBoardColumnInput interface {
	pulumi.Input

	ToUserBoardColumnOutput() UserBoardColumnOutput
	ToUserBoardColumnOutputWithContext(context.Context) UserBoardColumnOutput
}

UserBoardColumnInput is an input type that accepts UserBoardColumnArgs and UserBoardColumnOutput values. You can construct a concrete instance of `UserBoardColumnInput` via:

UserBoardColumnArgs{...}

type UserBoardColumnOutput

type UserBoardColumnOutput struct{ *pulumi.OutputState }

A column of the board pipeline. Set `id`, `name` or both.

func (UserBoardColumnOutput) ElementType

func (UserBoardColumnOutput) ElementType() reflect.Type

func (UserBoardColumnOutput) Emoji

An emoji shown next to the name.

func (UserBoardColumnOutput) Id

The column identifier. Derived from `name` when unset; must be unique.

func (UserBoardColumnOutput) Name

The display name. Defaults to `id`.

func (UserBoardColumnOutput) Prompt

The prompt sent to the card's agent when a card moves into this column.

func (UserBoardColumnOutput) ToUserBoardColumnOutput

func (o UserBoardColumnOutput) ToUserBoardColumnOutput() UserBoardColumnOutput

func (UserBoardColumnOutput) ToUserBoardColumnOutputWithContext

func (o UserBoardColumnOutput) ToUserBoardColumnOutputWithContext(ctx context.Context) UserBoardColumnOutput

type UserBoardInput

type UserBoardInput interface {
	pulumi.Input

	ToUserBoardOutput() UserBoardOutput
	ToUserBoardOutputWithContext(context.Context) UserBoardOutput
}

UserBoardInput is an input type that accepts UserBoardArgs and UserBoardOutput values. You can construct a concrete instance of `UserBoardInput` via:

UserBoardArgs{...}

type UserBoardOutput

type UserBoardOutput struct{ *pulumi.OutputState }

Configuration of the `docker agent board` Kanban TUI.

func (UserBoardOutput) Columns

The board pipeline. When a card moves forward into a column, the column's prompt is sent to the card's agent. Leave it unset to keep the default pipeline (Dev, Review, Push, Done).

func (UserBoardOutput) ElementType

func (UserBoardOutput) ElementType() reflect.Type

func (UserBoardOutput) Projects

The repositories cards can be created against.

func (UserBoardOutput) ToUserBoardOutput

func (o UserBoardOutput) ToUserBoardOutput() UserBoardOutput

func (UserBoardOutput) ToUserBoardOutputWithContext

func (o UserBoardOutput) ToUserBoardOutputWithContext(ctx context.Context) UserBoardOutput

func (UserBoardOutput) ToUserBoardPtrOutput

func (o UserBoardOutput) ToUserBoardPtrOutput() UserBoardPtrOutput

func (UserBoardOutput) ToUserBoardPtrOutputWithContext

func (o UserBoardOutput) ToUserBoardPtrOutputWithContext(ctx context.Context) UserBoardPtrOutput

type UserBoardProject

type UserBoardProject struct {
	// The agent reference launched for the project's cards. Defaults to the built-in root agent.
	Agent *string `pulumi:"agent"`
	// The display name shown on cards.
	Name string `pulumi:"name"`
	// The repository's local path.
	Path string `pulumi:"path"`
}

A repository the board can create cards against.

type UserBoardProjectArgs

type UserBoardProjectArgs struct {
	// The agent reference launched for the project's cards. Defaults to the built-in root agent.
	Agent pulumi.StringPtrInput `pulumi:"agent"`
	// The display name shown on cards.
	Name pulumi.StringInput `pulumi:"name"`
	// The repository's local path.
	Path pulumi.StringInput `pulumi:"path"`
}

A repository the board can create cards against.

func (UserBoardProjectArgs) ElementType

func (UserBoardProjectArgs) ElementType() reflect.Type

func (UserBoardProjectArgs) ToUserBoardProjectOutput

func (i UserBoardProjectArgs) ToUserBoardProjectOutput() UserBoardProjectOutput

func (UserBoardProjectArgs) ToUserBoardProjectOutputWithContext

func (i UserBoardProjectArgs) ToUserBoardProjectOutputWithContext(ctx context.Context) UserBoardProjectOutput

type UserBoardProjectArray

type UserBoardProjectArray []UserBoardProjectInput

func (UserBoardProjectArray) ElementType

func (UserBoardProjectArray) ElementType() reflect.Type

func (UserBoardProjectArray) ToUserBoardProjectArrayOutput

func (i UserBoardProjectArray) ToUserBoardProjectArrayOutput() UserBoardProjectArrayOutput

func (UserBoardProjectArray) ToUserBoardProjectArrayOutputWithContext

func (i UserBoardProjectArray) ToUserBoardProjectArrayOutputWithContext(ctx context.Context) UserBoardProjectArrayOutput

type UserBoardProjectArrayInput

type UserBoardProjectArrayInput interface {
	pulumi.Input

	ToUserBoardProjectArrayOutput() UserBoardProjectArrayOutput
	ToUserBoardProjectArrayOutputWithContext(context.Context) UserBoardProjectArrayOutput
}

UserBoardProjectArrayInput is an input type that accepts UserBoardProjectArray and UserBoardProjectArrayOutput values. You can construct a concrete instance of `UserBoardProjectArrayInput` via:

UserBoardProjectArray{ UserBoardProjectArgs{...} }

type UserBoardProjectArrayOutput

type UserBoardProjectArrayOutput struct{ *pulumi.OutputState }

func (UserBoardProjectArrayOutput) ElementType

func (UserBoardProjectArrayOutput) Index

func (UserBoardProjectArrayOutput) ToUserBoardProjectArrayOutput

func (o UserBoardProjectArrayOutput) ToUserBoardProjectArrayOutput() UserBoardProjectArrayOutput

func (UserBoardProjectArrayOutput) ToUserBoardProjectArrayOutputWithContext

func (o UserBoardProjectArrayOutput) ToUserBoardProjectArrayOutputWithContext(ctx context.Context) UserBoardProjectArrayOutput

type UserBoardProjectInput

type UserBoardProjectInput interface {
	pulumi.Input

	ToUserBoardProjectOutput() UserBoardProjectOutput
	ToUserBoardProjectOutputWithContext(context.Context) UserBoardProjectOutput
}

UserBoardProjectInput is an input type that accepts UserBoardProjectArgs and UserBoardProjectOutput values. You can construct a concrete instance of `UserBoardProjectInput` via:

UserBoardProjectArgs{...}

type UserBoardProjectOutput

type UserBoardProjectOutput struct{ *pulumi.OutputState }

A repository the board can create cards against.

func (UserBoardProjectOutput) Agent

The agent reference launched for the project's cards. Defaults to the built-in root agent.

func (UserBoardProjectOutput) ElementType

func (UserBoardProjectOutput) ElementType() reflect.Type

func (UserBoardProjectOutput) Name

The display name shown on cards.

func (UserBoardProjectOutput) Path

The repository's local path.

func (UserBoardProjectOutput) ToUserBoardProjectOutput

func (o UserBoardProjectOutput) ToUserBoardProjectOutput() UserBoardProjectOutput

func (UserBoardProjectOutput) ToUserBoardProjectOutputWithContext

func (o UserBoardProjectOutput) ToUserBoardProjectOutputWithContext(ctx context.Context) UserBoardProjectOutput

type UserBoardPtrInput

type UserBoardPtrInput interface {
	pulumi.Input

	ToUserBoardPtrOutput() UserBoardPtrOutput
	ToUserBoardPtrOutputWithContext(context.Context) UserBoardPtrOutput
}

UserBoardPtrInput is an input type that accepts UserBoardArgs, UserBoardPtr and UserBoardPtrOutput values. You can construct a concrete instance of `UserBoardPtrInput` via:

        UserBoardArgs{...}

or:

        nil

func UserBoardPtr

func UserBoardPtr(v *UserBoardArgs) UserBoardPtrInput

type UserBoardPtrOutput

type UserBoardPtrOutput struct{ *pulumi.OutputState }

func (UserBoardPtrOutput) Columns

The board pipeline. When a card moves forward into a column, the column's prompt is sent to the card's agent. Leave it unset to keep the default pipeline (Dev, Review, Push, Done).

func (UserBoardPtrOutput) Elem

func (UserBoardPtrOutput) ElementType

func (UserBoardPtrOutput) ElementType() reflect.Type

func (UserBoardPtrOutput) Projects

The repositories cards can be created against.

func (UserBoardPtrOutput) ToUserBoardPtrOutput

func (o UserBoardPtrOutput) ToUserBoardPtrOutput() UserBoardPtrOutput

func (UserBoardPtrOutput) ToUserBoardPtrOutputWithContext

func (o UserBoardPtrOutput) ToUserBoardPtrOutputWithContext(ctx context.Context) UserBoardPtrOutput

type UserCredentialHelper

type UserCredentialHelper struct {
	// The command's arguments.
	Args []string `pulumi:"args"`
	// The command to run.
	Command string `pulumi:"command"`
}

An external command that prints a Docker token (`DOCKER_TOKEN`) on stdout, used instead of Docker Desktop's credentials.

type UserCredentialHelperArgs

type UserCredentialHelperArgs struct {
	// The command's arguments.
	Args pulumi.StringArrayInput `pulumi:"args"`
	// The command to run.
	Command pulumi.StringInput `pulumi:"command"`
}

An external command that prints a Docker token (`DOCKER_TOKEN`) on stdout, used instead of Docker Desktop's credentials.

func (UserCredentialHelperArgs) ElementType

func (UserCredentialHelperArgs) ElementType() reflect.Type

func (UserCredentialHelperArgs) ToUserCredentialHelperOutput

func (i UserCredentialHelperArgs) ToUserCredentialHelperOutput() UserCredentialHelperOutput

func (UserCredentialHelperArgs) ToUserCredentialHelperOutputWithContext

func (i UserCredentialHelperArgs) ToUserCredentialHelperOutputWithContext(ctx context.Context) UserCredentialHelperOutput

func (UserCredentialHelperArgs) ToUserCredentialHelperPtrOutput

func (i UserCredentialHelperArgs) ToUserCredentialHelperPtrOutput() UserCredentialHelperPtrOutput

func (UserCredentialHelperArgs) ToUserCredentialHelperPtrOutputWithContext

func (i UserCredentialHelperArgs) ToUserCredentialHelperPtrOutputWithContext(ctx context.Context) UserCredentialHelperPtrOutput

type UserCredentialHelperInput

type UserCredentialHelperInput interface {
	pulumi.Input

	ToUserCredentialHelperOutput() UserCredentialHelperOutput
	ToUserCredentialHelperOutputWithContext(context.Context) UserCredentialHelperOutput
}

UserCredentialHelperInput is an input type that accepts UserCredentialHelperArgs and UserCredentialHelperOutput values. You can construct a concrete instance of `UserCredentialHelperInput` via:

UserCredentialHelperArgs{...}

type UserCredentialHelperOutput

type UserCredentialHelperOutput struct{ *pulumi.OutputState }

An external command that prints a Docker token (`DOCKER_TOKEN`) on stdout, used instead of Docker Desktop's credentials.

func (UserCredentialHelperOutput) Args

The command's arguments.

func (UserCredentialHelperOutput) Command

The command to run.

func (UserCredentialHelperOutput) ElementType

func (UserCredentialHelperOutput) ElementType() reflect.Type

func (UserCredentialHelperOutput) ToUserCredentialHelperOutput

func (o UserCredentialHelperOutput) ToUserCredentialHelperOutput() UserCredentialHelperOutput

func (UserCredentialHelperOutput) ToUserCredentialHelperOutputWithContext

func (o UserCredentialHelperOutput) ToUserCredentialHelperOutputWithContext(ctx context.Context) UserCredentialHelperOutput

func (UserCredentialHelperOutput) ToUserCredentialHelperPtrOutput

func (o UserCredentialHelperOutput) ToUserCredentialHelperPtrOutput() UserCredentialHelperPtrOutput

func (UserCredentialHelperOutput) ToUserCredentialHelperPtrOutputWithContext

func (o UserCredentialHelperOutput) ToUserCredentialHelperPtrOutputWithContext(ctx context.Context) UserCredentialHelperPtrOutput

type UserCredentialHelperPtrInput

type UserCredentialHelperPtrInput interface {
	pulumi.Input

	ToUserCredentialHelperPtrOutput() UserCredentialHelperPtrOutput
	ToUserCredentialHelperPtrOutputWithContext(context.Context) UserCredentialHelperPtrOutput
}

UserCredentialHelperPtrInput is an input type that accepts UserCredentialHelperArgs, UserCredentialHelperPtr and UserCredentialHelperPtrOutput values. You can construct a concrete instance of `UserCredentialHelperPtrInput` via:

        UserCredentialHelperArgs{...}

or:

        nil

type UserCredentialHelperPtrOutput

type UserCredentialHelperPtrOutput struct{ *pulumi.OutputState }

func (UserCredentialHelperPtrOutput) Args

The command's arguments.

func (UserCredentialHelperPtrOutput) Command

The command to run.

func (UserCredentialHelperPtrOutput) Elem

func (UserCredentialHelperPtrOutput) ElementType

func (UserCredentialHelperPtrOutput) ToUserCredentialHelperPtrOutput

func (o UserCredentialHelperPtrOutput) ToUserCredentialHelperPtrOutput() UserCredentialHelperPtrOutput

func (UserCredentialHelperPtrOutput) ToUserCredentialHelperPtrOutputWithContext

func (o UserCredentialHelperPtrOutput) ToUserCredentialHelperPtrOutputWithContext(ctx context.Context) UserCredentialHelperPtrOutput

type UserFederationAuth

type UserFederationAuth struct {
	// The federation rule identifier.
	FederationRuleId string `pulumi:"federationRuleId"`
	// Where the identity token comes from.
	IdentityToken *UserIdentityTokenSource `pulumi:"identityToken"`
	// The organization identifier.
	OrganizationId string `pulumi:"organizationId"`
	// The service account identifier.
	ServiceAccountId *string `pulumi:"serviceAccountId"`
}

Exchanges an external identity token for provider credentials.

type UserFederationAuthArgs

type UserFederationAuthArgs struct {
	// The federation rule identifier.
	FederationRuleId pulumi.StringInput `pulumi:"federationRuleId"`
	// Where the identity token comes from.
	IdentityToken UserIdentityTokenSourcePtrInput `pulumi:"identityToken"`
	// The organization identifier.
	OrganizationId pulumi.StringInput `pulumi:"organizationId"`
	// The service account identifier.
	ServiceAccountId pulumi.StringPtrInput `pulumi:"serviceAccountId"`
}

Exchanges an external identity token for provider credentials.

func (UserFederationAuthArgs) ElementType

func (UserFederationAuthArgs) ElementType() reflect.Type

func (UserFederationAuthArgs) ToUserFederationAuthOutput

func (i UserFederationAuthArgs) ToUserFederationAuthOutput() UserFederationAuthOutput

func (UserFederationAuthArgs) ToUserFederationAuthOutputWithContext

func (i UserFederationAuthArgs) ToUserFederationAuthOutputWithContext(ctx context.Context) UserFederationAuthOutput

func (UserFederationAuthArgs) ToUserFederationAuthPtrOutput

func (i UserFederationAuthArgs) ToUserFederationAuthPtrOutput() UserFederationAuthPtrOutput

func (UserFederationAuthArgs) ToUserFederationAuthPtrOutputWithContext

func (i UserFederationAuthArgs) ToUserFederationAuthPtrOutputWithContext(ctx context.Context) UserFederationAuthPtrOutput

type UserFederationAuthInput

type UserFederationAuthInput interface {
	pulumi.Input

	ToUserFederationAuthOutput() UserFederationAuthOutput
	ToUserFederationAuthOutputWithContext(context.Context) UserFederationAuthOutput
}

UserFederationAuthInput is an input type that accepts UserFederationAuthArgs and UserFederationAuthOutput values. You can construct a concrete instance of `UserFederationAuthInput` via:

UserFederationAuthArgs{...}

type UserFederationAuthOutput

type UserFederationAuthOutput struct{ *pulumi.OutputState }

Exchanges an external identity token for provider credentials.

func (UserFederationAuthOutput) ElementType

func (UserFederationAuthOutput) ElementType() reflect.Type

func (UserFederationAuthOutput) FederationRuleId

func (o UserFederationAuthOutput) FederationRuleId() pulumi.StringOutput

The federation rule identifier.

func (UserFederationAuthOutput) IdentityToken

Where the identity token comes from.

func (UserFederationAuthOutput) OrganizationId

func (o UserFederationAuthOutput) OrganizationId() pulumi.StringOutput

The organization identifier.

func (UserFederationAuthOutput) ServiceAccountId

func (o UserFederationAuthOutput) ServiceAccountId() pulumi.StringPtrOutput

The service account identifier.

func (UserFederationAuthOutput) ToUserFederationAuthOutput

func (o UserFederationAuthOutput) ToUserFederationAuthOutput() UserFederationAuthOutput

func (UserFederationAuthOutput) ToUserFederationAuthOutputWithContext

func (o UserFederationAuthOutput) ToUserFederationAuthOutputWithContext(ctx context.Context) UserFederationAuthOutput

func (UserFederationAuthOutput) ToUserFederationAuthPtrOutput

func (o UserFederationAuthOutput) ToUserFederationAuthPtrOutput() UserFederationAuthPtrOutput

func (UserFederationAuthOutput) ToUserFederationAuthPtrOutputWithContext

func (o UserFederationAuthOutput) ToUserFederationAuthPtrOutputWithContext(ctx context.Context) UserFederationAuthPtrOutput

type UserFederationAuthPtrInput

type UserFederationAuthPtrInput interface {
	pulumi.Input

	ToUserFederationAuthPtrOutput() UserFederationAuthPtrOutput
	ToUserFederationAuthPtrOutputWithContext(context.Context) UserFederationAuthPtrOutput
}

UserFederationAuthPtrInput is an input type that accepts UserFederationAuthArgs, UserFederationAuthPtr and UserFederationAuthPtrOutput values. You can construct a concrete instance of `UserFederationAuthPtrInput` via:

        UserFederationAuthArgs{...}

or:

        nil

type UserFederationAuthPtrOutput

type UserFederationAuthPtrOutput struct{ *pulumi.OutputState }

func (UserFederationAuthPtrOutput) Elem

func (UserFederationAuthPtrOutput) ElementType

func (UserFederationAuthPtrOutput) FederationRuleId

func (o UserFederationAuthPtrOutput) FederationRuleId() pulumi.StringPtrOutput

The federation rule identifier.

func (UserFederationAuthPtrOutput) IdentityToken

Where the identity token comes from.

func (UserFederationAuthPtrOutput) OrganizationId

The organization identifier.

func (UserFederationAuthPtrOutput) ServiceAccountId

func (o UserFederationAuthPtrOutput) ServiceAccountId() pulumi.StringPtrOutput

The service account identifier.

func (UserFederationAuthPtrOutput) ToUserFederationAuthPtrOutput

func (o UserFederationAuthPtrOutput) ToUserFederationAuthPtrOutput() UserFederationAuthPtrOutput

func (UserFederationAuthPtrOutput) ToUserFederationAuthPtrOutputWithContext

func (o UserFederationAuthPtrOutput) ToUserFederationAuthPtrOutputWithContext(ctx context.Context) UserFederationAuthPtrOutput

type UserGlobalSettings

type UserGlobalSettings struct {
	// What happens to a message sent while the agent works (`busy_send_mode`): `steer` (default) injects it into the running turn, `queue` holds it until the turn ends.
	BusySendMode *BusySendMode `pulumi:"busySendMode"`
	// Keep changing context (date, environment info, dynamic prompt files) out of the frozen system prompt and append chronological updates instead, which improves prompt-cache hit rates (`cache_stable_prompts`, default `false`).
	CacheStablePrompts *bool `pulumi:"cacheStablePrompts"`
	// Start sessions with thinking and tool blocks expanded (`expand_thinking`, default `false`).
	ExpandThinking *bool `pulumi:"expandThinking"`
	// Additional `settings:` keys that this provider version does not model, for example settings added by a newer docker-agent. They are written verbatim (snake_case keys) and must not repeat a typed setting.
	Extra map[string]interface{} `pulumi:"extra"`
	// Hide tool call results in the TUI by default (`hide_tool_results`, default `false`). Mirrors `--hide-tool-results` and the Ctrl+O toggle.
	HideToolResults *bool `pulumi:"hideToolResults"`
	// Global lifecycle hooks that run for every agent, in addition to the agent's own hooks, `hooks.d/` drop-ins and `--hook-*` flags.
	Hooks *UserHooks `pulumi:"hooks"`
	// How Esc interrupts a running stream (`interrupt_confirmation`): `always` (default) asks for confirmation, `double-tap` requires pressing Esc twice within a second, `none` interrupts immediately.
	InterruptConfirmation *InterruptConfirmation `pulumi:"interruptConfirmation"`
	// Remapped TUI keyboard shortcuts. docker-agent ignores unknown actions, malformed keys and conflicts with a logged warning; the provider reports them as warnings during preview.
	Keybindings []UserKeybinding `pulumi:"keybindings"`
	// Sidebar position and section visibility of the TUI.
	Layout *UserLayoutSettings `pulumi:"layout"`
	// Make the lean TUI (minimal chrome) the default for interactive runs (`lean`, default `false`).
	Lean *bool `pulumi:"lean"`
	// Global tool permission rules, merged with the permissions of every agent and session. A global deny always wins.
	Permissions *UserPermissions `pulumi:"permissions"`
	// Render images in the TUI with the Kitty graphics protocol (`render_images`, default `true`).
	RenderImages *bool `pulumi:"renderImages"`
	// Restore previously open tabs when the TUI starts (`restore_tabs`, default `false`).
	RestoreTabs *bool `pulumi:"restoreTabs"`
	// The default safety mode for new sessions (`safety`): `strict`, `balanced`, `restricted` or `autonomous`. It beats the safety defaults declared in agent configurations; explicit `--safety`/`--yolo` flags and alias options beat it. Any other value fails docker-agent's config loading, so the provider rejects it.
	Safety *SafetyMode `pulumi:"safety"`
	// Show the ASCII-art startup banner in the TUI (`show_banner`, default `true`).
	ShowBanner *bool `pulumi:"showBanner"`
	// Take automatic shadow-git snapshots at turn boundaries for every agent (`snapshot`, default `false`).
	Snapshot *bool `pulumi:"snapshot"`
	// Play a notification sound when a task succeeds or fails (`sound`, default `false`).
	Sound *bool `pulumi:"sound"`
	// Minimum task duration in seconds before a success sound plays (`sound_threshold`, default `10`). Failures always play.
	SoundThreshold *int `pulumi:"soundThreshold"`
	// Render file-edit diffs side by side instead of unified (`split_diff_view`, default `true`).
	SplitDiffView *bool `pulumi:"splitDiffView"`
	// Maximum display length of tab titles before they are truncated (`tab_title_max_length`, default `20`).
	TabTitleMaxLength *int `pulumi:"tabTitleMaxLength"`
	// The TUI theme (`theme`, default `default`): a built-in theme or `~/.cagent/themes/<name>.yaml`. `auto` follows the terminal background and picks `themeDark` or `themeLight`.
	Theme *string `pulumi:"theme"`
	// The theme used when `theme` is `auto` on a dark terminal (`theme_dark`, default `default`).
	ThemeDark *string `pulumi:"themeDark"`
	// The theme used when `theme` is `auto` on a light terminal (`theme_light`, default `default-light`).
	ThemeLight *string `pulumi:"themeLight"`
	// Warn when a model call after the first one in a session reports no cached input tokens (`warn_on_cache_miss`, default `false`).
	WarnOnCacheMiss *bool `pulumi:"warnOnCacheMiss"`
	// Auto-approve every tool call globally (`YOLO`, default `false`). Legacy alias for `safety: autonomous`; `safety` wins when both are set.
	Yolo *bool `pulumi:"yolo"`
}

The `settings:` block of the docker-agent user configuration: preferences that apply to every agent you run. Every field is optional; unset fields use docker-agent's defaults. See https://docs.docker.com/ai/docker-agent/configuration/user-settings/.

type UserGlobalSettingsArgs

type UserGlobalSettingsArgs struct {
	// What happens to a message sent while the agent works (`busy_send_mode`): `steer` (default) injects it into the running turn, `queue` holds it until the turn ends.
	BusySendMode BusySendModePtrInput `pulumi:"busySendMode"`
	// Keep changing context (date, environment info, dynamic prompt files) out of the frozen system prompt and append chronological updates instead, which improves prompt-cache hit rates (`cache_stable_prompts`, default `false`).
	CacheStablePrompts pulumi.BoolPtrInput `pulumi:"cacheStablePrompts"`
	// Start sessions with thinking and tool blocks expanded (`expand_thinking`, default `false`).
	ExpandThinking pulumi.BoolPtrInput `pulumi:"expandThinking"`
	// Additional `settings:` keys that this provider version does not model, for example settings added by a newer docker-agent. They are written verbatim (snake_case keys) and must not repeat a typed setting.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Hide tool call results in the TUI by default (`hide_tool_results`, default `false`). Mirrors `--hide-tool-results` and the Ctrl+O toggle.
	HideToolResults pulumi.BoolPtrInput `pulumi:"hideToolResults"`
	// Global lifecycle hooks that run for every agent, in addition to the agent's own hooks, `hooks.d/` drop-ins and `--hook-*` flags.
	Hooks UserHooksPtrInput `pulumi:"hooks"`
	// How Esc interrupts a running stream (`interrupt_confirmation`): `always` (default) asks for confirmation, `double-tap` requires pressing Esc twice within a second, `none` interrupts immediately.
	InterruptConfirmation InterruptConfirmationPtrInput `pulumi:"interruptConfirmation"`
	// Remapped TUI keyboard shortcuts. docker-agent ignores unknown actions, malformed keys and conflicts with a logged warning; the provider reports them as warnings during preview.
	Keybindings UserKeybindingArrayInput `pulumi:"keybindings"`
	// Sidebar position and section visibility of the TUI.
	Layout UserLayoutSettingsPtrInput `pulumi:"layout"`
	// Make the lean TUI (minimal chrome) the default for interactive runs (`lean`, default `false`).
	Lean pulumi.BoolPtrInput `pulumi:"lean"`
	// Global tool permission rules, merged with the permissions of every agent and session. A global deny always wins.
	Permissions UserPermissionsPtrInput `pulumi:"permissions"`
	// Render images in the TUI with the Kitty graphics protocol (`render_images`, default `true`).
	RenderImages pulumi.BoolPtrInput `pulumi:"renderImages"`
	// Restore previously open tabs when the TUI starts (`restore_tabs`, default `false`).
	RestoreTabs pulumi.BoolPtrInput `pulumi:"restoreTabs"`
	// The default safety mode for new sessions (`safety`): `strict`, `balanced`, `restricted` or `autonomous`. It beats the safety defaults declared in agent configurations; explicit `--safety`/`--yolo` flags and alias options beat it. Any other value fails docker-agent's config loading, so the provider rejects it.
	Safety SafetyModePtrInput `pulumi:"safety"`
	// Show the ASCII-art startup banner in the TUI (`show_banner`, default `true`).
	ShowBanner pulumi.BoolPtrInput `pulumi:"showBanner"`
	// Take automatic shadow-git snapshots at turn boundaries for every agent (`snapshot`, default `false`).
	Snapshot pulumi.BoolPtrInput `pulumi:"snapshot"`
	// Play a notification sound when a task succeeds or fails (`sound`, default `false`).
	Sound pulumi.BoolPtrInput `pulumi:"sound"`
	// Minimum task duration in seconds before a success sound plays (`sound_threshold`, default `10`). Failures always play.
	SoundThreshold pulumi.IntPtrInput `pulumi:"soundThreshold"`
	// Render file-edit diffs side by side instead of unified (`split_diff_view`, default `true`).
	SplitDiffView pulumi.BoolPtrInput `pulumi:"splitDiffView"`
	// Maximum display length of tab titles before they are truncated (`tab_title_max_length`, default `20`).
	TabTitleMaxLength pulumi.IntPtrInput `pulumi:"tabTitleMaxLength"`
	// The TUI theme (`theme`, default `default`): a built-in theme or `~/.cagent/themes/<name>.yaml`. `auto` follows the terminal background and picks `themeDark` or `themeLight`.
	Theme pulumi.StringPtrInput `pulumi:"theme"`
	// The theme used when `theme` is `auto` on a dark terminal (`theme_dark`, default `default`).
	ThemeDark pulumi.StringPtrInput `pulumi:"themeDark"`
	// The theme used when `theme` is `auto` on a light terminal (`theme_light`, default `default-light`).
	ThemeLight pulumi.StringPtrInput `pulumi:"themeLight"`
	// Warn when a model call after the first one in a session reports no cached input tokens (`warn_on_cache_miss`, default `false`).
	WarnOnCacheMiss pulumi.BoolPtrInput `pulumi:"warnOnCacheMiss"`
	// Auto-approve every tool call globally (`YOLO`, default `false`). Legacy alias for `safety: autonomous`; `safety` wins when both are set.
	Yolo pulumi.BoolPtrInput `pulumi:"yolo"`
}

The `settings:` block of the docker-agent user configuration: preferences that apply to every agent you run. Every field is optional; unset fields use docker-agent's defaults. See https://docs.docker.com/ai/docker-agent/configuration/user-settings/.

func (UserGlobalSettingsArgs) ElementType

func (UserGlobalSettingsArgs) ElementType() reflect.Type

func (UserGlobalSettingsArgs) ToUserGlobalSettingsOutput

func (i UserGlobalSettingsArgs) ToUserGlobalSettingsOutput() UserGlobalSettingsOutput

func (UserGlobalSettingsArgs) ToUserGlobalSettingsOutputWithContext

func (i UserGlobalSettingsArgs) ToUserGlobalSettingsOutputWithContext(ctx context.Context) UserGlobalSettingsOutput

func (UserGlobalSettingsArgs) ToUserGlobalSettingsPtrOutput

func (i UserGlobalSettingsArgs) ToUserGlobalSettingsPtrOutput() UserGlobalSettingsPtrOutput

func (UserGlobalSettingsArgs) ToUserGlobalSettingsPtrOutputWithContext

func (i UserGlobalSettingsArgs) ToUserGlobalSettingsPtrOutputWithContext(ctx context.Context) UserGlobalSettingsPtrOutput

type UserGlobalSettingsInput

type UserGlobalSettingsInput interface {
	pulumi.Input

	ToUserGlobalSettingsOutput() UserGlobalSettingsOutput
	ToUserGlobalSettingsOutputWithContext(context.Context) UserGlobalSettingsOutput
}

UserGlobalSettingsInput is an input type that accepts UserGlobalSettingsArgs and UserGlobalSettingsOutput values. You can construct a concrete instance of `UserGlobalSettingsInput` via:

UserGlobalSettingsArgs{...}

type UserGlobalSettingsOutput

type UserGlobalSettingsOutput struct{ *pulumi.OutputState }

The `settings:` block of the docker-agent user configuration: preferences that apply to every agent you run. Every field is optional; unset fields use docker-agent's defaults. See https://docs.docker.com/ai/docker-agent/configuration/user-settings/.

func (UserGlobalSettingsOutput) BusySendMode

What happens to a message sent while the agent works (`busy_send_mode`): `steer` (default) injects it into the running turn, `queue` holds it until the turn ends.

func (UserGlobalSettingsOutput) CacheStablePrompts

func (o UserGlobalSettingsOutput) CacheStablePrompts() pulumi.BoolPtrOutput

Keep changing context (date, environment info, dynamic prompt files) out of the frozen system prompt and append chronological updates instead, which improves prompt-cache hit rates (`cache_stable_prompts`, default `false`).

func (UserGlobalSettingsOutput) ElementType

func (UserGlobalSettingsOutput) ElementType() reflect.Type

func (UserGlobalSettingsOutput) ExpandThinking

func (o UserGlobalSettingsOutput) ExpandThinking() pulumi.BoolPtrOutput

Start sessions with thinking and tool blocks expanded (`expand_thinking`, default `false`).

func (UserGlobalSettingsOutput) Extra

Additional `settings:` keys that this provider version does not model, for example settings added by a newer docker-agent. They are written verbatim (snake_case keys) and must not repeat a typed setting.

func (UserGlobalSettingsOutput) HideToolResults

func (o UserGlobalSettingsOutput) HideToolResults() pulumi.BoolPtrOutput

Hide tool call results in the TUI by default (`hide_tool_results`, default `false`). Mirrors `--hide-tool-results` and the Ctrl+O toggle.

func (UserGlobalSettingsOutput) Hooks

Global lifecycle hooks that run for every agent, in addition to the agent's own hooks, `hooks.d/` drop-ins and `--hook-*` flags.

func (UserGlobalSettingsOutput) InterruptConfirmation

func (o UserGlobalSettingsOutput) InterruptConfirmation() InterruptConfirmationPtrOutput

How Esc interrupts a running stream (`interrupt_confirmation`): `always` (default) asks for confirmation, `double-tap` requires pressing Esc twice within a second, `none` interrupts immediately.

func (UserGlobalSettingsOutput) Keybindings

Remapped TUI keyboard shortcuts. docker-agent ignores unknown actions, malformed keys and conflicts with a logged warning; the provider reports them as warnings during preview.

func (UserGlobalSettingsOutput) Layout

Sidebar position and section visibility of the TUI.

func (UserGlobalSettingsOutput) Lean

Make the lean TUI (minimal chrome) the default for interactive runs (`lean`, default `false`).

func (UserGlobalSettingsOutput) Permissions

Global tool permission rules, merged with the permissions of every agent and session. A global deny always wins.

func (UserGlobalSettingsOutput) RenderImages

Render images in the TUI with the Kitty graphics protocol (`render_images`, default `true`).

func (UserGlobalSettingsOutput) RestoreTabs

Restore previously open tabs when the TUI starts (`restore_tabs`, default `false`).

func (UserGlobalSettingsOutput) Safety

The default safety mode for new sessions (`safety`): `strict`, `balanced`, `restricted` or `autonomous`. It beats the safety defaults declared in agent configurations; explicit `--safety`/`--yolo` flags and alias options beat it. Any other value fails docker-agent's config loading, so the provider rejects it.

func (UserGlobalSettingsOutput) ShowBanner

Show the ASCII-art startup banner in the TUI (`show_banner`, default `true`).

func (UserGlobalSettingsOutput) Snapshot

Take automatic shadow-git snapshots at turn boundaries for every agent (`snapshot`, default `false`).

func (UserGlobalSettingsOutput) Sound

Play a notification sound when a task succeeds or fails (`sound`, default `false`).

func (UserGlobalSettingsOutput) SoundThreshold

func (o UserGlobalSettingsOutput) SoundThreshold() pulumi.IntPtrOutput

Minimum task duration in seconds before a success sound plays (`sound_threshold`, default `10`). Failures always play.

func (UserGlobalSettingsOutput) SplitDiffView

func (o UserGlobalSettingsOutput) SplitDiffView() pulumi.BoolPtrOutput

Render file-edit diffs side by side instead of unified (`split_diff_view`, default `true`).

func (UserGlobalSettingsOutput) TabTitleMaxLength

func (o UserGlobalSettingsOutput) TabTitleMaxLength() pulumi.IntPtrOutput

Maximum display length of tab titles before they are truncated (`tab_title_max_length`, default `20`).

func (UserGlobalSettingsOutput) Theme

The TUI theme (`theme`, default `default`): a built-in theme or `~/.cagent/themes/<name>.yaml`. `auto` follows the terminal background and picks `themeDark` or `themeLight`.

func (UserGlobalSettingsOutput) ThemeDark

The theme used when `theme` is `auto` on a dark terminal (`theme_dark`, default `default`).

func (UserGlobalSettingsOutput) ThemeLight

The theme used when `theme` is `auto` on a light terminal (`theme_light`, default `default-light`).

func (UserGlobalSettingsOutput) ToUserGlobalSettingsOutput

func (o UserGlobalSettingsOutput) ToUserGlobalSettingsOutput() UserGlobalSettingsOutput

func (UserGlobalSettingsOutput) ToUserGlobalSettingsOutputWithContext

func (o UserGlobalSettingsOutput) ToUserGlobalSettingsOutputWithContext(ctx context.Context) UserGlobalSettingsOutput

func (UserGlobalSettingsOutput) ToUserGlobalSettingsPtrOutput

func (o UserGlobalSettingsOutput) ToUserGlobalSettingsPtrOutput() UserGlobalSettingsPtrOutput

func (UserGlobalSettingsOutput) ToUserGlobalSettingsPtrOutputWithContext

func (o UserGlobalSettingsOutput) ToUserGlobalSettingsPtrOutputWithContext(ctx context.Context) UserGlobalSettingsPtrOutput

func (UserGlobalSettingsOutput) WarnOnCacheMiss

func (o UserGlobalSettingsOutput) WarnOnCacheMiss() pulumi.BoolPtrOutput

Warn when a model call after the first one in a session reports no cached input tokens (`warn_on_cache_miss`, default `false`).

func (UserGlobalSettingsOutput) Yolo

Auto-approve every tool call globally (`YOLO`, default `false`). Legacy alias for `safety: autonomous`; `safety` wins when both are set.

type UserGlobalSettingsPtrInput

type UserGlobalSettingsPtrInput interface {
	pulumi.Input

	ToUserGlobalSettingsPtrOutput() UserGlobalSettingsPtrOutput
	ToUserGlobalSettingsPtrOutputWithContext(context.Context) UserGlobalSettingsPtrOutput
}

UserGlobalSettingsPtrInput is an input type that accepts UserGlobalSettingsArgs, UserGlobalSettingsPtr and UserGlobalSettingsPtrOutput values. You can construct a concrete instance of `UserGlobalSettingsPtrInput` via:

        UserGlobalSettingsArgs{...}

or:

        nil

type UserGlobalSettingsPtrOutput

type UserGlobalSettingsPtrOutput struct{ *pulumi.OutputState }

func (UserGlobalSettingsPtrOutput) BusySendMode

What happens to a message sent while the agent works (`busy_send_mode`): `steer` (default) injects it into the running turn, `queue` holds it until the turn ends.

func (UserGlobalSettingsPtrOutput) CacheStablePrompts

func (o UserGlobalSettingsPtrOutput) CacheStablePrompts() pulumi.BoolPtrOutput

Keep changing context (date, environment info, dynamic prompt files) out of the frozen system prompt and append chronological updates instead, which improves prompt-cache hit rates (`cache_stable_prompts`, default `false`).

func (UserGlobalSettingsPtrOutput) Elem

func (UserGlobalSettingsPtrOutput) ElementType

func (UserGlobalSettingsPtrOutput) ExpandThinking

Start sessions with thinking and tool blocks expanded (`expand_thinking`, default `false`).

func (UserGlobalSettingsPtrOutput) Extra

Additional `settings:` keys that this provider version does not model, for example settings added by a newer docker-agent. They are written verbatim (snake_case keys) and must not repeat a typed setting.

func (UserGlobalSettingsPtrOutput) HideToolResults

func (o UserGlobalSettingsPtrOutput) HideToolResults() pulumi.BoolPtrOutput

Hide tool call results in the TUI by default (`hide_tool_results`, default `false`). Mirrors `--hide-tool-results` and the Ctrl+O toggle.

func (UserGlobalSettingsPtrOutput) Hooks

Global lifecycle hooks that run for every agent, in addition to the agent's own hooks, `hooks.d/` drop-ins and `--hook-*` flags.

func (UserGlobalSettingsPtrOutput) InterruptConfirmation

How Esc interrupts a running stream (`interrupt_confirmation`): `always` (default) asks for confirmation, `double-tap` requires pressing Esc twice within a second, `none` interrupts immediately.

func (UserGlobalSettingsPtrOutput) Keybindings

Remapped TUI keyboard shortcuts. docker-agent ignores unknown actions, malformed keys and conflicts with a logged warning; the provider reports them as warnings during preview.

func (UserGlobalSettingsPtrOutput) Layout

Sidebar position and section visibility of the TUI.

func (UserGlobalSettingsPtrOutput) Lean

Make the lean TUI (minimal chrome) the default for interactive runs (`lean`, default `false`).

func (UserGlobalSettingsPtrOutput) Permissions

Global tool permission rules, merged with the permissions of every agent and session. A global deny always wins.

func (UserGlobalSettingsPtrOutput) RenderImages

Render images in the TUI with the Kitty graphics protocol (`render_images`, default `true`).

func (UserGlobalSettingsPtrOutput) RestoreTabs

Restore previously open tabs when the TUI starts (`restore_tabs`, default `false`).

func (UserGlobalSettingsPtrOutput) Safety

The default safety mode for new sessions (`safety`): `strict`, `balanced`, `restricted` or `autonomous`. It beats the safety defaults declared in agent configurations; explicit `--safety`/`--yolo` flags and alias options beat it. Any other value fails docker-agent's config loading, so the provider rejects it.

func (UserGlobalSettingsPtrOutput) ShowBanner

Show the ASCII-art startup banner in the TUI (`show_banner`, default `true`).

func (UserGlobalSettingsPtrOutput) Snapshot

Take automatic shadow-git snapshots at turn boundaries for every agent (`snapshot`, default `false`).

func (UserGlobalSettingsPtrOutput) Sound

Play a notification sound when a task succeeds or fails (`sound`, default `false`).

func (UserGlobalSettingsPtrOutput) SoundThreshold

func (o UserGlobalSettingsPtrOutput) SoundThreshold() pulumi.IntPtrOutput

Minimum task duration in seconds before a success sound plays (`sound_threshold`, default `10`). Failures always play.

func (UserGlobalSettingsPtrOutput) SplitDiffView

Render file-edit diffs side by side instead of unified (`split_diff_view`, default `true`).

func (UserGlobalSettingsPtrOutput) TabTitleMaxLength

func (o UserGlobalSettingsPtrOutput) TabTitleMaxLength() pulumi.IntPtrOutput

Maximum display length of tab titles before they are truncated (`tab_title_max_length`, default `20`).

func (UserGlobalSettingsPtrOutput) Theme

The TUI theme (`theme`, default `default`): a built-in theme or `~/.cagent/themes/<name>.yaml`. `auto` follows the terminal background and picks `themeDark` or `themeLight`.

func (UserGlobalSettingsPtrOutput) ThemeDark

The theme used when `theme` is `auto` on a dark terminal (`theme_dark`, default `default`).

func (UserGlobalSettingsPtrOutput) ThemeLight

The theme used when `theme` is `auto` on a light terminal (`theme_light`, default `default-light`).

func (UserGlobalSettingsPtrOutput) ToUserGlobalSettingsPtrOutput

func (o UserGlobalSettingsPtrOutput) ToUserGlobalSettingsPtrOutput() UserGlobalSettingsPtrOutput

func (UserGlobalSettingsPtrOutput) ToUserGlobalSettingsPtrOutputWithContext

func (o UserGlobalSettingsPtrOutput) ToUserGlobalSettingsPtrOutputWithContext(ctx context.Context) UserGlobalSettingsPtrOutput

func (UserGlobalSettingsPtrOutput) WarnOnCacheMiss

func (o UserGlobalSettingsPtrOutput) WarnOnCacheMiss() pulumi.BoolPtrOutput

Warn when a model call after the first one in a session reports no cached input tokens (`warn_on_cache_miss`, default `false`).

func (UserGlobalSettingsPtrOutput) Yolo

Auto-approve every tool call globally (`YOLO`, default `false`). Legacy alias for `safety: autonomous`; `safety` wins when both are set.

type UserHook

type UserHook struct {
	// Arguments passed to the hook handler, for example to built-ins.
	Args []string `pulumi:"args"`
	// The shell command (`command` hooks) or the built-in name (`builtin` hooks).
	Command *string `pulumi:"command"`
	// Environment variables added for this hook only. Stored as secrets, since they often carry tokens: `yaml` and `sha256` become secret when they are set.
	Env map[string]string `pulumi:"env"`
	// The evaluator an `evaluator` hook uses.
	Evaluator *string `pulumi:"evaluator"`
	// How a `toolGuard` evaluator hook turns assessments into decisions.
	EvaluatorPolicy *UserHookEvaluatorPolicy `pulumi:"evaluatorPolicy"`
	// The model (`provider/model`) a `model` hook calls.
	Model *string `pulumi:"model"`
	// A label for logs and runtime events.
	Name *string `pulumi:"name"`
	// What a hook failure does: `warn` (default), `ignore` or `block`.
	OnError *HookErrorPolicy `pulumi:"onError"`
	// The prompt template of a `model` hook (Go text/template over the hook input).
	Prompt *string `pulumi:"prompt"`
	// How a `beforeAgentRun`/`afterAgentComplete` evaluator hook routes to agents.
	RoutingPolicy *UserHookRoutingPolicy `pulumi:"routingPolicy"`
	// How a `model` hook's reply is interpreted, for example `pre_tool_use_decision` or `guard_decision`. Empty returns the reply as additional context.
	Schema *string `pulumi:"schema"`
	// Require JSON output and validate it against the event's capabilities.
	StrictOutput *bool `pulumi:"strictOutput"`
	// Overrides the default system message of a `model` hook.
	SystemPrompt *string `pulumi:"systemPrompt"`
	// Execution timeout in seconds (default `60`).
	Timeout *int `pulumi:"timeout"`
	// The hook type: `command` (default) runs `command` in a shell, `builtin` runs the built-in function named by `command` (for example `add_date` or `redact_secrets`), `evaluator` asks a named evaluator, `model` asks an LLM.
	Type *HookType `pulumi:"type"`
	// The working directory of the hook.
	WorkingDir *string `pulumi:"workingDir"`
}

A hook: a shell command, a built-in function, an evaluator or a model call.

func (*UserHook) Defaults

func (val *UserHook) Defaults() *UserHook

Defaults sets the appropriate defaults for UserHook

type UserHookArgs

type UserHookArgs struct {
	// Arguments passed to the hook handler, for example to built-ins.
	Args pulumi.StringArrayInput `pulumi:"args"`
	// The shell command (`command` hooks) or the built-in name (`builtin` hooks).
	Command pulumi.StringPtrInput `pulumi:"command"`
	// Environment variables added for this hook only. Stored as secrets, since they often carry tokens: `yaml` and `sha256` become secret when they are set.
	Env pulumi.StringMapInput `pulumi:"env"`
	// The evaluator an `evaluator` hook uses.
	Evaluator pulumi.StringPtrInput `pulumi:"evaluator"`
	// How a `toolGuard` evaluator hook turns assessments into decisions.
	EvaluatorPolicy UserHookEvaluatorPolicyPtrInput `pulumi:"evaluatorPolicy"`
	// The model (`provider/model`) a `model` hook calls.
	Model pulumi.StringPtrInput `pulumi:"model"`
	// A label for logs and runtime events.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// What a hook failure does: `warn` (default), `ignore` or `block`.
	OnError HookErrorPolicyPtrInput `pulumi:"onError"`
	// The prompt template of a `model` hook (Go text/template over the hook input).
	Prompt pulumi.StringPtrInput `pulumi:"prompt"`
	// How a `beforeAgentRun`/`afterAgentComplete` evaluator hook routes to agents.
	RoutingPolicy UserHookRoutingPolicyPtrInput `pulumi:"routingPolicy"`
	// How a `model` hook's reply is interpreted, for example `pre_tool_use_decision` or `guard_decision`. Empty returns the reply as additional context.
	Schema pulumi.StringPtrInput `pulumi:"schema"`
	// Require JSON output and validate it against the event's capabilities.
	StrictOutput pulumi.BoolPtrInput `pulumi:"strictOutput"`
	// Overrides the default system message of a `model` hook.
	SystemPrompt pulumi.StringPtrInput `pulumi:"systemPrompt"`
	// Execution timeout in seconds (default `60`).
	Timeout pulumi.IntPtrInput `pulumi:"timeout"`
	// The hook type: `command` (default) runs `command` in a shell, `builtin` runs the built-in function named by `command` (for example `add_date` or `redact_secrets`), `evaluator` asks a named evaluator, `model` asks an LLM.
	Type HookTypePtrInput `pulumi:"type"`
	// The working directory of the hook.
	WorkingDir pulumi.StringPtrInput `pulumi:"workingDir"`
}

A hook: a shell command, a built-in function, an evaluator or a model call.

func (*UserHookArgs) Defaults

func (val *UserHookArgs) Defaults() *UserHookArgs

Defaults sets the appropriate defaults for UserHookArgs

func (UserHookArgs) ElementType

func (UserHookArgs) ElementType() reflect.Type

func (UserHookArgs) ToUserHookOutput

func (i UserHookArgs) ToUserHookOutput() UserHookOutput

func (UserHookArgs) ToUserHookOutputWithContext

func (i UserHookArgs) ToUserHookOutputWithContext(ctx context.Context) UserHookOutput

type UserHookArray

type UserHookArray []UserHookInput

func (UserHookArray) ElementType

func (UserHookArray) ElementType() reflect.Type

func (UserHookArray) ToUserHookArrayOutput

func (i UserHookArray) ToUserHookArrayOutput() UserHookArrayOutput

func (UserHookArray) ToUserHookArrayOutputWithContext

func (i UserHookArray) ToUserHookArrayOutputWithContext(ctx context.Context) UserHookArrayOutput

type UserHookArrayInput

type UserHookArrayInput interface {
	pulumi.Input

	ToUserHookArrayOutput() UserHookArrayOutput
	ToUserHookArrayOutputWithContext(context.Context) UserHookArrayOutput
}

UserHookArrayInput is an input type that accepts UserHookArray and UserHookArrayOutput values. You can construct a concrete instance of `UserHookArrayInput` via:

UserHookArray{ UserHookArgs{...} }

type UserHookArrayOutput

type UserHookArrayOutput struct{ *pulumi.OutputState }

func (UserHookArrayOutput) ElementType

func (UserHookArrayOutput) ElementType() reflect.Type

func (UserHookArrayOutput) Index

func (UserHookArrayOutput) ToUserHookArrayOutput

func (o UserHookArrayOutput) ToUserHookArrayOutput() UserHookArrayOutput

func (UserHookArrayOutput) ToUserHookArrayOutputWithContext

func (o UserHookArrayOutput) ToUserHookArrayOutputWithContext(ctx context.Context) UserHookArrayOutput

type UserHookEvaluatorPolicy

type UserHookEvaluatorPolicy struct {
	// Assessment outcome to decision (`allow`, `ask` or `deny`). Boolean evaluators use the keys `true` and `false`.
	Decisions map[string]EvaluatorDecision `pulumi:"decisions"`
	// The decision when the assessment is uncertain: `ask` or `deny`.
	Fallback EvaluatorFallback `pulumi:"fallback"`
	// The lowest probability (greater than 0, at most 1) at which a decision applies.
	MinProbability float64 `pulumi:"minProbability"`
}

Maps an evaluator's assessments to tool-guard decisions.

type UserHookEvaluatorPolicyArgs

type UserHookEvaluatorPolicyArgs struct {
	// Assessment outcome to decision (`allow`, `ask` or `deny`). Boolean evaluators use the keys `true` and `false`.
	Decisions EvaluatorDecisionMapInput `pulumi:"decisions"`
	// The decision when the assessment is uncertain: `ask` or `deny`.
	Fallback EvaluatorFallbackInput `pulumi:"fallback"`
	// The lowest probability (greater than 0, at most 1) at which a decision applies.
	MinProbability pulumi.Float64Input `pulumi:"minProbability"`
}

Maps an evaluator's assessments to tool-guard decisions.

func (UserHookEvaluatorPolicyArgs) ElementType

func (UserHookEvaluatorPolicyArgs) ToUserHookEvaluatorPolicyOutput

func (i UserHookEvaluatorPolicyArgs) ToUserHookEvaluatorPolicyOutput() UserHookEvaluatorPolicyOutput

func (UserHookEvaluatorPolicyArgs) ToUserHookEvaluatorPolicyOutputWithContext

func (i UserHookEvaluatorPolicyArgs) ToUserHookEvaluatorPolicyOutputWithContext(ctx context.Context) UserHookEvaluatorPolicyOutput

func (UserHookEvaluatorPolicyArgs) ToUserHookEvaluatorPolicyPtrOutput

func (i UserHookEvaluatorPolicyArgs) ToUserHookEvaluatorPolicyPtrOutput() UserHookEvaluatorPolicyPtrOutput

func (UserHookEvaluatorPolicyArgs) ToUserHookEvaluatorPolicyPtrOutputWithContext

func (i UserHookEvaluatorPolicyArgs) ToUserHookEvaluatorPolicyPtrOutputWithContext(ctx context.Context) UserHookEvaluatorPolicyPtrOutput

type UserHookEvaluatorPolicyInput

type UserHookEvaluatorPolicyInput interface {
	pulumi.Input

	ToUserHookEvaluatorPolicyOutput() UserHookEvaluatorPolicyOutput
	ToUserHookEvaluatorPolicyOutputWithContext(context.Context) UserHookEvaluatorPolicyOutput
}

UserHookEvaluatorPolicyInput is an input type that accepts UserHookEvaluatorPolicyArgs and UserHookEvaluatorPolicyOutput values. You can construct a concrete instance of `UserHookEvaluatorPolicyInput` via:

UserHookEvaluatorPolicyArgs{...}

type UserHookEvaluatorPolicyOutput

type UserHookEvaluatorPolicyOutput struct{ *pulumi.OutputState }

Maps an evaluator's assessments to tool-guard decisions.

func (UserHookEvaluatorPolicyOutput) Decisions

Assessment outcome to decision (`allow`, `ask` or `deny`). Boolean evaluators use the keys `true` and `false`.

func (UserHookEvaluatorPolicyOutput) ElementType

func (UserHookEvaluatorPolicyOutput) Fallback

The decision when the assessment is uncertain: `ask` or `deny`.

func (UserHookEvaluatorPolicyOutput) MinProbability

The lowest probability (greater than 0, at most 1) at which a decision applies.

func (UserHookEvaluatorPolicyOutput) ToUserHookEvaluatorPolicyOutput

func (o UserHookEvaluatorPolicyOutput) ToUserHookEvaluatorPolicyOutput() UserHookEvaluatorPolicyOutput

func (UserHookEvaluatorPolicyOutput) ToUserHookEvaluatorPolicyOutputWithContext

func (o UserHookEvaluatorPolicyOutput) ToUserHookEvaluatorPolicyOutputWithContext(ctx context.Context) UserHookEvaluatorPolicyOutput

func (UserHookEvaluatorPolicyOutput) ToUserHookEvaluatorPolicyPtrOutput

func (o UserHookEvaluatorPolicyOutput) ToUserHookEvaluatorPolicyPtrOutput() UserHookEvaluatorPolicyPtrOutput

func (UserHookEvaluatorPolicyOutput) ToUserHookEvaluatorPolicyPtrOutputWithContext

func (o UserHookEvaluatorPolicyOutput) ToUserHookEvaluatorPolicyPtrOutputWithContext(ctx context.Context) UserHookEvaluatorPolicyPtrOutput

type UserHookEvaluatorPolicyPtrInput

type UserHookEvaluatorPolicyPtrInput interface {
	pulumi.Input

	ToUserHookEvaluatorPolicyPtrOutput() UserHookEvaluatorPolicyPtrOutput
	ToUserHookEvaluatorPolicyPtrOutputWithContext(context.Context) UserHookEvaluatorPolicyPtrOutput
}

UserHookEvaluatorPolicyPtrInput is an input type that accepts UserHookEvaluatorPolicyArgs, UserHookEvaluatorPolicyPtr and UserHookEvaluatorPolicyPtrOutput values. You can construct a concrete instance of `UserHookEvaluatorPolicyPtrInput` via:

        UserHookEvaluatorPolicyArgs{...}

or:

        nil

type UserHookEvaluatorPolicyPtrOutput

type UserHookEvaluatorPolicyPtrOutput struct{ *pulumi.OutputState }

func (UserHookEvaluatorPolicyPtrOutput) Decisions

Assessment outcome to decision (`allow`, `ask` or `deny`). Boolean evaluators use the keys `true` and `false`.

func (UserHookEvaluatorPolicyPtrOutput) Elem

func (UserHookEvaluatorPolicyPtrOutput) ElementType

func (UserHookEvaluatorPolicyPtrOutput) Fallback

The decision when the assessment is uncertain: `ask` or `deny`.

func (UserHookEvaluatorPolicyPtrOutput) MinProbability

The lowest probability (greater than 0, at most 1) at which a decision applies.

func (UserHookEvaluatorPolicyPtrOutput) ToUserHookEvaluatorPolicyPtrOutput

func (o UserHookEvaluatorPolicyPtrOutput) ToUserHookEvaluatorPolicyPtrOutput() UserHookEvaluatorPolicyPtrOutput

func (UserHookEvaluatorPolicyPtrOutput) ToUserHookEvaluatorPolicyPtrOutputWithContext

func (o UserHookEvaluatorPolicyPtrOutput) ToUserHookEvaluatorPolicyPtrOutputWithContext(ctx context.Context) UserHookEvaluatorPolicyPtrOutput

type UserHookInput

type UserHookInput interface {
	pulumi.Input

	ToUserHookOutput() UserHookOutput
	ToUserHookOutputWithContext(context.Context) UserHookOutput
}

UserHookInput is an input type that accepts UserHookArgs and UserHookOutput values. You can construct a concrete instance of `UserHookInput` via:

UserHookArgs{...}

type UserHookMatcher

type UserHookMatcher struct {
	// The hooks to run when the matcher matches.
	Hooks []UserHook `pulumi:"hooks"`
	// A case-sensitive regular expression over tool names, for example `shell|edit_file`. `*` matches every tool.
	Matcher *string `pulumi:"matcher"`
	// Run this `preToolUse` entry before the approval pipeline, so its deny or ask verdict cannot be bypassed by any safety mode. Only valid on `preToolUse`.
	PreemptYolo *bool `pulumi:"preemptYolo"`
}

Hooks for the tools whose names match `matcher`.

type UserHookMatcherArgs

type UserHookMatcherArgs struct {
	// The hooks to run when the matcher matches.
	Hooks UserHookArrayInput `pulumi:"hooks"`
	// A case-sensitive regular expression over tool names, for example `shell|edit_file`. `*` matches every tool.
	Matcher pulumi.StringPtrInput `pulumi:"matcher"`
	// Run this `preToolUse` entry before the approval pipeline, so its deny or ask verdict cannot be bypassed by any safety mode. Only valid on `preToolUse`.
	PreemptYolo pulumi.BoolPtrInput `pulumi:"preemptYolo"`
}

Hooks for the tools whose names match `matcher`.

func (UserHookMatcherArgs) ElementType

func (UserHookMatcherArgs) ElementType() reflect.Type

func (UserHookMatcherArgs) ToUserHookMatcherOutput

func (i UserHookMatcherArgs) ToUserHookMatcherOutput() UserHookMatcherOutput

func (UserHookMatcherArgs) ToUserHookMatcherOutputWithContext

func (i UserHookMatcherArgs) ToUserHookMatcherOutputWithContext(ctx context.Context) UserHookMatcherOutput

type UserHookMatcherArray

type UserHookMatcherArray []UserHookMatcherInput

func (UserHookMatcherArray) ElementType

func (UserHookMatcherArray) ElementType() reflect.Type

func (UserHookMatcherArray) ToUserHookMatcherArrayOutput

func (i UserHookMatcherArray) ToUserHookMatcherArrayOutput() UserHookMatcherArrayOutput

func (UserHookMatcherArray) ToUserHookMatcherArrayOutputWithContext

func (i UserHookMatcherArray) ToUserHookMatcherArrayOutputWithContext(ctx context.Context) UserHookMatcherArrayOutput

type UserHookMatcherArrayInput

type UserHookMatcherArrayInput interface {
	pulumi.Input

	ToUserHookMatcherArrayOutput() UserHookMatcherArrayOutput
	ToUserHookMatcherArrayOutputWithContext(context.Context) UserHookMatcherArrayOutput
}

UserHookMatcherArrayInput is an input type that accepts UserHookMatcherArray and UserHookMatcherArrayOutput values. You can construct a concrete instance of `UserHookMatcherArrayInput` via:

UserHookMatcherArray{ UserHookMatcherArgs{...} }

type UserHookMatcherArrayOutput

type UserHookMatcherArrayOutput struct{ *pulumi.OutputState }

func (UserHookMatcherArrayOutput) ElementType

func (UserHookMatcherArrayOutput) ElementType() reflect.Type

func (UserHookMatcherArrayOutput) Index

func (UserHookMatcherArrayOutput) ToUserHookMatcherArrayOutput

func (o UserHookMatcherArrayOutput) ToUserHookMatcherArrayOutput() UserHookMatcherArrayOutput

func (UserHookMatcherArrayOutput) ToUserHookMatcherArrayOutputWithContext

func (o UserHookMatcherArrayOutput) ToUserHookMatcherArrayOutputWithContext(ctx context.Context) UserHookMatcherArrayOutput

type UserHookMatcherInput

type UserHookMatcherInput interface {
	pulumi.Input

	ToUserHookMatcherOutput() UserHookMatcherOutput
	ToUserHookMatcherOutputWithContext(context.Context) UserHookMatcherOutput
}

UserHookMatcherInput is an input type that accepts UserHookMatcherArgs and UserHookMatcherOutput values. You can construct a concrete instance of `UserHookMatcherInput` via:

UserHookMatcherArgs{...}

type UserHookMatcherOutput

type UserHookMatcherOutput struct{ *pulumi.OutputState }

Hooks for the tools whose names match `matcher`.

func (UserHookMatcherOutput) ElementType

func (UserHookMatcherOutput) ElementType() reflect.Type

func (UserHookMatcherOutput) Hooks

The hooks to run when the matcher matches.

func (UserHookMatcherOutput) Matcher

A case-sensitive regular expression over tool names, for example `shell|edit_file`. `*` matches every tool.

func (UserHookMatcherOutput) PreemptYolo

func (o UserHookMatcherOutput) PreemptYolo() pulumi.BoolPtrOutput

Run this `preToolUse` entry before the approval pipeline, so its deny or ask verdict cannot be bypassed by any safety mode. Only valid on `preToolUse`.

func (UserHookMatcherOutput) ToUserHookMatcherOutput

func (o UserHookMatcherOutput) ToUserHookMatcherOutput() UserHookMatcherOutput

func (UserHookMatcherOutput) ToUserHookMatcherOutputWithContext

func (o UserHookMatcherOutput) ToUserHookMatcherOutputWithContext(ctx context.Context) UserHookMatcherOutput

type UserHookOutput

type UserHookOutput struct{ *pulumi.OutputState }

A hook: a shell command, a built-in function, an evaluator or a model call.

func (UserHookOutput) Args

Arguments passed to the hook handler, for example to built-ins.

func (UserHookOutput) Command

The shell command (`command` hooks) or the built-in name (`builtin` hooks).

func (UserHookOutput) ElementType

func (UserHookOutput) ElementType() reflect.Type

func (UserHookOutput) Env

Environment variables added for this hook only. Stored as secrets, since they often carry tokens: `yaml` and `sha256` become secret when they are set.

func (UserHookOutput) Evaluator

func (o UserHookOutput) Evaluator() pulumi.StringPtrOutput

The evaluator an `evaluator` hook uses.

func (UserHookOutput) EvaluatorPolicy

How a `toolGuard` evaluator hook turns assessments into decisions.

func (UserHookOutput) Model

The model (`provider/model`) a `model` hook calls.

func (UserHookOutput) Name

A label for logs and runtime events.

func (UserHookOutput) OnError

What a hook failure does: `warn` (default), `ignore` or `block`.

func (UserHookOutput) Prompt

The prompt template of a `model` hook (Go text/template over the hook input).

func (UserHookOutput) RoutingPolicy

How a `beforeAgentRun`/`afterAgentComplete` evaluator hook routes to agents.

func (UserHookOutput) Schema

How a `model` hook's reply is interpreted, for example `pre_tool_use_decision` or `guard_decision`. Empty returns the reply as additional context.

func (UserHookOutput) StrictOutput

func (o UserHookOutput) StrictOutput() pulumi.BoolPtrOutput

Require JSON output and validate it against the event's capabilities.

func (UserHookOutput) SystemPrompt

func (o UserHookOutput) SystemPrompt() pulumi.StringPtrOutput

Overrides the default system message of a `model` hook.

func (UserHookOutput) Timeout

func (o UserHookOutput) Timeout() pulumi.IntPtrOutput

Execution timeout in seconds (default `60`).

func (UserHookOutput) ToUserHookOutput

func (o UserHookOutput) ToUserHookOutput() UserHookOutput

func (UserHookOutput) ToUserHookOutputWithContext

func (o UserHookOutput) ToUserHookOutputWithContext(ctx context.Context) UserHookOutput

func (UserHookOutput) Type

The hook type: `command` (default) runs `command` in a shell, `builtin` runs the built-in function named by `command` (for example `add_date` or `redact_secrets`), `evaluator` asks a named evaluator, `model` asks an LLM.

func (UserHookOutput) WorkingDir

func (o UserHookOutput) WorkingDir() pulumi.StringPtrOutput

The working directory of the hook.

type UserHookRoutingPolicy

type UserHookRoutingPolicy struct {
	// The lowest probability (greater than 0, at most 1) at which a route applies.
	MinProbability float64 `pulumi:"minProbability"`
	// Evaluator choice to agent name.
	Routes map[string]string `pulumi:"routes"`
}

Maps a choice evaluator's outcomes to agents.

type UserHookRoutingPolicyArgs

type UserHookRoutingPolicyArgs struct {
	// The lowest probability (greater than 0, at most 1) at which a route applies.
	MinProbability pulumi.Float64Input `pulumi:"minProbability"`
	// Evaluator choice to agent name.
	Routes pulumi.StringMapInput `pulumi:"routes"`
}

Maps a choice evaluator's outcomes to agents.

func (UserHookRoutingPolicyArgs) ElementType

func (UserHookRoutingPolicyArgs) ElementType() reflect.Type

func (UserHookRoutingPolicyArgs) ToUserHookRoutingPolicyOutput

func (i UserHookRoutingPolicyArgs) ToUserHookRoutingPolicyOutput() UserHookRoutingPolicyOutput

func (UserHookRoutingPolicyArgs) ToUserHookRoutingPolicyOutputWithContext

func (i UserHookRoutingPolicyArgs) ToUserHookRoutingPolicyOutputWithContext(ctx context.Context) UserHookRoutingPolicyOutput

func (UserHookRoutingPolicyArgs) ToUserHookRoutingPolicyPtrOutput

func (i UserHookRoutingPolicyArgs) ToUserHookRoutingPolicyPtrOutput() UserHookRoutingPolicyPtrOutput

func (UserHookRoutingPolicyArgs) ToUserHookRoutingPolicyPtrOutputWithContext

func (i UserHookRoutingPolicyArgs) ToUserHookRoutingPolicyPtrOutputWithContext(ctx context.Context) UserHookRoutingPolicyPtrOutput

type UserHookRoutingPolicyInput

type UserHookRoutingPolicyInput interface {
	pulumi.Input

	ToUserHookRoutingPolicyOutput() UserHookRoutingPolicyOutput
	ToUserHookRoutingPolicyOutputWithContext(context.Context) UserHookRoutingPolicyOutput
}

UserHookRoutingPolicyInput is an input type that accepts UserHookRoutingPolicyArgs and UserHookRoutingPolicyOutput values. You can construct a concrete instance of `UserHookRoutingPolicyInput` via:

UserHookRoutingPolicyArgs{...}

type UserHookRoutingPolicyOutput

type UserHookRoutingPolicyOutput struct{ *pulumi.OutputState }

Maps a choice evaluator's outcomes to agents.

func (UserHookRoutingPolicyOutput) ElementType

func (UserHookRoutingPolicyOutput) MinProbability

The lowest probability (greater than 0, at most 1) at which a route applies.

func (UserHookRoutingPolicyOutput) Routes

Evaluator choice to agent name.

func (UserHookRoutingPolicyOutput) ToUserHookRoutingPolicyOutput

func (o UserHookRoutingPolicyOutput) ToUserHookRoutingPolicyOutput() UserHookRoutingPolicyOutput

func (UserHookRoutingPolicyOutput) ToUserHookRoutingPolicyOutputWithContext

func (o UserHookRoutingPolicyOutput) ToUserHookRoutingPolicyOutputWithContext(ctx context.Context) UserHookRoutingPolicyOutput

func (UserHookRoutingPolicyOutput) ToUserHookRoutingPolicyPtrOutput

func (o UserHookRoutingPolicyOutput) ToUserHookRoutingPolicyPtrOutput() UserHookRoutingPolicyPtrOutput

func (UserHookRoutingPolicyOutput) ToUserHookRoutingPolicyPtrOutputWithContext

func (o UserHookRoutingPolicyOutput) ToUserHookRoutingPolicyPtrOutputWithContext(ctx context.Context) UserHookRoutingPolicyPtrOutput

type UserHookRoutingPolicyPtrInput

type UserHookRoutingPolicyPtrInput interface {
	pulumi.Input

	ToUserHookRoutingPolicyPtrOutput() UserHookRoutingPolicyPtrOutput
	ToUserHookRoutingPolicyPtrOutputWithContext(context.Context) UserHookRoutingPolicyPtrOutput
}

UserHookRoutingPolicyPtrInput is an input type that accepts UserHookRoutingPolicyArgs, UserHookRoutingPolicyPtr and UserHookRoutingPolicyPtrOutput values. You can construct a concrete instance of `UserHookRoutingPolicyPtrInput` via:

        UserHookRoutingPolicyArgs{...}

or:

        nil

type UserHookRoutingPolicyPtrOutput

type UserHookRoutingPolicyPtrOutput struct{ *pulumi.OutputState }

func (UserHookRoutingPolicyPtrOutput) Elem

func (UserHookRoutingPolicyPtrOutput) ElementType

func (UserHookRoutingPolicyPtrOutput) MinProbability

The lowest probability (greater than 0, at most 1) at which a route applies.

func (UserHookRoutingPolicyPtrOutput) Routes

Evaluator choice to agent name.

func (UserHookRoutingPolicyPtrOutput) ToUserHookRoutingPolicyPtrOutput

func (o UserHookRoutingPolicyPtrOutput) ToUserHookRoutingPolicyPtrOutput() UserHookRoutingPolicyPtrOutput

func (UserHookRoutingPolicyPtrOutput) ToUserHookRoutingPolicyPtrOutputWithContext

func (o UserHookRoutingPolicyPtrOutput) ToUserHookRoutingPolicyPtrOutputWithContext(ctx context.Context) UserHookRoutingPolicyPtrOutput

type UserHooks

type UserHooks struct {
	// Run after an agent completes and optionally route to another agent (`after_agent_complete`).
	AfterAgentComplete []UserHook `pulumi:"afterAgentComplete"`
	// Run after a successful compaction (`after_compaction`).
	AfterCompaction []UserHook `pulumi:"afterCompaction"`
	// Run just after each successful model call (`after_llm_call`).
	AfterLlmCall []UserHook `pulumi:"afterLlmCall"`
	// Run once per agent activation and optionally route to another agent (`before_agent_run`).
	BeforeAgentRun []UserHook `pulumi:"beforeAgentRun"`
	// Run immediately before a compaction; hooks can veto it or supply the summary (`before_compaction`).
	BeforeCompaction []UserHook `pulumi:"beforeCompaction"`
	// Run just before each model call (`before_llm_call`).
	BeforeLlmCall []UserHook `pulumi:"beforeLlmCall"`
	// Run when the agent sends a notification (`notification`).
	Notification []UserHook `pulumi:"notification"`
	// Run whenever the active agent changes (`on_agent_switch`).
	OnAgentSwitch []UserHook `pulumi:"onAgentSwitch"`
	// Run when the runtime hits an error during a turn (`on_error`).
	OnError []UserHook `pulumi:"onError"`
	// Run when the agent reaches its `max_iterations` limit (`on_max_iterations`).
	OnMaxIterations []UserHook `pulumi:"onMaxIterations"`
	// Run when the user lets the agent continue past `max_iterations` (`on_session_resume`).
	OnSessionResume []UserHook `pulumi:"onSessionResume"`
	// Run after the approval chain decides on a tool call (`on_tool_approval_decision`).
	OnToolApprovalDecision []UserHook `pulumi:"onToolApprovalDecision"`
	// Run when the agent needs user input (`on_user_input`).
	OnUserInput []UserHook `pulumi:"onUserInput"`
	// Run just before the user would be asked to approve a tool call (`permission_request`). Hooks can allow or deny without prompting.
	PermissionRequest []UserHookMatcher `pulumi:"permissionRequest"`
	// Run after a tool completes, successfully or not (`post_tool_use`).
	PostToolUse []UserHookMatcher `pulumi:"postToolUse"`
	// Run before the session transcript is compacted (`pre_compact`).
	PreCompact []UserHook `pulumi:"preCompact"`
	// Run before a tool executes (`pre_tool_use`). Hooks can block the call or rewrite its arguments.
	PreToolUse []UserHookMatcher `pulumi:"preToolUse"`
	// Check loaded prompt-file instructions before use (`prompt_file_guard`).
	PromptFileGuard []UserHook `pulumi:"promptFileGuard"`
	// Run when a session ends (`session_end`).
	SessionEnd []UserHook `pulumi:"sessionEnd"`
	// Run when a session begins (`session_start`).
	SessionStart []UserHook `pulumi:"sessionStart"`
	// Check raw skill text before it is expanded or delivered (`skill_content_guard`).
	SkillContentGuard []UserHook `pulumi:"skillContentGuard"`
	// Run when the model finishes responding and hands control back (`stop`).
	Stop []UserHook `pulumi:"stop"`
	// Run when a sub-agent finishes (`subagent_stop`).
	SubagentStop []UserHook `pulumi:"subagentStop"`
	// Decide on a tool call before the approval pipeline; the verdict cannot be bypassed by any safety mode (`tool_guard`).
	ToolGuard []UserHookMatcher `pulumi:"toolGuard"`
	// Rewrite tool arguments before the approval pipeline runs (`tool_input_transform`).
	ToolInputTransform []UserHookMatcher `pulumi:"toolInputTransform"`
	// Rewrite a tool's output before it is recorded (`tool_response_transform`).
	ToolResponseTransform []UserHookMatcher `pulumi:"toolResponseTransform"`
	// Run when an agent turn finishes, for any reason (`turn_end`).
	TurnEnd []UserHook `pulumi:"turnEnd"`
	// Run at the start of every agent turn (`turn_start`). Output is added as transient context for that turn.
	TurnStart []UserHook `pulumi:"turnStart"`
	// Run when a queued follow-up message starts a new turn (`user_followup_submit`).
	UserFollowupSubmit []UserHook `pulumi:"userFollowupSubmit"`
	// Run once per user message before the first model call of the turn (`user_prompt_submit`).
	UserPromptSubmit []UserHook `pulumi:"userPromptSubmit"`
	// Run when messages sent while the agent was working are added to the session (`user_steering_messages_submit`).
	UserSteeringMessagesSubmit []UserHook `pulumi:"userSteeringMessagesSubmit"`
	// Run inside a new git worktree created by `docker agent run --worktree` (`worktree_create`).
	WorktreeCreate []UserHook `pulumi:"worktreeCreate"`
}

Global lifecycle hooks, keyed by event. Tool events (`preToolUse`, `postToolUse`, `permissionRequest`, `toolResponseTransform`, `toolInputTransform`, `toolGuard`) take matchers that select tools by name; every other event takes a list of hooks. See https://docs.docker.com/ai/docker-agent/configuration/hooks/.

type UserHooksArgs

type UserHooksArgs struct {
	// Run after an agent completes and optionally route to another agent (`after_agent_complete`).
	AfterAgentComplete UserHookArrayInput `pulumi:"afterAgentComplete"`
	// Run after a successful compaction (`after_compaction`).
	AfterCompaction UserHookArrayInput `pulumi:"afterCompaction"`
	// Run just after each successful model call (`after_llm_call`).
	AfterLlmCall UserHookArrayInput `pulumi:"afterLlmCall"`
	// Run once per agent activation and optionally route to another agent (`before_agent_run`).
	BeforeAgentRun UserHookArrayInput `pulumi:"beforeAgentRun"`
	// Run immediately before a compaction; hooks can veto it or supply the summary (`before_compaction`).
	BeforeCompaction UserHookArrayInput `pulumi:"beforeCompaction"`
	// Run just before each model call (`before_llm_call`).
	BeforeLlmCall UserHookArrayInput `pulumi:"beforeLlmCall"`
	// Run when the agent sends a notification (`notification`).
	Notification UserHookArrayInput `pulumi:"notification"`
	// Run whenever the active agent changes (`on_agent_switch`).
	OnAgentSwitch UserHookArrayInput `pulumi:"onAgentSwitch"`
	// Run when the runtime hits an error during a turn (`on_error`).
	OnError UserHookArrayInput `pulumi:"onError"`
	// Run when the agent reaches its `max_iterations` limit (`on_max_iterations`).
	OnMaxIterations UserHookArrayInput `pulumi:"onMaxIterations"`
	// Run when the user lets the agent continue past `max_iterations` (`on_session_resume`).
	OnSessionResume UserHookArrayInput `pulumi:"onSessionResume"`
	// Run after the approval chain decides on a tool call (`on_tool_approval_decision`).
	OnToolApprovalDecision UserHookArrayInput `pulumi:"onToolApprovalDecision"`
	// Run when the agent needs user input (`on_user_input`).
	OnUserInput UserHookArrayInput `pulumi:"onUserInput"`
	// Run just before the user would be asked to approve a tool call (`permission_request`). Hooks can allow or deny without prompting.
	PermissionRequest UserHookMatcherArrayInput `pulumi:"permissionRequest"`
	// Run after a tool completes, successfully or not (`post_tool_use`).
	PostToolUse UserHookMatcherArrayInput `pulumi:"postToolUse"`
	// Run before the session transcript is compacted (`pre_compact`).
	PreCompact UserHookArrayInput `pulumi:"preCompact"`
	// Run before a tool executes (`pre_tool_use`). Hooks can block the call or rewrite its arguments.
	PreToolUse UserHookMatcherArrayInput `pulumi:"preToolUse"`
	// Check loaded prompt-file instructions before use (`prompt_file_guard`).
	PromptFileGuard UserHookArrayInput `pulumi:"promptFileGuard"`
	// Run when a session ends (`session_end`).
	SessionEnd UserHookArrayInput `pulumi:"sessionEnd"`
	// Run when a session begins (`session_start`).
	SessionStart UserHookArrayInput `pulumi:"sessionStart"`
	// Check raw skill text before it is expanded or delivered (`skill_content_guard`).
	SkillContentGuard UserHookArrayInput `pulumi:"skillContentGuard"`
	// Run when the model finishes responding and hands control back (`stop`).
	Stop UserHookArrayInput `pulumi:"stop"`
	// Run when a sub-agent finishes (`subagent_stop`).
	SubagentStop UserHookArrayInput `pulumi:"subagentStop"`
	// Decide on a tool call before the approval pipeline; the verdict cannot be bypassed by any safety mode (`tool_guard`).
	ToolGuard UserHookMatcherArrayInput `pulumi:"toolGuard"`
	// Rewrite tool arguments before the approval pipeline runs (`tool_input_transform`).
	ToolInputTransform UserHookMatcherArrayInput `pulumi:"toolInputTransform"`
	// Rewrite a tool's output before it is recorded (`tool_response_transform`).
	ToolResponseTransform UserHookMatcherArrayInput `pulumi:"toolResponseTransform"`
	// Run when an agent turn finishes, for any reason (`turn_end`).
	TurnEnd UserHookArrayInput `pulumi:"turnEnd"`
	// Run at the start of every agent turn (`turn_start`). Output is added as transient context for that turn.
	TurnStart UserHookArrayInput `pulumi:"turnStart"`
	// Run when a queued follow-up message starts a new turn (`user_followup_submit`).
	UserFollowupSubmit UserHookArrayInput `pulumi:"userFollowupSubmit"`
	// Run once per user message before the first model call of the turn (`user_prompt_submit`).
	UserPromptSubmit UserHookArrayInput `pulumi:"userPromptSubmit"`
	// Run when messages sent while the agent was working are added to the session (`user_steering_messages_submit`).
	UserSteeringMessagesSubmit UserHookArrayInput `pulumi:"userSteeringMessagesSubmit"`
	// Run inside a new git worktree created by `docker agent run --worktree` (`worktree_create`).
	WorktreeCreate UserHookArrayInput `pulumi:"worktreeCreate"`
}

Global lifecycle hooks, keyed by event. Tool events (`preToolUse`, `postToolUse`, `permissionRequest`, `toolResponseTransform`, `toolInputTransform`, `toolGuard`) take matchers that select tools by name; every other event takes a list of hooks. See https://docs.docker.com/ai/docker-agent/configuration/hooks/.

func (UserHooksArgs) ElementType

func (UserHooksArgs) ElementType() reflect.Type

func (UserHooksArgs) ToUserHooksOutput

func (i UserHooksArgs) ToUserHooksOutput() UserHooksOutput

func (UserHooksArgs) ToUserHooksOutputWithContext

func (i UserHooksArgs) ToUserHooksOutputWithContext(ctx context.Context) UserHooksOutput

func (UserHooksArgs) ToUserHooksPtrOutput

func (i UserHooksArgs) ToUserHooksPtrOutput() UserHooksPtrOutput

func (UserHooksArgs) ToUserHooksPtrOutputWithContext

func (i UserHooksArgs) ToUserHooksPtrOutputWithContext(ctx context.Context) UserHooksPtrOutput

type UserHooksInput

type UserHooksInput interface {
	pulumi.Input

	ToUserHooksOutput() UserHooksOutput
	ToUserHooksOutputWithContext(context.Context) UserHooksOutput
}

UserHooksInput is an input type that accepts UserHooksArgs and UserHooksOutput values. You can construct a concrete instance of `UserHooksInput` via:

UserHooksArgs{...}

type UserHooksOutput

type UserHooksOutput struct{ *pulumi.OutputState }

Global lifecycle hooks, keyed by event. Tool events (`preToolUse`, `postToolUse`, `permissionRequest`, `toolResponseTransform`, `toolInputTransform`, `toolGuard`) take matchers that select tools by name; every other event takes a list of hooks. See https://docs.docker.com/ai/docker-agent/configuration/hooks/.

func (UserHooksOutput) AfterAgentComplete

func (o UserHooksOutput) AfterAgentComplete() UserHookArrayOutput

Run after an agent completes and optionally route to another agent (`after_agent_complete`).

func (UserHooksOutput) AfterCompaction

func (o UserHooksOutput) AfterCompaction() UserHookArrayOutput

Run after a successful compaction (`after_compaction`).

func (UserHooksOutput) AfterLlmCall

func (o UserHooksOutput) AfterLlmCall() UserHookArrayOutput

Run just after each successful model call (`after_llm_call`).

func (UserHooksOutput) BeforeAgentRun

func (o UserHooksOutput) BeforeAgentRun() UserHookArrayOutput

Run once per agent activation and optionally route to another agent (`before_agent_run`).

func (UserHooksOutput) BeforeCompaction

func (o UserHooksOutput) BeforeCompaction() UserHookArrayOutput

Run immediately before a compaction; hooks can veto it or supply the summary (`before_compaction`).

func (UserHooksOutput) BeforeLlmCall

func (o UserHooksOutput) BeforeLlmCall() UserHookArrayOutput

Run just before each model call (`before_llm_call`).

func (UserHooksOutput) ElementType

func (UserHooksOutput) ElementType() reflect.Type

func (UserHooksOutput) Notification

func (o UserHooksOutput) Notification() UserHookArrayOutput

Run when the agent sends a notification (`notification`).

func (UserHooksOutput) OnAgentSwitch

func (o UserHooksOutput) OnAgentSwitch() UserHookArrayOutput

Run whenever the active agent changes (`on_agent_switch`).

func (UserHooksOutput) OnError

Run when the runtime hits an error during a turn (`on_error`).

func (UserHooksOutput) OnMaxIterations

func (o UserHooksOutput) OnMaxIterations() UserHookArrayOutput

Run when the agent reaches its `max_iterations` limit (`on_max_iterations`).

func (UserHooksOutput) OnSessionResume

func (o UserHooksOutput) OnSessionResume() UserHookArrayOutput

Run when the user lets the agent continue past `max_iterations` (`on_session_resume`).

func (UserHooksOutput) OnToolApprovalDecision

func (o UserHooksOutput) OnToolApprovalDecision() UserHookArrayOutput

Run after the approval chain decides on a tool call (`on_tool_approval_decision`).

func (UserHooksOutput) OnUserInput

func (o UserHooksOutput) OnUserInput() UserHookArrayOutput

Run when the agent needs user input (`on_user_input`).

func (UserHooksOutput) PermissionRequest

func (o UserHooksOutput) PermissionRequest() UserHookMatcherArrayOutput

Run just before the user would be asked to approve a tool call (`permission_request`). Hooks can allow or deny without prompting.

func (UserHooksOutput) PostToolUse

Run after a tool completes, successfully or not (`post_tool_use`).

func (UserHooksOutput) PreCompact

func (o UserHooksOutput) PreCompact() UserHookArrayOutput

Run before the session transcript is compacted (`pre_compact`).

func (UserHooksOutput) PreToolUse

Run before a tool executes (`pre_tool_use`). Hooks can block the call or rewrite its arguments.

func (UserHooksOutput) PromptFileGuard

func (o UserHooksOutput) PromptFileGuard() UserHookArrayOutput

Check loaded prompt-file instructions before use (`prompt_file_guard`).

func (UserHooksOutput) SessionEnd

func (o UserHooksOutput) SessionEnd() UserHookArrayOutput

Run when a session ends (`session_end`).

func (UserHooksOutput) SessionStart

func (o UserHooksOutput) SessionStart() UserHookArrayOutput

Run when a session begins (`session_start`).

func (UserHooksOutput) SkillContentGuard

func (o UserHooksOutput) SkillContentGuard() UserHookArrayOutput

Check raw skill text before it is expanded or delivered (`skill_content_guard`).

func (UserHooksOutput) Stop

Run when the model finishes responding and hands control back (`stop`).

func (UserHooksOutput) SubagentStop

func (o UserHooksOutput) SubagentStop() UserHookArrayOutput

Run when a sub-agent finishes (`subagent_stop`).

func (UserHooksOutput) ToUserHooksOutput

func (o UserHooksOutput) ToUserHooksOutput() UserHooksOutput

func (UserHooksOutput) ToUserHooksOutputWithContext

func (o UserHooksOutput) ToUserHooksOutputWithContext(ctx context.Context) UserHooksOutput

func (UserHooksOutput) ToUserHooksPtrOutput

func (o UserHooksOutput) ToUserHooksPtrOutput() UserHooksPtrOutput

func (UserHooksOutput) ToUserHooksPtrOutputWithContext

func (o UserHooksOutput) ToUserHooksPtrOutputWithContext(ctx context.Context) UserHooksPtrOutput

func (UserHooksOutput) ToolGuard

Decide on a tool call before the approval pipeline; the verdict cannot be bypassed by any safety mode (`tool_guard`).

func (UserHooksOutput) ToolInputTransform

func (o UserHooksOutput) ToolInputTransform() UserHookMatcherArrayOutput

Rewrite tool arguments before the approval pipeline runs (`tool_input_transform`).

func (UserHooksOutput) ToolResponseTransform

func (o UserHooksOutput) ToolResponseTransform() UserHookMatcherArrayOutput

Rewrite a tool's output before it is recorded (`tool_response_transform`).

func (UserHooksOutput) TurnEnd

Run when an agent turn finishes, for any reason (`turn_end`).

func (UserHooksOutput) TurnStart

func (o UserHooksOutput) TurnStart() UserHookArrayOutput

Run at the start of every agent turn (`turn_start`). Output is added as transient context for that turn.

func (UserHooksOutput) UserFollowupSubmit

func (o UserHooksOutput) UserFollowupSubmit() UserHookArrayOutput

Run when a queued follow-up message starts a new turn (`user_followup_submit`).

func (UserHooksOutput) UserPromptSubmit

func (o UserHooksOutput) UserPromptSubmit() UserHookArrayOutput

Run once per user message before the first model call of the turn (`user_prompt_submit`).

func (UserHooksOutput) UserSteeringMessagesSubmit

func (o UserHooksOutput) UserSteeringMessagesSubmit() UserHookArrayOutput

Run when messages sent while the agent was working are added to the session (`user_steering_messages_submit`).

func (UserHooksOutput) WorktreeCreate

func (o UserHooksOutput) WorktreeCreate() UserHookArrayOutput

Run inside a new git worktree created by `docker agent run --worktree` (`worktree_create`).

type UserHooksPtrInput

type UserHooksPtrInput interface {
	pulumi.Input

	ToUserHooksPtrOutput() UserHooksPtrOutput
	ToUserHooksPtrOutputWithContext(context.Context) UserHooksPtrOutput
}

UserHooksPtrInput is an input type that accepts UserHooksArgs, UserHooksPtr and UserHooksPtrOutput values. You can construct a concrete instance of `UserHooksPtrInput` via:

        UserHooksArgs{...}

or:

        nil

func UserHooksPtr

func UserHooksPtr(v *UserHooksArgs) UserHooksPtrInput

type UserHooksPtrOutput

type UserHooksPtrOutput struct{ *pulumi.OutputState }

func (UserHooksPtrOutput) AfterAgentComplete

func (o UserHooksPtrOutput) AfterAgentComplete() UserHookArrayOutput

Run after an agent completes and optionally route to another agent (`after_agent_complete`).

func (UserHooksPtrOutput) AfterCompaction

func (o UserHooksPtrOutput) AfterCompaction() UserHookArrayOutput

Run after a successful compaction (`after_compaction`).

func (UserHooksPtrOutput) AfterLlmCall

func (o UserHooksPtrOutput) AfterLlmCall() UserHookArrayOutput

Run just after each successful model call (`after_llm_call`).

func (UserHooksPtrOutput) BeforeAgentRun

func (o UserHooksPtrOutput) BeforeAgentRun() UserHookArrayOutput

Run once per agent activation and optionally route to another agent (`before_agent_run`).

func (UserHooksPtrOutput) BeforeCompaction

func (o UserHooksPtrOutput) BeforeCompaction() UserHookArrayOutput

Run immediately before a compaction; hooks can veto it or supply the summary (`before_compaction`).

func (UserHooksPtrOutput) BeforeLlmCall

func (o UserHooksPtrOutput) BeforeLlmCall() UserHookArrayOutput

Run just before each model call (`before_llm_call`).

func (UserHooksPtrOutput) Elem

func (UserHooksPtrOutput) ElementType

func (UserHooksPtrOutput) ElementType() reflect.Type

func (UserHooksPtrOutput) Notification

func (o UserHooksPtrOutput) Notification() UserHookArrayOutput

Run when the agent sends a notification (`notification`).

func (UserHooksPtrOutput) OnAgentSwitch

func (o UserHooksPtrOutput) OnAgentSwitch() UserHookArrayOutput

Run whenever the active agent changes (`on_agent_switch`).

func (UserHooksPtrOutput) OnError

Run when the runtime hits an error during a turn (`on_error`).

func (UserHooksPtrOutput) OnMaxIterations

func (o UserHooksPtrOutput) OnMaxIterations() UserHookArrayOutput

Run when the agent reaches its `max_iterations` limit (`on_max_iterations`).

func (UserHooksPtrOutput) OnSessionResume

func (o UserHooksPtrOutput) OnSessionResume() UserHookArrayOutput

Run when the user lets the agent continue past `max_iterations` (`on_session_resume`).

func (UserHooksPtrOutput) OnToolApprovalDecision

func (o UserHooksPtrOutput) OnToolApprovalDecision() UserHookArrayOutput

Run after the approval chain decides on a tool call (`on_tool_approval_decision`).

func (UserHooksPtrOutput) OnUserInput

func (o UserHooksPtrOutput) OnUserInput() UserHookArrayOutput

Run when the agent needs user input (`on_user_input`).

func (UserHooksPtrOutput) PermissionRequest

func (o UserHooksPtrOutput) PermissionRequest() UserHookMatcherArrayOutput

Run just before the user would be asked to approve a tool call (`permission_request`). Hooks can allow or deny without prompting.

func (UserHooksPtrOutput) PostToolUse

Run after a tool completes, successfully or not (`post_tool_use`).

func (UserHooksPtrOutput) PreCompact

func (o UserHooksPtrOutput) PreCompact() UserHookArrayOutput

Run before the session transcript is compacted (`pre_compact`).

func (UserHooksPtrOutput) PreToolUse

Run before a tool executes (`pre_tool_use`). Hooks can block the call or rewrite its arguments.

func (UserHooksPtrOutput) PromptFileGuard

func (o UserHooksPtrOutput) PromptFileGuard() UserHookArrayOutput

Check loaded prompt-file instructions before use (`prompt_file_guard`).

func (UserHooksPtrOutput) SessionEnd

func (o UserHooksPtrOutput) SessionEnd() UserHookArrayOutput

Run when a session ends (`session_end`).

func (UserHooksPtrOutput) SessionStart

func (o UserHooksPtrOutput) SessionStart() UserHookArrayOutput

Run when a session begins (`session_start`).

func (UserHooksPtrOutput) SkillContentGuard

func (o UserHooksPtrOutput) SkillContentGuard() UserHookArrayOutput

Check raw skill text before it is expanded or delivered (`skill_content_guard`).

func (UserHooksPtrOutput) Stop

Run when the model finishes responding and hands control back (`stop`).

func (UserHooksPtrOutput) SubagentStop

func (o UserHooksPtrOutput) SubagentStop() UserHookArrayOutput

Run when a sub-agent finishes (`subagent_stop`).

func (UserHooksPtrOutput) ToUserHooksPtrOutput

func (o UserHooksPtrOutput) ToUserHooksPtrOutput() UserHooksPtrOutput

func (UserHooksPtrOutput) ToUserHooksPtrOutputWithContext

func (o UserHooksPtrOutput) ToUserHooksPtrOutputWithContext(ctx context.Context) UserHooksPtrOutput

func (UserHooksPtrOutput) ToolGuard

Decide on a tool call before the approval pipeline; the verdict cannot be bypassed by any safety mode (`tool_guard`).

func (UserHooksPtrOutput) ToolInputTransform

func (o UserHooksPtrOutput) ToolInputTransform() UserHookMatcherArrayOutput

Rewrite tool arguments before the approval pipeline runs (`tool_input_transform`).

func (UserHooksPtrOutput) ToolResponseTransform

func (o UserHooksPtrOutput) ToolResponseTransform() UserHookMatcherArrayOutput

Rewrite a tool's output before it is recorded (`tool_response_transform`).

func (UserHooksPtrOutput) TurnEnd

Run when an agent turn finishes, for any reason (`turn_end`).

func (UserHooksPtrOutput) TurnStart

Run at the start of every agent turn (`turn_start`). Output is added as transient context for that turn.

func (UserHooksPtrOutput) UserFollowupSubmit

func (o UserHooksPtrOutput) UserFollowupSubmit() UserHookArrayOutput

Run when a queued follow-up message starts a new turn (`user_followup_submit`).

func (UserHooksPtrOutput) UserPromptSubmit

func (o UserHooksPtrOutput) UserPromptSubmit() UserHookArrayOutput

Run once per user message before the first model call of the turn (`user_prompt_submit`).

func (UserHooksPtrOutput) UserSteeringMessagesSubmit

func (o UserHooksPtrOutput) UserSteeringMessagesSubmit() UserHookArrayOutput

Run when messages sent while the agent was working are added to the session (`user_steering_messages_submit`).

func (UserHooksPtrOutput) WorktreeCreate

func (o UserHooksPtrOutput) WorktreeCreate() UserHookArrayOutput

Run inside a new git worktree created by `docker agent run --worktree` (`worktree_create`).

type UserIdentityTokenSource

type UserIdentityTokenSource struct {
	// Run this command (argv form) and read the token from stdout.
	Command []string `pulumi:"command"`
	// Read the token from this environment variable.
	Env *string `pulumi:"env"`
	// Read the token from this file.
	File *string `pulumi:"file"`
	// HTTP headers sent with the `url` request. Stored as secrets, since they usually carry credentials: `yaml` and `sha256` become secret when they are set.
	Headers map[string]string `pulumi:"headers"`
	// The JSON field of the `url` response that holds the token.
	ResponseField *string `pulumi:"responseField"`
	// Fetch the token from this URL.
	Url *string `pulumi:"url"`
}

The source of an identity token. Set one of `file`, `env`, `command` or `url`.

type UserIdentityTokenSourceArgs

type UserIdentityTokenSourceArgs struct {
	// Run this command (argv form) and read the token from stdout.
	Command pulumi.StringArrayInput `pulumi:"command"`
	// Read the token from this environment variable.
	Env pulumi.StringPtrInput `pulumi:"env"`
	// Read the token from this file.
	File pulumi.StringPtrInput `pulumi:"file"`
	// HTTP headers sent with the `url` request. Stored as secrets, since they usually carry credentials: `yaml` and `sha256` become secret when they are set.
	Headers pulumi.StringMapInput `pulumi:"headers"`
	// The JSON field of the `url` response that holds the token.
	ResponseField pulumi.StringPtrInput `pulumi:"responseField"`
	// Fetch the token from this URL.
	Url pulumi.StringPtrInput `pulumi:"url"`
}

The source of an identity token. Set one of `file`, `env`, `command` or `url`.

func (UserIdentityTokenSourceArgs) ElementType

func (UserIdentityTokenSourceArgs) ToUserIdentityTokenSourceOutput

func (i UserIdentityTokenSourceArgs) ToUserIdentityTokenSourceOutput() UserIdentityTokenSourceOutput

func (UserIdentityTokenSourceArgs) ToUserIdentityTokenSourceOutputWithContext

func (i UserIdentityTokenSourceArgs) ToUserIdentityTokenSourceOutputWithContext(ctx context.Context) UserIdentityTokenSourceOutput

func (UserIdentityTokenSourceArgs) ToUserIdentityTokenSourcePtrOutput

func (i UserIdentityTokenSourceArgs) ToUserIdentityTokenSourcePtrOutput() UserIdentityTokenSourcePtrOutput

func (UserIdentityTokenSourceArgs) ToUserIdentityTokenSourcePtrOutputWithContext

func (i UserIdentityTokenSourceArgs) ToUserIdentityTokenSourcePtrOutputWithContext(ctx context.Context) UserIdentityTokenSourcePtrOutput

type UserIdentityTokenSourceInput

type UserIdentityTokenSourceInput interface {
	pulumi.Input

	ToUserIdentityTokenSourceOutput() UserIdentityTokenSourceOutput
	ToUserIdentityTokenSourceOutputWithContext(context.Context) UserIdentityTokenSourceOutput
}

UserIdentityTokenSourceInput is an input type that accepts UserIdentityTokenSourceArgs and UserIdentityTokenSourceOutput values. You can construct a concrete instance of `UserIdentityTokenSourceInput` via:

UserIdentityTokenSourceArgs{...}

type UserIdentityTokenSourceOutput

type UserIdentityTokenSourceOutput struct{ *pulumi.OutputState }

The source of an identity token. Set one of `file`, `env`, `command` or `url`.

func (UserIdentityTokenSourceOutput) Command

Run this command (argv form) and read the token from stdout.

func (UserIdentityTokenSourceOutput) ElementType

func (UserIdentityTokenSourceOutput) Env

Read the token from this environment variable.

func (UserIdentityTokenSourceOutput) File

Read the token from this file.

func (UserIdentityTokenSourceOutput) Headers

HTTP headers sent with the `url` request. Stored as secrets, since they usually carry credentials: `yaml` and `sha256` become secret when they are set.

func (UserIdentityTokenSourceOutput) ResponseField

The JSON field of the `url` response that holds the token.

func (UserIdentityTokenSourceOutput) ToUserIdentityTokenSourceOutput

func (o UserIdentityTokenSourceOutput) ToUserIdentityTokenSourceOutput() UserIdentityTokenSourceOutput

func (UserIdentityTokenSourceOutput) ToUserIdentityTokenSourceOutputWithContext

func (o UserIdentityTokenSourceOutput) ToUserIdentityTokenSourceOutputWithContext(ctx context.Context) UserIdentityTokenSourceOutput

func (UserIdentityTokenSourceOutput) ToUserIdentityTokenSourcePtrOutput

func (o UserIdentityTokenSourceOutput) ToUserIdentityTokenSourcePtrOutput() UserIdentityTokenSourcePtrOutput

func (UserIdentityTokenSourceOutput) ToUserIdentityTokenSourcePtrOutputWithContext

func (o UserIdentityTokenSourceOutput) ToUserIdentityTokenSourcePtrOutputWithContext(ctx context.Context) UserIdentityTokenSourcePtrOutput

func (UserIdentityTokenSourceOutput) Url

Fetch the token from this URL.

type UserIdentityTokenSourcePtrInput

type UserIdentityTokenSourcePtrInput interface {
	pulumi.Input

	ToUserIdentityTokenSourcePtrOutput() UserIdentityTokenSourcePtrOutput
	ToUserIdentityTokenSourcePtrOutputWithContext(context.Context) UserIdentityTokenSourcePtrOutput
}

UserIdentityTokenSourcePtrInput is an input type that accepts UserIdentityTokenSourceArgs, UserIdentityTokenSourcePtr and UserIdentityTokenSourcePtrOutput values. You can construct a concrete instance of `UserIdentityTokenSourcePtrInput` via:

        UserIdentityTokenSourceArgs{...}

or:

        nil

type UserIdentityTokenSourcePtrOutput

type UserIdentityTokenSourcePtrOutput struct{ *pulumi.OutputState }

func (UserIdentityTokenSourcePtrOutput) Command

Run this command (argv form) and read the token from stdout.

func (UserIdentityTokenSourcePtrOutput) Elem

func (UserIdentityTokenSourcePtrOutput) ElementType

func (UserIdentityTokenSourcePtrOutput) Env

Read the token from this environment variable.

func (UserIdentityTokenSourcePtrOutput) File

Read the token from this file.

func (UserIdentityTokenSourcePtrOutput) Headers

HTTP headers sent with the `url` request. Stored as secrets, since they usually carry credentials: `yaml` and `sha256` become secret when they are set.

func (UserIdentityTokenSourcePtrOutput) ResponseField

The JSON field of the `url` response that holds the token.

func (UserIdentityTokenSourcePtrOutput) ToUserIdentityTokenSourcePtrOutput

func (o UserIdentityTokenSourcePtrOutput) ToUserIdentityTokenSourcePtrOutput() UserIdentityTokenSourcePtrOutput

func (UserIdentityTokenSourcePtrOutput) ToUserIdentityTokenSourcePtrOutputWithContext

func (o UserIdentityTokenSourcePtrOutput) ToUserIdentityTokenSourcePtrOutputWithContext(ctx context.Context) UserIdentityTokenSourcePtrOutput

func (UserIdentityTokenSourcePtrOutput) Url

Fetch the token from this URL.

type UserKeybinding

type UserKeybinding struct {
	// The action to remap: `quit`, `switch_focus`, `commands`, `help`, `toggle_yolo`, `toggle_hide_tool_results`, `cycle_agent`, `model_picker`, `clear_queue`, `suspend`, `toggle_sidebar`, `edit_external`, `history_search`, `editor_send` or `editor_newline`.
	Action string `pulumi:"action"`
	// The key combinations in Bubble Tea format, for example `ctrl+k`, `alt+enter` or `f2`.
	Keys []string `pulumi:"keys"`
}

Binds a TUI action to one or more keys, replacing the action's default keys.

type UserKeybindingArgs

type UserKeybindingArgs struct {
	// The action to remap: `quit`, `switch_focus`, `commands`, `help`, `toggle_yolo`, `toggle_hide_tool_results`, `cycle_agent`, `model_picker`, `clear_queue`, `suspend`, `toggle_sidebar`, `edit_external`, `history_search`, `editor_send` or `editor_newline`.
	Action pulumi.StringInput `pulumi:"action"`
	// The key combinations in Bubble Tea format, for example `ctrl+k`, `alt+enter` or `f2`.
	Keys pulumi.StringArrayInput `pulumi:"keys"`
}

Binds a TUI action to one or more keys, replacing the action's default keys.

func (UserKeybindingArgs) ElementType

func (UserKeybindingArgs) ElementType() reflect.Type

func (UserKeybindingArgs) ToUserKeybindingOutput

func (i UserKeybindingArgs) ToUserKeybindingOutput() UserKeybindingOutput

func (UserKeybindingArgs) ToUserKeybindingOutputWithContext

func (i UserKeybindingArgs) ToUserKeybindingOutputWithContext(ctx context.Context) UserKeybindingOutput

type UserKeybindingArray

type UserKeybindingArray []UserKeybindingInput

func (UserKeybindingArray) ElementType

func (UserKeybindingArray) ElementType() reflect.Type

func (UserKeybindingArray) ToUserKeybindingArrayOutput

func (i UserKeybindingArray) ToUserKeybindingArrayOutput() UserKeybindingArrayOutput

func (UserKeybindingArray) ToUserKeybindingArrayOutputWithContext

func (i UserKeybindingArray) ToUserKeybindingArrayOutputWithContext(ctx context.Context) UserKeybindingArrayOutput

type UserKeybindingArrayInput

type UserKeybindingArrayInput interface {
	pulumi.Input

	ToUserKeybindingArrayOutput() UserKeybindingArrayOutput
	ToUserKeybindingArrayOutputWithContext(context.Context) UserKeybindingArrayOutput
}

UserKeybindingArrayInput is an input type that accepts UserKeybindingArray and UserKeybindingArrayOutput values. You can construct a concrete instance of `UserKeybindingArrayInput` via:

UserKeybindingArray{ UserKeybindingArgs{...} }

type UserKeybindingArrayOutput

type UserKeybindingArrayOutput struct{ *pulumi.OutputState }

func (UserKeybindingArrayOutput) ElementType

func (UserKeybindingArrayOutput) ElementType() reflect.Type

func (UserKeybindingArrayOutput) Index

func (UserKeybindingArrayOutput) ToUserKeybindingArrayOutput

func (o UserKeybindingArrayOutput) ToUserKeybindingArrayOutput() UserKeybindingArrayOutput

func (UserKeybindingArrayOutput) ToUserKeybindingArrayOutputWithContext

func (o UserKeybindingArrayOutput) ToUserKeybindingArrayOutputWithContext(ctx context.Context) UserKeybindingArrayOutput

type UserKeybindingInput

type UserKeybindingInput interface {
	pulumi.Input

	ToUserKeybindingOutput() UserKeybindingOutput
	ToUserKeybindingOutputWithContext(context.Context) UserKeybindingOutput
}

UserKeybindingInput is an input type that accepts UserKeybindingArgs and UserKeybindingOutput values. You can construct a concrete instance of `UserKeybindingInput` via:

UserKeybindingArgs{...}

type UserKeybindingOutput

type UserKeybindingOutput struct{ *pulumi.OutputState }

Binds a TUI action to one or more keys, replacing the action's default keys.

func (UserKeybindingOutput) Action

The action to remap: `quit`, `switch_focus`, `commands`, `help`, `toggle_yolo`, `toggle_hide_tool_results`, `cycle_agent`, `model_picker`, `clear_queue`, `suspend`, `toggle_sidebar`, `edit_external`, `history_search`, `editor_send` or `editor_newline`.

func (UserKeybindingOutput) ElementType

func (UserKeybindingOutput) ElementType() reflect.Type

func (UserKeybindingOutput) Keys

The key combinations in Bubble Tea format, for example `ctrl+k`, `alt+enter` or `f2`.

func (UserKeybindingOutput) ToUserKeybindingOutput

func (o UserKeybindingOutput) ToUserKeybindingOutput() UserKeybindingOutput

func (UserKeybindingOutput) ToUserKeybindingOutputWithContext

func (o UserKeybindingOutput) ToUserKeybindingOutputWithContext(ctx context.Context) UserKeybindingOutput

type UserLayoutSettings

type UserLayoutSettings struct {
	// Show only the agents active in the current session in the Agents section.
	ActiveAgentsOnly *bool `pulumi:"activeAgentsOnly"`
	// Hide the Agents section.
	HideAgents *bool `pulumi:"hideAgents"`
	// Hide the working directory (session path) line, including its git branch.
	HideSessionPath *bool `pulumi:"hideSessionPath"`
	// Hide the Todos section.
	HideTodos *bool `pulumi:"hideTodos"`
	// Hide the Tools section.
	HideTools *bool `pulumi:"hideTools"`
	// Hide the token usage section.
	HideUsage *bool `pulumi:"hideUsage"`
	// Blank space between sidebar sections: `normal` (default), `compact` or `relaxed`.
	SectionSpacing *SectionSpacing `pulumi:"sectionSpacing"`
	// Show shared plans in the sidebar (default `false`).
	ShowPlans *bool `pulumi:"showPlans"`
	// How the Agents section renders each agent: `compact` (default, two lines) or `detailed` (cards with effort, context and cost metrics).
	SidebarInfoMode *SidebarInfoMode `pulumi:"sidebarInfoMode"`
	// Where the sidebar goes: `right` (default), `left`, `top` or `bottom`. Top and bottom render a compact horizontal band.
	SidebarPosition *SidebarPosition `pulumi:"sidebarPosition"`
}

The TUI layout (`settings.layout`). Unset fields keep the default layout: sidebar on the right, every section except Plans visible, normal spacing.

type UserLayoutSettingsArgs

type UserLayoutSettingsArgs struct {
	// Show only the agents active in the current session in the Agents section.
	ActiveAgentsOnly pulumi.BoolPtrInput `pulumi:"activeAgentsOnly"`
	// Hide the Agents section.
	HideAgents pulumi.BoolPtrInput `pulumi:"hideAgents"`
	// Hide the working directory (session path) line, including its git branch.
	HideSessionPath pulumi.BoolPtrInput `pulumi:"hideSessionPath"`
	// Hide the Todos section.
	HideTodos pulumi.BoolPtrInput `pulumi:"hideTodos"`
	// Hide the Tools section.
	HideTools pulumi.BoolPtrInput `pulumi:"hideTools"`
	// Hide the token usage section.
	HideUsage pulumi.BoolPtrInput `pulumi:"hideUsage"`
	// Blank space between sidebar sections: `normal` (default), `compact` or `relaxed`.
	SectionSpacing SectionSpacingPtrInput `pulumi:"sectionSpacing"`
	// Show shared plans in the sidebar (default `false`).
	ShowPlans pulumi.BoolPtrInput `pulumi:"showPlans"`
	// How the Agents section renders each agent: `compact` (default, two lines) or `detailed` (cards with effort, context and cost metrics).
	SidebarInfoMode SidebarInfoModePtrInput `pulumi:"sidebarInfoMode"`
	// Where the sidebar goes: `right` (default), `left`, `top` or `bottom`. Top and bottom render a compact horizontal band.
	SidebarPosition SidebarPositionPtrInput `pulumi:"sidebarPosition"`
}

The TUI layout (`settings.layout`). Unset fields keep the default layout: sidebar on the right, every section except Plans visible, normal spacing.

func (UserLayoutSettingsArgs) ElementType

func (UserLayoutSettingsArgs) ElementType() reflect.Type

func (UserLayoutSettingsArgs) ToUserLayoutSettingsOutput

func (i UserLayoutSettingsArgs) ToUserLayoutSettingsOutput() UserLayoutSettingsOutput

func (UserLayoutSettingsArgs) ToUserLayoutSettingsOutputWithContext

func (i UserLayoutSettingsArgs) ToUserLayoutSettingsOutputWithContext(ctx context.Context) UserLayoutSettingsOutput

func (UserLayoutSettingsArgs) ToUserLayoutSettingsPtrOutput

func (i UserLayoutSettingsArgs) ToUserLayoutSettingsPtrOutput() UserLayoutSettingsPtrOutput

func (UserLayoutSettingsArgs) ToUserLayoutSettingsPtrOutputWithContext

func (i UserLayoutSettingsArgs) ToUserLayoutSettingsPtrOutputWithContext(ctx context.Context) UserLayoutSettingsPtrOutput

type UserLayoutSettingsInput

type UserLayoutSettingsInput interface {
	pulumi.Input

	ToUserLayoutSettingsOutput() UserLayoutSettingsOutput
	ToUserLayoutSettingsOutputWithContext(context.Context) UserLayoutSettingsOutput
}

UserLayoutSettingsInput is an input type that accepts UserLayoutSettingsArgs and UserLayoutSettingsOutput values. You can construct a concrete instance of `UserLayoutSettingsInput` via:

UserLayoutSettingsArgs{...}

type UserLayoutSettingsOutput

type UserLayoutSettingsOutput struct{ *pulumi.OutputState }

The TUI layout (`settings.layout`). Unset fields keep the default layout: sidebar on the right, every section except Plans visible, normal spacing.

func (UserLayoutSettingsOutput) ActiveAgentsOnly

func (o UserLayoutSettingsOutput) ActiveAgentsOnly() pulumi.BoolPtrOutput

Show only the agents active in the current session in the Agents section.

func (UserLayoutSettingsOutput) ElementType

func (UserLayoutSettingsOutput) ElementType() reflect.Type

func (UserLayoutSettingsOutput) HideAgents

Hide the Agents section.

func (UserLayoutSettingsOutput) HideSessionPath

func (o UserLayoutSettingsOutput) HideSessionPath() pulumi.BoolPtrOutput

Hide the working directory (session path) line, including its git branch.

func (UserLayoutSettingsOutput) HideTodos

Hide the Todos section.

func (UserLayoutSettingsOutput) HideTools

Hide the Tools section.

func (UserLayoutSettingsOutput) HideUsage

Hide the token usage section.

func (UserLayoutSettingsOutput) SectionSpacing

Blank space between sidebar sections: `normal` (default), `compact` or `relaxed`.

func (UserLayoutSettingsOutput) ShowPlans

Show shared plans in the sidebar (default `false`).

func (UserLayoutSettingsOutput) SidebarInfoMode

How the Agents section renders each agent: `compact` (default, two lines) or `detailed` (cards with effort, context and cost metrics).

func (UserLayoutSettingsOutput) SidebarPosition

Where the sidebar goes: `right` (default), `left`, `top` or `bottom`. Top and bottom render a compact horizontal band.

func (UserLayoutSettingsOutput) ToUserLayoutSettingsOutput

func (o UserLayoutSettingsOutput) ToUserLayoutSettingsOutput() UserLayoutSettingsOutput

func (UserLayoutSettingsOutput) ToUserLayoutSettingsOutputWithContext

func (o UserLayoutSettingsOutput) ToUserLayoutSettingsOutputWithContext(ctx context.Context) UserLayoutSettingsOutput

func (UserLayoutSettingsOutput) ToUserLayoutSettingsPtrOutput

func (o UserLayoutSettingsOutput) ToUserLayoutSettingsPtrOutput() UserLayoutSettingsPtrOutput

func (UserLayoutSettingsOutput) ToUserLayoutSettingsPtrOutputWithContext

func (o UserLayoutSettingsOutput) ToUserLayoutSettingsPtrOutputWithContext(ctx context.Context) UserLayoutSettingsPtrOutput

type UserLayoutSettingsPtrInput

type UserLayoutSettingsPtrInput interface {
	pulumi.Input

	ToUserLayoutSettingsPtrOutput() UserLayoutSettingsPtrOutput
	ToUserLayoutSettingsPtrOutputWithContext(context.Context) UserLayoutSettingsPtrOutput
}

UserLayoutSettingsPtrInput is an input type that accepts UserLayoutSettingsArgs, UserLayoutSettingsPtr and UserLayoutSettingsPtrOutput values. You can construct a concrete instance of `UserLayoutSettingsPtrInput` via:

        UserLayoutSettingsArgs{...}

or:

        nil

type UserLayoutSettingsPtrOutput

type UserLayoutSettingsPtrOutput struct{ *pulumi.OutputState }

func (UserLayoutSettingsPtrOutput) ActiveAgentsOnly

func (o UserLayoutSettingsPtrOutput) ActiveAgentsOnly() pulumi.BoolPtrOutput

Show only the agents active in the current session in the Agents section.

func (UserLayoutSettingsPtrOutput) Elem

func (UserLayoutSettingsPtrOutput) ElementType

func (UserLayoutSettingsPtrOutput) HideAgents

Hide the Agents section.

func (UserLayoutSettingsPtrOutput) HideSessionPath

func (o UserLayoutSettingsPtrOutput) HideSessionPath() pulumi.BoolPtrOutput

Hide the working directory (session path) line, including its git branch.

func (UserLayoutSettingsPtrOutput) HideTodos

Hide the Todos section.

func (UserLayoutSettingsPtrOutput) HideTools

Hide the Tools section.

func (UserLayoutSettingsPtrOutput) HideUsage

Hide the token usage section.

func (UserLayoutSettingsPtrOutput) SectionSpacing

Blank space between sidebar sections: `normal` (default), `compact` or `relaxed`.

func (UserLayoutSettingsPtrOutput) ShowPlans

Show shared plans in the sidebar (default `false`).

func (UserLayoutSettingsPtrOutput) SidebarInfoMode

How the Agents section renders each agent: `compact` (default, two lines) or `detailed` (cards with effort, context and cost metrics).

func (UserLayoutSettingsPtrOutput) SidebarPosition

Where the sidebar goes: `right` (default), `left`, `top` or `bottom`. Top and bottom render a compact horizontal band.

func (UserLayoutSettingsPtrOutput) ToUserLayoutSettingsPtrOutput

func (o UserLayoutSettingsPtrOutput) ToUserLayoutSettingsPtrOutput() UserLayoutSettingsPtrOutput

func (UserLayoutSettingsPtrOutput) ToUserLayoutSettingsPtrOutputWithContext

func (o UserLayoutSettingsPtrOutput) ToUserLayoutSettingsPtrOutputWithContext(ctx context.Context) UserLayoutSettingsPtrOutput

type UserModel

type UserModel struct {
	// A non-API-key authentication scheme.
	Auth *UserModelAuth `pulumi:"auth"`
	// A custom API base URL. Implies `bypassModelsGateway`.
	BaseUrl *string `pulumi:"baseUrl"`
	// Connect directly to the provider even when a models gateway is configured.
	BypassModelsGateway *bool `pulumi:"bypassModelsGateway"`
	// Input modalities the model supports, overriding the built-in catalog.
	Capabilities *UserModelCapabilities `pulumi:"capabilities"`
	// The model used to summarize the session during compaction.
	CompactionModel *string `pulumi:"compactionModel"`
	// The fraction of the context window (greater than 0, at most 1) at which compaction starts.
	CompactionThreshold *float64 `pulumi:"compactionThreshold"`
	// Prices per million tokens, used for cost tracking.
	Cost *UserModelCost `pulumi:"cost"`
	// A description of the model.
	Description *string `pulumi:"description"`
	// Candidate models; the first usable one is selected. Excludes most other fields.
	FirstAvailable []string `pulumi:"firstAvailable"`
	// Frequency penalty.
	FrequencyPenalty *float64 `pulumi:"frequencyPenalty"`
	// Maximum number of output tokens.
	MaxTokens *int `pulumi:"maxTokens"`
	// The model name, for example `gpt-5-mini` or `claude-sonnet-4-5`.
	Model *string `pulumi:"model"`
	// Output modalities the model supports.
	OutputCapabilities *UserModelOutputCapabilities `pulumi:"outputCapabilities"`
	// Whether parallel tool calls are enabled.
	ParallelToolCalls *bool `pulumi:"parallelToolCalls"`
	// Presence penalty.
	PresencePenalty *float64 `pulumi:"presencePenalty"`
	// The provider, for example `openai`, `anthropic`, `google`, `amazon-bedrock`, `dmr` or the name of a custom provider.
	Provider *string `pulumi:"provider"`
	// Provider-specific options, written verbatim (snake_case keys), for example `context_size`.
	ProviderOpts map[string]interface{} `pulumi:"providerOpts"`
	// Rules that route requests to other models based on example prompts.
	Routing []UserModelRoutingRule `pulumi:"routing"`
	// Total token budget for an agentic task (Anthropic `task_budget`).
	TaskBudget *UserTaskBudget `pulumi:"taskBudget"`
	// Sampling temperature.
	Temperature *float64 `pulumi:"temperature"`
	// Reasoning effort or token budget.
	ThinkingBudget *UserThinkingBudget `pulumi:"thinkingBudget"`
	// The model used to generate session titles.
	TitleModel *string `pulumi:"titleModel"`
	// The name of the environment variable that holds the API token.
	TokenKey *string `pulumi:"tokenKey"`
	// Top-p sampling parameter.
	TopP *float64 `pulumi:"topP"`
	// Whether token usage is tracked.
	TrackUsage *bool `pulumi:"trackUsage"`
}

A model definition with the same fields as an entry of an agent file's `models:` section. A model with only `provider` and `model` is written in the `provider/model` shorthand.

type UserModelArgs

type UserModelArgs struct {
	// A non-API-key authentication scheme.
	Auth UserModelAuthPtrInput `pulumi:"auth"`
	// A custom API base URL. Implies `bypassModelsGateway`.
	BaseUrl pulumi.StringPtrInput `pulumi:"baseUrl"`
	// Connect directly to the provider even when a models gateway is configured.
	BypassModelsGateway pulumi.BoolPtrInput `pulumi:"bypassModelsGateway"`
	// Input modalities the model supports, overriding the built-in catalog.
	Capabilities UserModelCapabilitiesPtrInput `pulumi:"capabilities"`
	// The model used to summarize the session during compaction.
	CompactionModel pulumi.StringPtrInput `pulumi:"compactionModel"`
	// The fraction of the context window (greater than 0, at most 1) at which compaction starts.
	CompactionThreshold pulumi.Float64PtrInput `pulumi:"compactionThreshold"`
	// Prices per million tokens, used for cost tracking.
	Cost UserModelCostPtrInput `pulumi:"cost"`
	// A description of the model.
	Description pulumi.StringPtrInput `pulumi:"description"`
	// Candidate models; the first usable one is selected. Excludes most other fields.
	FirstAvailable pulumi.StringArrayInput `pulumi:"firstAvailable"`
	// Frequency penalty.
	FrequencyPenalty pulumi.Float64PtrInput `pulumi:"frequencyPenalty"`
	// Maximum number of output tokens.
	MaxTokens pulumi.IntPtrInput `pulumi:"maxTokens"`
	// The model name, for example `gpt-5-mini` or `claude-sonnet-4-5`.
	Model pulumi.StringPtrInput `pulumi:"model"`
	// Output modalities the model supports.
	OutputCapabilities UserModelOutputCapabilitiesPtrInput `pulumi:"outputCapabilities"`
	// Whether parallel tool calls are enabled.
	ParallelToolCalls pulumi.BoolPtrInput `pulumi:"parallelToolCalls"`
	// Presence penalty.
	PresencePenalty pulumi.Float64PtrInput `pulumi:"presencePenalty"`
	// The provider, for example `openai`, `anthropic`, `google`, `amazon-bedrock`, `dmr` or the name of a custom provider.
	Provider pulumi.StringPtrInput `pulumi:"provider"`
	// Provider-specific options, written verbatim (snake_case keys), for example `context_size`.
	ProviderOpts pulumi.MapInput `pulumi:"providerOpts"`
	// Rules that route requests to other models based on example prompts.
	Routing UserModelRoutingRuleArrayInput `pulumi:"routing"`
	// Total token budget for an agentic task (Anthropic `task_budget`).
	TaskBudget UserTaskBudgetPtrInput `pulumi:"taskBudget"`
	// Sampling temperature.
	Temperature pulumi.Float64PtrInput `pulumi:"temperature"`
	// Reasoning effort or token budget.
	ThinkingBudget UserThinkingBudgetPtrInput `pulumi:"thinkingBudget"`
	// The model used to generate session titles.
	TitleModel pulumi.StringPtrInput `pulumi:"titleModel"`
	// The name of the environment variable that holds the API token.
	TokenKey pulumi.StringPtrInput `pulumi:"tokenKey"`
	// Top-p sampling parameter.
	TopP pulumi.Float64PtrInput `pulumi:"topP"`
	// Whether token usage is tracked.
	TrackUsage pulumi.BoolPtrInput `pulumi:"trackUsage"`
}

A model definition with the same fields as an entry of an agent file's `models:` section. A model with only `provider` and `model` is written in the `provider/model` shorthand.

func (UserModelArgs) ElementType

func (UserModelArgs) ElementType() reflect.Type

func (UserModelArgs) ToUserModelOutput

func (i UserModelArgs) ToUserModelOutput() UserModelOutput

func (UserModelArgs) ToUserModelOutputWithContext

func (i UserModelArgs) ToUserModelOutputWithContext(ctx context.Context) UserModelOutput

func (UserModelArgs) ToUserModelPtrOutput

func (i UserModelArgs) ToUserModelPtrOutput() UserModelPtrOutput

func (UserModelArgs) ToUserModelPtrOutputWithContext

func (i UserModelArgs) ToUserModelPtrOutputWithContext(ctx context.Context) UserModelPtrOutput

type UserModelAuth

type UserModelAuth struct {
	// The scheme. Currently `workload_identity_federation` (Anthropic).
	Type string `pulumi:"type"`
	// Workload identity federation settings.
	WorkloadIdentityFederation *UserFederationAuth `pulumi:"workloadIdentityFederation"`
}

A non-API-key authentication scheme.

type UserModelAuthArgs

type UserModelAuthArgs struct {
	// The scheme. Currently `workload_identity_federation` (Anthropic).
	Type pulumi.StringInput `pulumi:"type"`
	// Workload identity federation settings.
	WorkloadIdentityFederation UserFederationAuthPtrInput `pulumi:"workloadIdentityFederation"`
}

A non-API-key authentication scheme.

func (UserModelAuthArgs) ElementType

func (UserModelAuthArgs) ElementType() reflect.Type

func (UserModelAuthArgs) ToUserModelAuthOutput

func (i UserModelAuthArgs) ToUserModelAuthOutput() UserModelAuthOutput

func (UserModelAuthArgs) ToUserModelAuthOutputWithContext

func (i UserModelAuthArgs) ToUserModelAuthOutputWithContext(ctx context.Context) UserModelAuthOutput

func (UserModelAuthArgs) ToUserModelAuthPtrOutput

func (i UserModelAuthArgs) ToUserModelAuthPtrOutput() UserModelAuthPtrOutput

func (UserModelAuthArgs) ToUserModelAuthPtrOutputWithContext

func (i UserModelAuthArgs) ToUserModelAuthPtrOutputWithContext(ctx context.Context) UserModelAuthPtrOutput

type UserModelAuthInput

type UserModelAuthInput interface {
	pulumi.Input

	ToUserModelAuthOutput() UserModelAuthOutput
	ToUserModelAuthOutputWithContext(context.Context) UserModelAuthOutput
}

UserModelAuthInput is an input type that accepts UserModelAuthArgs and UserModelAuthOutput values. You can construct a concrete instance of `UserModelAuthInput` via:

UserModelAuthArgs{...}

type UserModelAuthOutput

type UserModelAuthOutput struct{ *pulumi.OutputState }

A non-API-key authentication scheme.

func (UserModelAuthOutput) ElementType

func (UserModelAuthOutput) ElementType() reflect.Type

func (UserModelAuthOutput) ToUserModelAuthOutput

func (o UserModelAuthOutput) ToUserModelAuthOutput() UserModelAuthOutput

func (UserModelAuthOutput) ToUserModelAuthOutputWithContext

func (o UserModelAuthOutput) ToUserModelAuthOutputWithContext(ctx context.Context) UserModelAuthOutput

func (UserModelAuthOutput) ToUserModelAuthPtrOutput

func (o UserModelAuthOutput) ToUserModelAuthPtrOutput() UserModelAuthPtrOutput

func (UserModelAuthOutput) ToUserModelAuthPtrOutputWithContext

func (o UserModelAuthOutput) ToUserModelAuthPtrOutputWithContext(ctx context.Context) UserModelAuthPtrOutput

func (UserModelAuthOutput) Type

The scheme. Currently `workload_identity_federation` (Anthropic).

func (UserModelAuthOutput) WorkloadIdentityFederation

func (o UserModelAuthOutput) WorkloadIdentityFederation() UserFederationAuthPtrOutput

Workload identity federation settings.

type UserModelAuthPtrInput

type UserModelAuthPtrInput interface {
	pulumi.Input

	ToUserModelAuthPtrOutput() UserModelAuthPtrOutput
	ToUserModelAuthPtrOutputWithContext(context.Context) UserModelAuthPtrOutput
}

UserModelAuthPtrInput is an input type that accepts UserModelAuthArgs, UserModelAuthPtr and UserModelAuthPtrOutput values. You can construct a concrete instance of `UserModelAuthPtrInput` via:

        UserModelAuthArgs{...}

or:

        nil

type UserModelAuthPtrOutput

type UserModelAuthPtrOutput struct{ *pulumi.OutputState }

func (UserModelAuthPtrOutput) Elem

func (UserModelAuthPtrOutput) ElementType

func (UserModelAuthPtrOutput) ElementType() reflect.Type

func (UserModelAuthPtrOutput) ToUserModelAuthPtrOutput

func (o UserModelAuthPtrOutput) ToUserModelAuthPtrOutput() UserModelAuthPtrOutput

func (UserModelAuthPtrOutput) ToUserModelAuthPtrOutputWithContext

func (o UserModelAuthPtrOutput) ToUserModelAuthPtrOutputWithContext(ctx context.Context) UserModelAuthPtrOutput

func (UserModelAuthPtrOutput) Type

The scheme. Currently `workload_identity_federation` (Anthropic).

func (UserModelAuthPtrOutput) WorkloadIdentityFederation

func (o UserModelAuthPtrOutput) WorkloadIdentityFederation() UserFederationAuthPtrOutput

Workload identity federation settings.

type UserModelCapabilities

type UserModelCapabilities struct {
	// Accepts audio.
	Audio *bool `pulumi:"audio"`
	// Accepts images.
	Image *bool `pulumi:"image"`
	// Accepts PDF documents.
	Pdf *bool `pulumi:"pdf"`
	// Accepts video.
	Video *bool `pulumi:"video"`
}

Input modalities the model accepts.

type UserModelCapabilitiesArgs

type UserModelCapabilitiesArgs struct {
	// Accepts audio.
	Audio pulumi.BoolPtrInput `pulumi:"audio"`
	// Accepts images.
	Image pulumi.BoolPtrInput `pulumi:"image"`
	// Accepts PDF documents.
	Pdf pulumi.BoolPtrInput `pulumi:"pdf"`
	// Accepts video.
	Video pulumi.BoolPtrInput `pulumi:"video"`
}

Input modalities the model accepts.

func (UserModelCapabilitiesArgs) ElementType

func (UserModelCapabilitiesArgs) ElementType() reflect.Type

func (UserModelCapabilitiesArgs) ToUserModelCapabilitiesOutput

func (i UserModelCapabilitiesArgs) ToUserModelCapabilitiesOutput() UserModelCapabilitiesOutput

func (UserModelCapabilitiesArgs) ToUserModelCapabilitiesOutputWithContext

func (i UserModelCapabilitiesArgs) ToUserModelCapabilitiesOutputWithContext(ctx context.Context) UserModelCapabilitiesOutput

func (UserModelCapabilitiesArgs) ToUserModelCapabilitiesPtrOutput

func (i UserModelCapabilitiesArgs) ToUserModelCapabilitiesPtrOutput() UserModelCapabilitiesPtrOutput

func (UserModelCapabilitiesArgs) ToUserModelCapabilitiesPtrOutputWithContext

func (i UserModelCapabilitiesArgs) ToUserModelCapabilitiesPtrOutputWithContext(ctx context.Context) UserModelCapabilitiesPtrOutput

type UserModelCapabilitiesInput

type UserModelCapabilitiesInput interface {
	pulumi.Input

	ToUserModelCapabilitiesOutput() UserModelCapabilitiesOutput
	ToUserModelCapabilitiesOutputWithContext(context.Context) UserModelCapabilitiesOutput
}

UserModelCapabilitiesInput is an input type that accepts UserModelCapabilitiesArgs and UserModelCapabilitiesOutput values. You can construct a concrete instance of `UserModelCapabilitiesInput` via:

UserModelCapabilitiesArgs{...}

type UserModelCapabilitiesOutput

type UserModelCapabilitiesOutput struct{ *pulumi.OutputState }

Input modalities the model accepts.

func (UserModelCapabilitiesOutput) Audio

Accepts audio.

func (UserModelCapabilitiesOutput) ElementType

func (UserModelCapabilitiesOutput) Image

Accepts images.

func (UserModelCapabilitiesOutput) Pdf

Accepts PDF documents.

func (UserModelCapabilitiesOutput) ToUserModelCapabilitiesOutput

func (o UserModelCapabilitiesOutput) ToUserModelCapabilitiesOutput() UserModelCapabilitiesOutput

func (UserModelCapabilitiesOutput) ToUserModelCapabilitiesOutputWithContext

func (o UserModelCapabilitiesOutput) ToUserModelCapabilitiesOutputWithContext(ctx context.Context) UserModelCapabilitiesOutput

func (UserModelCapabilitiesOutput) ToUserModelCapabilitiesPtrOutput

func (o UserModelCapabilitiesOutput) ToUserModelCapabilitiesPtrOutput() UserModelCapabilitiesPtrOutput

func (UserModelCapabilitiesOutput) ToUserModelCapabilitiesPtrOutputWithContext

func (o UserModelCapabilitiesOutput) ToUserModelCapabilitiesPtrOutputWithContext(ctx context.Context) UserModelCapabilitiesPtrOutput

func (UserModelCapabilitiesOutput) Video

Accepts video.

type UserModelCapabilitiesPtrInput

type UserModelCapabilitiesPtrInput interface {
	pulumi.Input

	ToUserModelCapabilitiesPtrOutput() UserModelCapabilitiesPtrOutput
	ToUserModelCapabilitiesPtrOutputWithContext(context.Context) UserModelCapabilitiesPtrOutput
}

UserModelCapabilitiesPtrInput is an input type that accepts UserModelCapabilitiesArgs, UserModelCapabilitiesPtr and UserModelCapabilitiesPtrOutput values. You can construct a concrete instance of `UserModelCapabilitiesPtrInput` via:

        UserModelCapabilitiesArgs{...}

or:

        nil

type UserModelCapabilitiesPtrOutput

type UserModelCapabilitiesPtrOutput struct{ *pulumi.OutputState }

func (UserModelCapabilitiesPtrOutput) Audio

Accepts audio.

func (UserModelCapabilitiesPtrOutput) Elem

func (UserModelCapabilitiesPtrOutput) ElementType

func (UserModelCapabilitiesPtrOutput) Image

Accepts images.

func (UserModelCapabilitiesPtrOutput) Pdf

Accepts PDF documents.

func (UserModelCapabilitiesPtrOutput) ToUserModelCapabilitiesPtrOutput

func (o UserModelCapabilitiesPtrOutput) ToUserModelCapabilitiesPtrOutput() UserModelCapabilitiesPtrOutput

func (UserModelCapabilitiesPtrOutput) ToUserModelCapabilitiesPtrOutputWithContext

func (o UserModelCapabilitiesPtrOutput) ToUserModelCapabilitiesPtrOutputWithContext(ctx context.Context) UserModelCapabilitiesPtrOutput

func (UserModelCapabilitiesPtrOutput) Video

Accepts video.

type UserModelCost

type UserModelCost struct {
	// Price of cache-read tokens.
	CacheRead *float64 `pulumi:"cacheRead"`
	// Price of cache-write tokens.
	CacheWrite *float64 `pulumi:"cacheWrite"`
	// Price of input tokens.
	Input *float64 `pulumi:"input"`
	// Price of output tokens.
	Output *float64 `pulumi:"output"`
}

Prices in USD per million tokens.

type UserModelCostArgs

type UserModelCostArgs struct {
	// Price of cache-read tokens.
	CacheRead pulumi.Float64PtrInput `pulumi:"cacheRead"`
	// Price of cache-write tokens.
	CacheWrite pulumi.Float64PtrInput `pulumi:"cacheWrite"`
	// Price of input tokens.
	Input pulumi.Float64PtrInput `pulumi:"input"`
	// Price of output tokens.
	Output pulumi.Float64PtrInput `pulumi:"output"`
}

Prices in USD per million tokens.

func (UserModelCostArgs) ElementType

func (UserModelCostArgs) ElementType() reflect.Type

func (UserModelCostArgs) ToUserModelCostOutput

func (i UserModelCostArgs) ToUserModelCostOutput() UserModelCostOutput

func (UserModelCostArgs) ToUserModelCostOutputWithContext

func (i UserModelCostArgs) ToUserModelCostOutputWithContext(ctx context.Context) UserModelCostOutput

func (UserModelCostArgs) ToUserModelCostPtrOutput

func (i UserModelCostArgs) ToUserModelCostPtrOutput() UserModelCostPtrOutput

func (UserModelCostArgs) ToUserModelCostPtrOutputWithContext

func (i UserModelCostArgs) ToUserModelCostPtrOutputWithContext(ctx context.Context) UserModelCostPtrOutput

type UserModelCostInput

type UserModelCostInput interface {
	pulumi.Input

	ToUserModelCostOutput() UserModelCostOutput
	ToUserModelCostOutputWithContext(context.Context) UserModelCostOutput
}

UserModelCostInput is an input type that accepts UserModelCostArgs and UserModelCostOutput values. You can construct a concrete instance of `UserModelCostInput` via:

UserModelCostArgs{...}

type UserModelCostOutput

type UserModelCostOutput struct{ *pulumi.OutputState }

Prices in USD per million tokens.

func (UserModelCostOutput) CacheRead

Price of cache-read tokens.

func (UserModelCostOutput) CacheWrite

Price of cache-write tokens.

func (UserModelCostOutput) ElementType

func (UserModelCostOutput) ElementType() reflect.Type

func (UserModelCostOutput) Input

Price of input tokens.

func (UserModelCostOutput) Output

Price of output tokens.

func (UserModelCostOutput) ToUserModelCostOutput

func (o UserModelCostOutput) ToUserModelCostOutput() UserModelCostOutput

func (UserModelCostOutput) ToUserModelCostOutputWithContext

func (o UserModelCostOutput) ToUserModelCostOutputWithContext(ctx context.Context) UserModelCostOutput

func (UserModelCostOutput) ToUserModelCostPtrOutput

func (o UserModelCostOutput) ToUserModelCostPtrOutput() UserModelCostPtrOutput

func (UserModelCostOutput) ToUserModelCostPtrOutputWithContext

func (o UserModelCostOutput) ToUserModelCostPtrOutputWithContext(ctx context.Context) UserModelCostPtrOutput

type UserModelCostPtrInput

type UserModelCostPtrInput interface {
	pulumi.Input

	ToUserModelCostPtrOutput() UserModelCostPtrOutput
	ToUserModelCostPtrOutputWithContext(context.Context) UserModelCostPtrOutput
}

UserModelCostPtrInput is an input type that accepts UserModelCostArgs, UserModelCostPtr and UserModelCostPtrOutput values. You can construct a concrete instance of `UserModelCostPtrInput` via:

        UserModelCostArgs{...}

or:

        nil

type UserModelCostPtrOutput

type UserModelCostPtrOutput struct{ *pulumi.OutputState }

func (UserModelCostPtrOutput) CacheRead

Price of cache-read tokens.

func (UserModelCostPtrOutput) CacheWrite

Price of cache-write tokens.

func (UserModelCostPtrOutput) Elem

func (UserModelCostPtrOutput) ElementType

func (UserModelCostPtrOutput) ElementType() reflect.Type

func (UserModelCostPtrOutput) Input

Price of input tokens.

func (UserModelCostPtrOutput) Output

Price of output tokens.

func (UserModelCostPtrOutput) ToUserModelCostPtrOutput

func (o UserModelCostPtrOutput) ToUserModelCostPtrOutput() UserModelCostPtrOutput

func (UserModelCostPtrOutput) ToUserModelCostPtrOutputWithContext

func (o UserModelCostPtrOutput) ToUserModelCostPtrOutputWithContext(ctx context.Context) UserModelCostPtrOutput

type UserModelInput

type UserModelInput interface {
	pulumi.Input

	ToUserModelOutput() UserModelOutput
	ToUserModelOutputWithContext(context.Context) UserModelOutput
}

UserModelInput is an input type that accepts UserModelArgs and UserModelOutput values. You can construct a concrete instance of `UserModelInput` via:

UserModelArgs{...}

type UserModelOutput

type UserModelOutput struct{ *pulumi.OutputState }

A model definition with the same fields as an entry of an agent file's `models:` section. A model with only `provider` and `model` is written in the `provider/model` shorthand.

func (UserModelOutput) Auth

A non-API-key authentication scheme.

func (UserModelOutput) BaseUrl

A custom API base URL. Implies `bypassModelsGateway`.

func (UserModelOutput) BypassModelsGateway

func (o UserModelOutput) BypassModelsGateway() pulumi.BoolPtrOutput

Connect directly to the provider even when a models gateway is configured.

func (UserModelOutput) Capabilities

Input modalities the model supports, overriding the built-in catalog.

func (UserModelOutput) CompactionModel

func (o UserModelOutput) CompactionModel() pulumi.StringPtrOutput

The model used to summarize the session during compaction.

func (UserModelOutput) CompactionThreshold

func (o UserModelOutput) CompactionThreshold() pulumi.Float64PtrOutput

The fraction of the context window (greater than 0, at most 1) at which compaction starts.

func (UserModelOutput) Cost

Prices per million tokens, used for cost tracking.

func (UserModelOutput) Description

func (o UserModelOutput) Description() pulumi.StringPtrOutput

A description of the model.

func (UserModelOutput) ElementType

func (UserModelOutput) ElementType() reflect.Type

func (UserModelOutput) FirstAvailable

func (o UserModelOutput) FirstAvailable() pulumi.StringArrayOutput

Candidate models; the first usable one is selected. Excludes most other fields.

func (UserModelOutput) FrequencyPenalty

func (o UserModelOutput) FrequencyPenalty() pulumi.Float64PtrOutput

Frequency penalty.

func (UserModelOutput) MaxTokens

func (o UserModelOutput) MaxTokens() pulumi.IntPtrOutput

Maximum number of output tokens.

func (UserModelOutput) Model

The model name, for example `gpt-5-mini` or `claude-sonnet-4-5`.

func (UserModelOutput) OutputCapabilities

Output modalities the model supports.

func (UserModelOutput) ParallelToolCalls

func (o UserModelOutput) ParallelToolCalls() pulumi.BoolPtrOutput

Whether parallel tool calls are enabled.

func (UserModelOutput) PresencePenalty

func (o UserModelOutput) PresencePenalty() pulumi.Float64PtrOutput

Presence penalty.

func (UserModelOutput) Provider

func (o UserModelOutput) Provider() pulumi.StringPtrOutput

The provider, for example `openai`, `anthropic`, `google`, `amazon-bedrock`, `dmr` or the name of a custom provider.

func (UserModelOutput) ProviderOpts

func (o UserModelOutput) ProviderOpts() pulumi.MapOutput

Provider-specific options, written verbatim (snake_case keys), for example `context_size`.

func (UserModelOutput) Routing

Rules that route requests to other models based on example prompts.

func (UserModelOutput) TaskBudget

Total token budget for an agentic task (Anthropic `task_budget`).

func (UserModelOutput) Temperature

func (o UserModelOutput) Temperature() pulumi.Float64PtrOutput

Sampling temperature.

func (UserModelOutput) ThinkingBudget

func (o UserModelOutput) ThinkingBudget() UserThinkingBudgetPtrOutput

Reasoning effort or token budget.

func (UserModelOutput) TitleModel

func (o UserModelOutput) TitleModel() pulumi.StringPtrOutput

The model used to generate session titles.

func (UserModelOutput) ToUserModelOutput

func (o UserModelOutput) ToUserModelOutput() UserModelOutput

func (UserModelOutput) ToUserModelOutputWithContext

func (o UserModelOutput) ToUserModelOutputWithContext(ctx context.Context) UserModelOutput

func (UserModelOutput) ToUserModelPtrOutput

func (o UserModelOutput) ToUserModelPtrOutput() UserModelPtrOutput

func (UserModelOutput) ToUserModelPtrOutputWithContext

func (o UserModelOutput) ToUserModelPtrOutputWithContext(ctx context.Context) UserModelPtrOutput

func (UserModelOutput) TokenKey

func (o UserModelOutput) TokenKey() pulumi.StringPtrOutput

The name of the environment variable that holds the API token.

func (UserModelOutput) TopP

Top-p sampling parameter.

func (UserModelOutput) TrackUsage

func (o UserModelOutput) TrackUsage() pulumi.BoolPtrOutput

Whether token usage is tracked.

type UserModelOutputCapabilities

type UserModelOutputCapabilities struct {
	// Produces images.
	Image *bool `pulumi:"image"`
}

Output modalities the model produces.

type UserModelOutputCapabilitiesArgs

type UserModelOutputCapabilitiesArgs struct {
	// Produces images.
	Image pulumi.BoolPtrInput `pulumi:"image"`
}

Output modalities the model produces.

func (UserModelOutputCapabilitiesArgs) ElementType

func (UserModelOutputCapabilitiesArgs) ToUserModelOutputCapabilitiesOutput

func (i UserModelOutputCapabilitiesArgs) ToUserModelOutputCapabilitiesOutput() UserModelOutputCapabilitiesOutput

func (UserModelOutputCapabilitiesArgs) ToUserModelOutputCapabilitiesOutputWithContext

func (i UserModelOutputCapabilitiesArgs) ToUserModelOutputCapabilitiesOutputWithContext(ctx context.Context) UserModelOutputCapabilitiesOutput

func (UserModelOutputCapabilitiesArgs) ToUserModelOutputCapabilitiesPtrOutput

func (i UserModelOutputCapabilitiesArgs) ToUserModelOutputCapabilitiesPtrOutput() UserModelOutputCapabilitiesPtrOutput

func (UserModelOutputCapabilitiesArgs) ToUserModelOutputCapabilitiesPtrOutputWithContext

func (i UserModelOutputCapabilitiesArgs) ToUserModelOutputCapabilitiesPtrOutputWithContext(ctx context.Context) UserModelOutputCapabilitiesPtrOutput

type UserModelOutputCapabilitiesInput

type UserModelOutputCapabilitiesInput interface {
	pulumi.Input

	ToUserModelOutputCapabilitiesOutput() UserModelOutputCapabilitiesOutput
	ToUserModelOutputCapabilitiesOutputWithContext(context.Context) UserModelOutputCapabilitiesOutput
}

UserModelOutputCapabilitiesInput is an input type that accepts UserModelOutputCapabilitiesArgs and UserModelOutputCapabilitiesOutput values. You can construct a concrete instance of `UserModelOutputCapabilitiesInput` via:

UserModelOutputCapabilitiesArgs{...}

type UserModelOutputCapabilitiesOutput

type UserModelOutputCapabilitiesOutput struct{ *pulumi.OutputState }

Output modalities the model produces.

func (UserModelOutputCapabilitiesOutput) ElementType

func (UserModelOutputCapabilitiesOutput) Image

Produces images.

func (UserModelOutputCapabilitiesOutput) ToUserModelOutputCapabilitiesOutput

func (o UserModelOutputCapabilitiesOutput) ToUserModelOutputCapabilitiesOutput() UserModelOutputCapabilitiesOutput

func (UserModelOutputCapabilitiesOutput) ToUserModelOutputCapabilitiesOutputWithContext

func (o UserModelOutputCapabilitiesOutput) ToUserModelOutputCapabilitiesOutputWithContext(ctx context.Context) UserModelOutputCapabilitiesOutput

func (UserModelOutputCapabilitiesOutput) ToUserModelOutputCapabilitiesPtrOutput

func (o UserModelOutputCapabilitiesOutput) ToUserModelOutputCapabilitiesPtrOutput() UserModelOutputCapabilitiesPtrOutput

func (UserModelOutputCapabilitiesOutput) ToUserModelOutputCapabilitiesPtrOutputWithContext

func (o UserModelOutputCapabilitiesOutput) ToUserModelOutputCapabilitiesPtrOutputWithContext(ctx context.Context) UserModelOutputCapabilitiesPtrOutput

type UserModelOutputCapabilitiesPtrInput

type UserModelOutputCapabilitiesPtrInput interface {
	pulumi.Input

	ToUserModelOutputCapabilitiesPtrOutput() UserModelOutputCapabilitiesPtrOutput
	ToUserModelOutputCapabilitiesPtrOutputWithContext(context.Context) UserModelOutputCapabilitiesPtrOutput
}

UserModelOutputCapabilitiesPtrInput is an input type that accepts UserModelOutputCapabilitiesArgs, UserModelOutputCapabilitiesPtr and UserModelOutputCapabilitiesPtrOutput values. You can construct a concrete instance of `UserModelOutputCapabilitiesPtrInput` via:

        UserModelOutputCapabilitiesArgs{...}

or:

        nil

type UserModelOutputCapabilitiesPtrOutput

type UserModelOutputCapabilitiesPtrOutput struct{ *pulumi.OutputState }

func (UserModelOutputCapabilitiesPtrOutput) Elem

func (UserModelOutputCapabilitiesPtrOutput) ElementType

func (UserModelOutputCapabilitiesPtrOutput) Image

Produces images.

func (UserModelOutputCapabilitiesPtrOutput) ToUserModelOutputCapabilitiesPtrOutput

func (o UserModelOutputCapabilitiesPtrOutput) ToUserModelOutputCapabilitiesPtrOutput() UserModelOutputCapabilitiesPtrOutput

func (UserModelOutputCapabilitiesPtrOutput) ToUserModelOutputCapabilitiesPtrOutputWithContext

func (o UserModelOutputCapabilitiesPtrOutput) ToUserModelOutputCapabilitiesPtrOutputWithContext(ctx context.Context) UserModelOutputCapabilitiesPtrOutput

type UserModelPtrInput

type UserModelPtrInput interface {
	pulumi.Input

	ToUserModelPtrOutput() UserModelPtrOutput
	ToUserModelPtrOutputWithContext(context.Context) UserModelPtrOutput
}

UserModelPtrInput is an input type that accepts UserModelArgs, UserModelPtr and UserModelPtrOutput values. You can construct a concrete instance of `UserModelPtrInput` via:

        UserModelArgs{...}

or:

        nil

func UserModelPtr

func UserModelPtr(v *UserModelArgs) UserModelPtrInput

type UserModelPtrOutput

type UserModelPtrOutput struct{ *pulumi.OutputState }

func (UserModelPtrOutput) Auth

A non-API-key authentication scheme.

func (UserModelPtrOutput) BaseUrl

A custom API base URL. Implies `bypassModelsGateway`.

func (UserModelPtrOutput) BypassModelsGateway

func (o UserModelPtrOutput) BypassModelsGateway() pulumi.BoolPtrOutput

Connect directly to the provider even when a models gateway is configured.

func (UserModelPtrOutput) Capabilities

Input modalities the model supports, overriding the built-in catalog.

func (UserModelPtrOutput) CompactionModel

func (o UserModelPtrOutput) CompactionModel() pulumi.StringPtrOutput

The model used to summarize the session during compaction.

func (UserModelPtrOutput) CompactionThreshold

func (o UserModelPtrOutput) CompactionThreshold() pulumi.Float64PtrOutput

The fraction of the context window (greater than 0, at most 1) at which compaction starts.

func (UserModelPtrOutput) Cost

Prices per million tokens, used for cost tracking.

func (UserModelPtrOutput) Description

func (o UserModelPtrOutput) Description() pulumi.StringPtrOutput

A description of the model.

func (UserModelPtrOutput) Elem

func (UserModelPtrOutput) ElementType

func (UserModelPtrOutput) ElementType() reflect.Type

func (UserModelPtrOutput) FirstAvailable

func (o UserModelPtrOutput) FirstAvailable() pulumi.StringArrayOutput

Candidate models; the first usable one is selected. Excludes most other fields.

func (UserModelPtrOutput) FrequencyPenalty

func (o UserModelPtrOutput) FrequencyPenalty() pulumi.Float64PtrOutput

Frequency penalty.

func (UserModelPtrOutput) MaxTokens

func (o UserModelPtrOutput) MaxTokens() pulumi.IntPtrOutput

Maximum number of output tokens.

func (UserModelPtrOutput) Model

The model name, for example `gpt-5-mini` or `claude-sonnet-4-5`.

func (UserModelPtrOutput) OutputCapabilities

Output modalities the model supports.

func (UserModelPtrOutput) ParallelToolCalls

func (o UserModelPtrOutput) ParallelToolCalls() pulumi.BoolPtrOutput

Whether parallel tool calls are enabled.

func (UserModelPtrOutput) PresencePenalty

func (o UserModelPtrOutput) PresencePenalty() pulumi.Float64PtrOutput

Presence penalty.

func (UserModelPtrOutput) Provider

The provider, for example `openai`, `anthropic`, `google`, `amazon-bedrock`, `dmr` or the name of a custom provider.

func (UserModelPtrOutput) ProviderOpts

func (o UserModelPtrOutput) ProviderOpts() pulumi.MapOutput

Provider-specific options, written verbatim (snake_case keys), for example `context_size`.

func (UserModelPtrOutput) Routing

Rules that route requests to other models based on example prompts.

func (UserModelPtrOutput) TaskBudget

Total token budget for an agentic task (Anthropic `task_budget`).

func (UserModelPtrOutput) Temperature

func (o UserModelPtrOutput) Temperature() pulumi.Float64PtrOutput

Sampling temperature.

func (UserModelPtrOutput) ThinkingBudget

Reasoning effort or token budget.

func (UserModelPtrOutput) TitleModel

func (o UserModelPtrOutput) TitleModel() pulumi.StringPtrOutput

The model used to generate session titles.

func (UserModelPtrOutput) ToUserModelPtrOutput

func (o UserModelPtrOutput) ToUserModelPtrOutput() UserModelPtrOutput

func (UserModelPtrOutput) ToUserModelPtrOutputWithContext

func (o UserModelPtrOutput) ToUserModelPtrOutputWithContext(ctx context.Context) UserModelPtrOutput

func (UserModelPtrOutput) TokenKey

The name of the environment variable that holds the API token.

func (UserModelPtrOutput) TopP

Top-p sampling parameter.

func (UserModelPtrOutput) TrackUsage

func (o UserModelPtrOutput) TrackUsage() pulumi.BoolPtrOutput

Whether token usage is tracked.

type UserModelRoutingRule

type UserModelRoutingRule struct {
	// Example prompts for this route.
	Examples []string `pulumi:"examples"`
	// The model to route to.
	Model string `pulumi:"model"`
}

Routes prompts similar to the examples to another model.

type UserModelRoutingRuleArgs

type UserModelRoutingRuleArgs struct {
	// Example prompts for this route.
	Examples pulumi.StringArrayInput `pulumi:"examples"`
	// The model to route to.
	Model pulumi.StringInput `pulumi:"model"`
}

Routes prompts similar to the examples to another model.

func (UserModelRoutingRuleArgs) ElementType

func (UserModelRoutingRuleArgs) ElementType() reflect.Type

func (UserModelRoutingRuleArgs) ToUserModelRoutingRuleOutput

func (i UserModelRoutingRuleArgs) ToUserModelRoutingRuleOutput() UserModelRoutingRuleOutput

func (UserModelRoutingRuleArgs) ToUserModelRoutingRuleOutputWithContext

func (i UserModelRoutingRuleArgs) ToUserModelRoutingRuleOutputWithContext(ctx context.Context) UserModelRoutingRuleOutput

type UserModelRoutingRuleArray

type UserModelRoutingRuleArray []UserModelRoutingRuleInput

func (UserModelRoutingRuleArray) ElementType

func (UserModelRoutingRuleArray) ElementType() reflect.Type

func (UserModelRoutingRuleArray) ToUserModelRoutingRuleArrayOutput

func (i UserModelRoutingRuleArray) ToUserModelRoutingRuleArrayOutput() UserModelRoutingRuleArrayOutput

func (UserModelRoutingRuleArray) ToUserModelRoutingRuleArrayOutputWithContext

func (i UserModelRoutingRuleArray) ToUserModelRoutingRuleArrayOutputWithContext(ctx context.Context) UserModelRoutingRuleArrayOutput

type UserModelRoutingRuleArrayInput

type UserModelRoutingRuleArrayInput interface {
	pulumi.Input

	ToUserModelRoutingRuleArrayOutput() UserModelRoutingRuleArrayOutput
	ToUserModelRoutingRuleArrayOutputWithContext(context.Context) UserModelRoutingRuleArrayOutput
}

UserModelRoutingRuleArrayInput is an input type that accepts UserModelRoutingRuleArray and UserModelRoutingRuleArrayOutput values. You can construct a concrete instance of `UserModelRoutingRuleArrayInput` via:

UserModelRoutingRuleArray{ UserModelRoutingRuleArgs{...} }

type UserModelRoutingRuleArrayOutput

type UserModelRoutingRuleArrayOutput struct{ *pulumi.OutputState }

func (UserModelRoutingRuleArrayOutput) ElementType

func (UserModelRoutingRuleArrayOutput) Index

func (UserModelRoutingRuleArrayOutput) ToUserModelRoutingRuleArrayOutput

func (o UserModelRoutingRuleArrayOutput) ToUserModelRoutingRuleArrayOutput() UserModelRoutingRuleArrayOutput

func (UserModelRoutingRuleArrayOutput) ToUserModelRoutingRuleArrayOutputWithContext

func (o UserModelRoutingRuleArrayOutput) ToUserModelRoutingRuleArrayOutputWithContext(ctx context.Context) UserModelRoutingRuleArrayOutput

type UserModelRoutingRuleInput

type UserModelRoutingRuleInput interface {
	pulumi.Input

	ToUserModelRoutingRuleOutput() UserModelRoutingRuleOutput
	ToUserModelRoutingRuleOutputWithContext(context.Context) UserModelRoutingRuleOutput
}

UserModelRoutingRuleInput is an input type that accepts UserModelRoutingRuleArgs and UserModelRoutingRuleOutput values. You can construct a concrete instance of `UserModelRoutingRuleInput` via:

UserModelRoutingRuleArgs{...}

type UserModelRoutingRuleOutput

type UserModelRoutingRuleOutput struct{ *pulumi.OutputState }

Routes prompts similar to the examples to another model.

func (UserModelRoutingRuleOutput) ElementType

func (UserModelRoutingRuleOutput) ElementType() reflect.Type

func (UserModelRoutingRuleOutput) Examples

Example prompts for this route.

func (UserModelRoutingRuleOutput) Model

The model to route to.

func (UserModelRoutingRuleOutput) ToUserModelRoutingRuleOutput

func (o UserModelRoutingRuleOutput) ToUserModelRoutingRuleOutput() UserModelRoutingRuleOutput

func (UserModelRoutingRuleOutput) ToUserModelRoutingRuleOutputWithContext

func (o UserModelRoutingRuleOutput) ToUserModelRoutingRuleOutputWithContext(ctx context.Context) UserModelRoutingRuleOutput

type UserPermissions

type UserPermissions struct {
	// Tools that run without asking.
	Allow []string `pulumi:"allow"`
	// Tools that always ask, even when they are normally auto-approved.
	Ask []string `pulumi:"ask"`
	// Tools that are always rejected.
	Deny []string `pulumi:"deny"`
}

Global tool permission patterns. Patterns use glob syntax, for example `shell`, `read_*`, `mcp:github:*` or `shell:cmd=git status*`. Deny is evaluated first, then allow, then ask.

type UserPermissionsArgs

type UserPermissionsArgs struct {
	// Tools that run without asking.
	Allow pulumi.StringArrayInput `pulumi:"allow"`
	// Tools that always ask, even when they are normally auto-approved.
	Ask pulumi.StringArrayInput `pulumi:"ask"`
	// Tools that are always rejected.
	Deny pulumi.StringArrayInput `pulumi:"deny"`
}

Global tool permission patterns. Patterns use glob syntax, for example `shell`, `read_*`, `mcp:github:*` or `shell:cmd=git status*`. Deny is evaluated first, then allow, then ask.

func (UserPermissionsArgs) ElementType

func (UserPermissionsArgs) ElementType() reflect.Type

func (UserPermissionsArgs) ToUserPermissionsOutput

func (i UserPermissionsArgs) ToUserPermissionsOutput() UserPermissionsOutput

func (UserPermissionsArgs) ToUserPermissionsOutputWithContext

func (i UserPermissionsArgs) ToUserPermissionsOutputWithContext(ctx context.Context) UserPermissionsOutput

func (UserPermissionsArgs) ToUserPermissionsPtrOutput

func (i UserPermissionsArgs) ToUserPermissionsPtrOutput() UserPermissionsPtrOutput

func (UserPermissionsArgs) ToUserPermissionsPtrOutputWithContext

func (i UserPermissionsArgs) ToUserPermissionsPtrOutputWithContext(ctx context.Context) UserPermissionsPtrOutput

type UserPermissionsInput

type UserPermissionsInput interface {
	pulumi.Input

	ToUserPermissionsOutput() UserPermissionsOutput
	ToUserPermissionsOutputWithContext(context.Context) UserPermissionsOutput
}

UserPermissionsInput is an input type that accepts UserPermissionsArgs and UserPermissionsOutput values. You can construct a concrete instance of `UserPermissionsInput` via:

UserPermissionsArgs{...}

type UserPermissionsOutput

type UserPermissionsOutput struct{ *pulumi.OutputState }

Global tool permission patterns. Patterns use glob syntax, for example `shell`, `read_*`, `mcp:github:*` or `shell:cmd=git status*`. Deny is evaluated first, then allow, then ask.

func (UserPermissionsOutput) Allow

Tools that run without asking.

func (UserPermissionsOutput) Ask

Tools that always ask, even when they are normally auto-approved.

func (UserPermissionsOutput) Deny

Tools that are always rejected.

func (UserPermissionsOutput) ElementType

func (UserPermissionsOutput) ElementType() reflect.Type

func (UserPermissionsOutput) ToUserPermissionsOutput

func (o UserPermissionsOutput) ToUserPermissionsOutput() UserPermissionsOutput

func (UserPermissionsOutput) ToUserPermissionsOutputWithContext

func (o UserPermissionsOutput) ToUserPermissionsOutputWithContext(ctx context.Context) UserPermissionsOutput

func (UserPermissionsOutput) ToUserPermissionsPtrOutput

func (o UserPermissionsOutput) ToUserPermissionsPtrOutput() UserPermissionsPtrOutput

func (UserPermissionsOutput) ToUserPermissionsPtrOutputWithContext

func (o UserPermissionsOutput) ToUserPermissionsPtrOutputWithContext(ctx context.Context) UserPermissionsPtrOutput

type UserPermissionsPtrInput

type UserPermissionsPtrInput interface {
	pulumi.Input

	ToUserPermissionsPtrOutput() UserPermissionsPtrOutput
	ToUserPermissionsPtrOutputWithContext(context.Context) UserPermissionsPtrOutput
}

UserPermissionsPtrInput is an input type that accepts UserPermissionsArgs, UserPermissionsPtr and UserPermissionsPtrOutput values. You can construct a concrete instance of `UserPermissionsPtrInput` via:

        UserPermissionsArgs{...}

or:

        nil

type UserPermissionsPtrOutput

type UserPermissionsPtrOutput struct{ *pulumi.OutputState }

func (UserPermissionsPtrOutput) Allow

Tools that run without asking.

func (UserPermissionsPtrOutput) Ask

Tools that always ask, even when they are normally auto-approved.

func (UserPermissionsPtrOutput) Deny

Tools that are always rejected.

func (UserPermissionsPtrOutput) Elem

func (UserPermissionsPtrOutput) ElementType

func (UserPermissionsPtrOutput) ElementType() reflect.Type

func (UserPermissionsPtrOutput) ToUserPermissionsPtrOutput

func (o UserPermissionsPtrOutput) ToUserPermissionsPtrOutput() UserPermissionsPtrOutput

func (UserPermissionsPtrOutput) ToUserPermissionsPtrOutputWithContext

func (o UserPermissionsPtrOutput) ToUserPermissionsPtrOutputWithContext(ctx context.Context) UserPermissionsPtrOutput

type UserProvider

type UserProvider struct {
	// The API flavour of OpenAI-compatible providers: `openai_chatcompletions` (default) or `openai_responses`.
	ApiType *ApiType `pulumi:"apiType"`
	// A non-API-key authentication scheme, such as Anthropic workload identity federation.
	Auth *UserModelAuth `pulumi:"auth"`
	// The API base URL. Required for OpenAI-compatible providers.
	BaseUrl *string `pulumi:"baseUrl"`
	// Default compaction (summary) model for agents using this provider.
	CompactionModel *string `pulumi:"compactionModel"`
	// Default frequency penalty.
	FrequencyPenalty *float64 `pulumi:"frequencyPenalty"`
	// Default maximum number of output tokens.
	MaxTokens *int `pulumi:"maxTokens"`
	// Whether parallel tool calls are enabled by default.
	ParallelToolCalls *bool `pulumi:"parallelToolCalls"`
	// Default presence penalty.
	PresencePenalty *float64 `pulumi:"presencePenalty"`
	// The underlying provider type: `openai` (default), `anthropic`, `google`, `amazon-bedrock`, `dmr` or a built-in alias.
	Provider *string `pulumi:"provider"`
	// Provider-specific options, written verbatim (snake_case keys).
	ProviderOpts map[string]interface{} `pulumi:"providerOpts"`
	// Default total token budget for an agentic task (Anthropic `task_budget`).
	TaskBudget *UserTaskBudget `pulumi:"taskBudget"`
	// Default sampling temperature.
	Temperature *float64 `pulumi:"temperature"`
	// Default reasoning effort or token budget.
	ThinkingBudget *UserThinkingBudget `pulumi:"thinkingBudget"`
	// The name of the environment variable that holds the API token (not the token itself).
	TokenKey *string `pulumi:"tokenKey"`
	// Default top-p sampling parameter.
	TopP *float64 `pulumi:"topP"`
	// Whether token usage is tracked by default.
	TrackUsage *bool `pulumi:"trackUsage"`
	// Path or URL of the provider's model-unload endpoint, used by the `unload` built-in hook. Leave unset for cloud providers.
	UnloadApi *string `pulumi:"unloadApi"`
}

A reusable model provider (for example an OpenAI-compatible endpoint), merged into every agent configuration docker-agent loads. Definitions in an agent file win on name conflicts.

type UserProviderArgs

type UserProviderArgs struct {
	// The API flavour of OpenAI-compatible providers: `openai_chatcompletions` (default) or `openai_responses`.
	ApiType ApiTypePtrInput `pulumi:"apiType"`
	// A non-API-key authentication scheme, such as Anthropic workload identity federation.
	Auth UserModelAuthPtrInput `pulumi:"auth"`
	// The API base URL. Required for OpenAI-compatible providers.
	BaseUrl pulumi.StringPtrInput `pulumi:"baseUrl"`
	// Default compaction (summary) model for agents using this provider.
	CompactionModel pulumi.StringPtrInput `pulumi:"compactionModel"`
	// Default frequency penalty.
	FrequencyPenalty pulumi.Float64PtrInput `pulumi:"frequencyPenalty"`
	// Default maximum number of output tokens.
	MaxTokens pulumi.IntPtrInput `pulumi:"maxTokens"`
	// Whether parallel tool calls are enabled by default.
	ParallelToolCalls pulumi.BoolPtrInput `pulumi:"parallelToolCalls"`
	// Default presence penalty.
	PresencePenalty pulumi.Float64PtrInput `pulumi:"presencePenalty"`
	// The underlying provider type: `openai` (default), `anthropic`, `google`, `amazon-bedrock`, `dmr` or a built-in alias.
	Provider pulumi.StringPtrInput `pulumi:"provider"`
	// Provider-specific options, written verbatim (snake_case keys).
	ProviderOpts pulumi.MapInput `pulumi:"providerOpts"`
	// Default total token budget for an agentic task (Anthropic `task_budget`).
	TaskBudget UserTaskBudgetPtrInput `pulumi:"taskBudget"`
	// Default sampling temperature.
	Temperature pulumi.Float64PtrInput `pulumi:"temperature"`
	// Default reasoning effort or token budget.
	ThinkingBudget UserThinkingBudgetPtrInput `pulumi:"thinkingBudget"`
	// The name of the environment variable that holds the API token (not the token itself).
	TokenKey pulumi.StringPtrInput `pulumi:"tokenKey"`
	// Default top-p sampling parameter.
	TopP pulumi.Float64PtrInput `pulumi:"topP"`
	// Whether token usage is tracked by default.
	TrackUsage pulumi.BoolPtrInput `pulumi:"trackUsage"`
	// Path or URL of the provider's model-unload endpoint, used by the `unload` built-in hook. Leave unset for cloud providers.
	UnloadApi pulumi.StringPtrInput `pulumi:"unloadApi"`
}

A reusable model provider (for example an OpenAI-compatible endpoint), merged into every agent configuration docker-agent loads. Definitions in an agent file win on name conflicts.

func (UserProviderArgs) ElementType

func (UserProviderArgs) ElementType() reflect.Type

func (UserProviderArgs) ToUserProviderOutput

func (i UserProviderArgs) ToUserProviderOutput() UserProviderOutput

func (UserProviderArgs) ToUserProviderOutputWithContext

func (i UserProviderArgs) ToUserProviderOutputWithContext(ctx context.Context) UserProviderOutput

type UserProviderInput

type UserProviderInput interface {
	pulumi.Input

	ToUserProviderOutput() UserProviderOutput
	ToUserProviderOutputWithContext(context.Context) UserProviderOutput
}

UserProviderInput is an input type that accepts UserProviderArgs and UserProviderOutput values. You can construct a concrete instance of `UserProviderInput` via:

UserProviderArgs{...}

type UserProviderMap

type UserProviderMap map[string]UserProviderInput

func (UserProviderMap) ElementType

func (UserProviderMap) ElementType() reflect.Type

func (UserProviderMap) ToUserProviderMapOutput

func (i UserProviderMap) ToUserProviderMapOutput() UserProviderMapOutput

func (UserProviderMap) ToUserProviderMapOutputWithContext

func (i UserProviderMap) ToUserProviderMapOutputWithContext(ctx context.Context) UserProviderMapOutput

type UserProviderMapInput

type UserProviderMapInput interface {
	pulumi.Input

	ToUserProviderMapOutput() UserProviderMapOutput
	ToUserProviderMapOutputWithContext(context.Context) UserProviderMapOutput
}

UserProviderMapInput is an input type that accepts UserProviderMap and UserProviderMapOutput values. You can construct a concrete instance of `UserProviderMapInput` via:

UserProviderMap{ "key": UserProviderArgs{...} }

type UserProviderMapOutput

type UserProviderMapOutput struct{ *pulumi.OutputState }

func (UserProviderMapOutput) ElementType

func (UserProviderMapOutput) ElementType() reflect.Type

func (UserProviderMapOutput) MapIndex

func (UserProviderMapOutput) ToUserProviderMapOutput

func (o UserProviderMapOutput) ToUserProviderMapOutput() UserProviderMapOutput

func (UserProviderMapOutput) ToUserProviderMapOutputWithContext

func (o UserProviderMapOutput) ToUserProviderMapOutputWithContext(ctx context.Context) UserProviderMapOutput

type UserProviderOutput

type UserProviderOutput struct{ *pulumi.OutputState }

A reusable model provider (for example an OpenAI-compatible endpoint), merged into every agent configuration docker-agent loads. Definitions in an agent file win on name conflicts.

func (UserProviderOutput) ApiType

The API flavour of OpenAI-compatible providers: `openai_chatcompletions` (default) or `openai_responses`.

func (UserProviderOutput) Auth

A non-API-key authentication scheme, such as Anthropic workload identity federation.

func (UserProviderOutput) BaseUrl

The API base URL. Required for OpenAI-compatible providers.

func (UserProviderOutput) CompactionModel

func (o UserProviderOutput) CompactionModel() pulumi.StringPtrOutput

Default compaction (summary) model for agents using this provider.

func (UserProviderOutput) ElementType

func (UserProviderOutput) ElementType() reflect.Type

func (UserProviderOutput) FrequencyPenalty

func (o UserProviderOutput) FrequencyPenalty() pulumi.Float64PtrOutput

Default frequency penalty.

func (UserProviderOutput) MaxTokens

func (o UserProviderOutput) MaxTokens() pulumi.IntPtrOutput

Default maximum number of output tokens.

func (UserProviderOutput) ParallelToolCalls

func (o UserProviderOutput) ParallelToolCalls() pulumi.BoolPtrOutput

Whether parallel tool calls are enabled by default.

func (UserProviderOutput) PresencePenalty

func (o UserProviderOutput) PresencePenalty() pulumi.Float64PtrOutput

Default presence penalty.

func (UserProviderOutput) Provider

The underlying provider type: `openai` (default), `anthropic`, `google`, `amazon-bedrock`, `dmr` or a built-in alias.

func (UserProviderOutput) ProviderOpts

func (o UserProviderOutput) ProviderOpts() pulumi.MapOutput

Provider-specific options, written verbatim (snake_case keys).

func (UserProviderOutput) TaskBudget

Default total token budget for an agentic task (Anthropic `task_budget`).

func (UserProviderOutput) Temperature

func (o UserProviderOutput) Temperature() pulumi.Float64PtrOutput

Default sampling temperature.

func (UserProviderOutput) ThinkingBudget

Default reasoning effort or token budget.

func (UserProviderOutput) ToUserProviderOutput

func (o UserProviderOutput) ToUserProviderOutput() UserProviderOutput

func (UserProviderOutput) ToUserProviderOutputWithContext

func (o UserProviderOutput) ToUserProviderOutputWithContext(ctx context.Context) UserProviderOutput

func (UserProviderOutput) TokenKey

The name of the environment variable that holds the API token (not the token itself).

func (UserProviderOutput) TopP

Default top-p sampling parameter.

func (UserProviderOutput) TrackUsage

func (o UserProviderOutput) TrackUsage() pulumi.BoolPtrOutput

Whether token usage is tracked by default.

func (UserProviderOutput) UnloadApi

Path or URL of the provider's model-unload endpoint, used by the `unload` built-in hook. Leave unset for cloud providers.

type UserSettings

type UserSettings struct {
	pulumi.CustomResourceState

	// Agent aliases (`aliases:`), keyed by alias name, as created by `docker agent alias add`.
	Aliases UserAliasMapOutput `pulumi:"aliases"`
	// Where the file that already existed at `path` was moved when the resource took it over. Deleting the resource moves it back. Unset when there was no file, and for an imported resource.
	BackupPath pulumi.StringPtrOutput `pulumi:"backupPath"`
	// The `docker agent board` Kanban configuration (`board:`).
	Board UserBoardPtrOutput `pulumi:"board"`
	// A command that supplies the Docker token (`credential_helper:`).
	CredentialHelper UserCredentialHelperPtrOutput `pulumi:"credentialHelper"`
	// The model used when an agent's model is `auto` (`default_model:`).
	DefaultModel UserModelPtrOutput `pulumi:"defaultModel"`
	// Additional top-level keys that this provider version does not model, written verbatim (snake_case keys). They must not repeat a typed input; `version` is always `v1`.
	Extra pulumi.MapOutput `pulumi:"extra"`
	// The absolute path of the written file. Unset when `path` is unset.
	FilePath pulumi.StringPtrOutput `pulumi:"filePath"`
	// The default models gateway address (`models_gateway:`). The `--models-gateway` flag and the `DOCKER_AGENT_MODELS_GATEWAY` environment variable take precedence.
	ModelsGateway pulumi.StringPtrOutput `pulumi:"modelsGateway"`
	// Replace a file that already exists at `path` with different content when the resource is created or `path` changes. Without it, the preview fails instead, so an existing configuration (for example aliases added with `docker agent alias add`) is never lost silently. An existing file is always moved to `<file>.pulumi-backup` first and moved back when the resource is deleted.
	Overwrite pulumi.BoolOutput `pulumi:"overwrite"`
	// Where to write the file, for example `~/.config/cagent/config.yaml`. Resolved on the machine that runs Pulumi: `~` is that user's home directory and relative paths are relative to the Pulumi project directory. A symbolic link is followed and kept. When unset, nothing is written and the resource only renders `yaml`.
	Path pulumi.StringPtrOutput `pulumi:"path"`
	// Global model providers (`providers:`), keyed by name. docker-agent merges them into every agent configuration it loads; an agent file's own definition wins on a name conflict.
	Providers UserProviderMapOutput `pulumi:"providers"`
	// Hosts (with an optional `:port`) opened in the sandbox network proxy on every sandboxed run (`sandbox_allowlist:`), in addition to the hosts docker-agent opens itself and the agent's `runtime.network_allowlist`. Commas and whitespace are rejected.
	SandboxAllowlist pulumi.StringArrayOutput `pulumi:"sandboxAllowlist"`
	// Global preferences (`settings:`): TUI appearance and behaviour, notifications, the default safety mode, global permissions, hooks, keybindings and layout.
	Settings UserGlobalSettingsPtrOutput `pulumi:"settings"`
	// The hex-encoded SHA-256 of `yaml`.
	Sha256 pulumi.StringOutput `pulumi:"sha256"`
	// Skip docker-agent's semantic checks (safety modes, alias names, providers, hooks, TUI options). The document must still decode into docker-agent's types. Use it for values introduced by a docker-agent release newer than v1.150.0.
	SkipValidation pulumi.BoolPtrOutput `pulumi:"skipValidation"`
	// The rendered configuration file, exactly as docker-agent itself writes it. After a refresh it holds the file's current content, so drift shows up in the next diff.
	Yaml pulumi.StringOutput `pulumi:"yaml"`
}

Docker Agent's user configuration: the `~/.config/cagent/config.yaml` file with [user settings](https://docs.docker.com/ai/docker-agent/configuration/user-settings/), aliases, global model providers, the default model, the board, the credential helper and the sandbox allowlist.

`UserSettings` renders its typed inputs with docker-agent's own configuration types, exactly as docker-agent writes the file, and validates them with docker-agent's checks during preview: invalid safety modes, alias names, global providers, hooks, sandbox hosts and TUI options fail before anything is written.

Without `path`, the resource only renders: use the `yaml` output to bake the file into a container image or a Docker Sandboxes kit. With `path`, the provider writes the file there on create and update (atomically, mode 0600, creating missing directories) and reports changes made outside of Pulumi as drift on `pulumi refresh`. The path is resolved on the machine that runs Pulumi; `~` is that user's home directory and relative paths are relative to the Pulumi project directory. docker-agent reads `~/.config/cagent/config.yaml` unless `--config-dir` points elsewhere. A symbolic link at the path (for example from a dotfile manager) is kept: the file it points to is written.

If a file already exists at the path when the resource is created, the preview fails when its content differs from the rendered file, so existing aliases and settings are never replaced silently. Copy what you want to keep into the inputs, or set `overwrite: true`. Either way the existing file is moved to `<file>.pulumi-backup` (output `backupPath`), and deleting the resource moves it back. Deleting the resource removes a file that the provider created, and leaves a file adopted with `pulumi import` in place. Set the `retainOnDelete` resource option to keep the file.

The resource owns the whole file. Changes docker-agent makes itself (`docker agent alias add`, the TUI's `/settings` dialog, `docker agent sandbox allow`) show up as drift and are reverted by the next `pulumi up --refresh`, so manage those settings here instead.

The file configures the `docker agent` CLI. `AgentRun` reads none of it: each run uses private docker-agent directories, so its aliases, global providers, default model, models gateway and credential helper do not apply there. Declare providers in the agent configuration and pass keys in the `env` input of `AgentRun` instead.

## Example Usage ### Write the user configuration ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Docker Agent's user configuration, validated with docker-agent's own checks.
		settings, err := dockeragent.NewUserSettings(ctx, "settings", &dockeragent.UserSettingsArgs{
			Path: pulumi.String("~/.config/cagent/config.yaml"),
			Settings: &dockeragent.UserGlobalSettingsArgs{
				Theme:     pulumi.String("auto"),
				ThemeDark: pulumi.String("dracula"),
				Safety:    dockeragent.SafetyModeBalanced,
				Sound:     pulumi.Bool(true),
				Layout: &dockeragent.UserLayoutSettingsArgs{
					SidebarPosition: dockeragent.SidebarPositionLeft,
					HideUsage:       pulumi.Bool(true),
				},
				Permissions: &dockeragent.UserPermissionsArgs{
					Deny: pulumi.StringArray{
						pulumi.String("shell:cmd=sudo*"),
					},
					Allow: pulumi.StringArray{
						pulumi.String("read_*"),
					},
				},
				Keybindings: dockeragent.UserKeybindingArray{
					&dockeragent.UserKeybindingArgs{
						Action: pulumi.String("commands"),
						Keys: pulumi.StringArray{
							pulumi.String("f2"),
							pulumi.String("ctrl+k"),
						},
					},
				},
			},
			Aliases: dockeragent.UserAliasMap{
				"reviewer": &dockeragent.UserAliasArgs{
					Path:   pulumi.String("docker.io/myorg/reviewer:latest"),
					Safety: dockeragent.SafetyModeRestricted,
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("configPath", settings.FilePath)
		ctx.Export("configSha256", settings.Sha256)
		return nil
	})
}

``` ### Render only, with a global provider and hooks ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// No `path`: nothing is written. Use the YAML in a Dockerfile, a sandbox kit or a ConfigMap.
		rendered, err := dockeragent.NewUserSettings(ctx, "rendered", &dockeragent.UserSettingsArgs{
			Providers: dockeragent.UserProviderMap{
				"gateway": &dockeragent.UserProviderArgs{
					BaseUrl:  pulumi.String("https://llm.example.com/v1"),
					TokenKey: pulumi.String("GATEWAY_API_KEY"),
				},
			},
			DefaultModel: &dockeragent.UserModelArgs{
				Provider: pulumi.String("gateway"),
				Model:    pulumi.String("qwen3-coder"),
			},
			SandboxAllowlist: pulumi.StringArray{
				pulumi.String("registry.npmjs.org:443"),
			},
			Settings: &dockeragent.UserGlobalSettingsArgs{
				Hooks: &dockeragent.UserHooksArgs{
					SessionStart: dockeragent.UserHookArray{
						&dockeragent.UserHookArgs{
							Type:    dockeragent.HookTypeCommand,
							Command: pulumi.String("~/.config/cagent/hooks/session-start.sh"),
						},
					},
					PreToolUse: dockeragent.UserHookMatcherArray{
						&dockeragent.UserHookMatcherArgs{
							Matcher: pulumi.String("shell"),
							Hooks: dockeragent.UserHookArray{
								&dockeragent.UserHookArgs{
									Type:    dockeragent.HookTypeBuiltin,
									Command: pulumi.String("redact_secrets"),
								},
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("userConfigYaml", rendered.Yaml)
		return nil
	})
}

```

## Import

An existing user configuration can be imported with its path (or `file://<path>`) as ID. It is read with docker-agent's own types, and `pulumi import` generates the typed inputs, `path` included. The file is adopted: the import writes nothing and takes no backup, `overwrite` is not needed, and deleting the resource leaves the file in place (with the content Pulumi last wrote) instead of removing it. The resource ID is the file's absolute path.

```sh $ pulumi import docker-agent:index:UserSettings settings ~/.config/cagent/config.yaml ```

func GetUserSettings

func GetUserSettings(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UserSettingsState, opts ...pulumi.ResourceOption) (*UserSettings, error)

GetUserSettings gets an existing UserSettings resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUserSettings

func NewUserSettings(ctx *pulumi.Context,
	name string, args *UserSettingsArgs, opts ...pulumi.ResourceOption) (*UserSettings, error)

NewUserSettings registers a new resource with the given unique name, arguments, and options.

func (*UserSettings) ElementType

func (*UserSettings) ElementType() reflect.Type

func (*UserSettings) ToUserSettingsOutput

func (i *UserSettings) ToUserSettingsOutput() UserSettingsOutput

func (*UserSettings) ToUserSettingsOutputWithContext

func (i *UserSettings) ToUserSettingsOutputWithContext(ctx context.Context) UserSettingsOutput

type UserSettingsArgs

type UserSettingsArgs struct {
	// Agent aliases (`aliases:`), keyed by alias name, as created by `docker agent alias add`.
	Aliases UserAliasMapInput
	// The `docker agent board` Kanban configuration (`board:`).
	Board UserBoardPtrInput
	// A command that supplies the Docker token (`credential_helper:`).
	CredentialHelper UserCredentialHelperPtrInput
	// The model used when an agent's model is `auto` (`default_model:`).
	DefaultModel UserModelPtrInput
	// Additional top-level keys that this provider version does not model, written verbatim (snake_case keys). They must not repeat a typed input; `version` is always `v1`.
	Extra pulumi.MapInput
	// The default models gateway address (`models_gateway:`). The `--models-gateway` flag and the `DOCKER_AGENT_MODELS_GATEWAY` environment variable take precedence.
	ModelsGateway pulumi.StringPtrInput
	// Replace a file that already exists at `path` with different content when the resource is created or `path` changes. Without it, the preview fails instead, so an existing configuration (for example aliases added with `docker agent alias add`) is never lost silently. An existing file is always moved to `<file>.pulumi-backup` first and moved back when the resource is deleted.
	Overwrite pulumi.BoolPtrInput
	// Where to write the file, for example `~/.config/cagent/config.yaml`. Resolved on the machine that runs Pulumi: `~` is that user's home directory and relative paths are relative to the Pulumi project directory. A symbolic link is followed and kept. When unset, nothing is written and the resource only renders `yaml`.
	Path pulumi.StringPtrInput
	// Global model providers (`providers:`), keyed by name. docker-agent merges them into every agent configuration it loads; an agent file's own definition wins on a name conflict.
	Providers UserProviderMapInput
	// Hosts (with an optional `:port`) opened in the sandbox network proxy on every sandboxed run (`sandbox_allowlist:`), in addition to the hosts docker-agent opens itself and the agent's `runtime.network_allowlist`. Commas and whitespace are rejected.
	SandboxAllowlist pulumi.StringArrayInput
	// Global preferences (`settings:`): TUI appearance and behaviour, notifications, the default safety mode, global permissions, hooks, keybindings and layout.
	Settings UserGlobalSettingsPtrInput
	// Skip docker-agent's semantic checks (safety modes, alias names, providers, hooks, TUI options). The document must still decode into docker-agent's types. Use it for values introduced by a docker-agent release newer than v1.150.0.
	SkipValidation pulumi.BoolPtrInput
}

The set of arguments for constructing a UserSettings resource.

func (UserSettingsArgs) ElementType

func (UserSettingsArgs) ElementType() reflect.Type

type UserSettingsArray

type UserSettingsArray []UserSettingsInput

func (UserSettingsArray) ElementType

func (UserSettingsArray) ElementType() reflect.Type

func (UserSettingsArray) ToUserSettingsArrayOutput

func (i UserSettingsArray) ToUserSettingsArrayOutput() UserSettingsArrayOutput

func (UserSettingsArray) ToUserSettingsArrayOutputWithContext

func (i UserSettingsArray) ToUserSettingsArrayOutputWithContext(ctx context.Context) UserSettingsArrayOutput

type UserSettingsArrayInput

type UserSettingsArrayInput interface {
	pulumi.Input

	ToUserSettingsArrayOutput() UserSettingsArrayOutput
	ToUserSettingsArrayOutputWithContext(context.Context) UserSettingsArrayOutput
}

UserSettingsArrayInput is an input type that accepts UserSettingsArray and UserSettingsArrayOutput values. You can construct a concrete instance of `UserSettingsArrayInput` via:

UserSettingsArray{ UserSettingsArgs{...} }

type UserSettingsArrayOutput

type UserSettingsArrayOutput struct{ *pulumi.OutputState }

func (UserSettingsArrayOutput) ElementType

func (UserSettingsArrayOutput) ElementType() reflect.Type

func (UserSettingsArrayOutput) Index

func (UserSettingsArrayOutput) ToUserSettingsArrayOutput

func (o UserSettingsArrayOutput) ToUserSettingsArrayOutput() UserSettingsArrayOutput

func (UserSettingsArrayOutput) ToUserSettingsArrayOutputWithContext

func (o UserSettingsArrayOutput) ToUserSettingsArrayOutputWithContext(ctx context.Context) UserSettingsArrayOutput

type UserSettingsInput

type UserSettingsInput interface {
	pulumi.Input

	ToUserSettingsOutput() UserSettingsOutput
	ToUserSettingsOutputWithContext(ctx context.Context) UserSettingsOutput
}

type UserSettingsMap

type UserSettingsMap map[string]UserSettingsInput

func (UserSettingsMap) ElementType

func (UserSettingsMap) ElementType() reflect.Type

func (UserSettingsMap) ToUserSettingsMapOutput

func (i UserSettingsMap) ToUserSettingsMapOutput() UserSettingsMapOutput

func (UserSettingsMap) ToUserSettingsMapOutputWithContext

func (i UserSettingsMap) ToUserSettingsMapOutputWithContext(ctx context.Context) UserSettingsMapOutput

type UserSettingsMapInput

type UserSettingsMapInput interface {
	pulumi.Input

	ToUserSettingsMapOutput() UserSettingsMapOutput
	ToUserSettingsMapOutputWithContext(context.Context) UserSettingsMapOutput
}

UserSettingsMapInput is an input type that accepts UserSettingsMap and UserSettingsMapOutput values. You can construct a concrete instance of `UserSettingsMapInput` via:

UserSettingsMap{ "key": UserSettingsArgs{...} }

type UserSettingsMapOutput

type UserSettingsMapOutput struct{ *pulumi.OutputState }

func (UserSettingsMapOutput) ElementType

func (UserSettingsMapOutput) ElementType() reflect.Type

func (UserSettingsMapOutput) MapIndex

func (UserSettingsMapOutput) ToUserSettingsMapOutput

func (o UserSettingsMapOutput) ToUserSettingsMapOutput() UserSettingsMapOutput

func (UserSettingsMapOutput) ToUserSettingsMapOutputWithContext

func (o UserSettingsMapOutput) ToUserSettingsMapOutputWithContext(ctx context.Context) UserSettingsMapOutput

type UserSettingsOutput

type UserSettingsOutput struct{ *pulumi.OutputState }

func (UserSettingsOutput) Aliases

Agent aliases (`aliases:`), keyed by alias name, as created by `docker agent alias add`.

func (UserSettingsOutput) BackupPath

func (o UserSettingsOutput) BackupPath() pulumi.StringPtrOutput

Where the file that already existed at `path` was moved when the resource took it over. Deleting the resource moves it back. Unset when there was no file, and for an imported resource.

func (UserSettingsOutput) Board

The `docker agent board` Kanban configuration (`board:`).

func (UserSettingsOutput) CredentialHelper

A command that supplies the Docker token (`credential_helper:`).

func (UserSettingsOutput) DefaultModel

func (o UserSettingsOutput) DefaultModel() UserModelPtrOutput

The model used when an agent's model is `auto` (`default_model:`).

func (UserSettingsOutput) ElementType

func (UserSettingsOutput) ElementType() reflect.Type

func (UserSettingsOutput) Extra

Additional top-level keys that this provider version does not model, written verbatim (snake_case keys). They must not repeat a typed input; `version` is always `v1`.

func (UserSettingsOutput) FilePath

The absolute path of the written file. Unset when `path` is unset.

func (UserSettingsOutput) ModelsGateway

func (o UserSettingsOutput) ModelsGateway() pulumi.StringPtrOutput

The default models gateway address (`models_gateway:`). The `--models-gateway` flag and the `DOCKER_AGENT_MODELS_GATEWAY` environment variable take precedence.

func (UserSettingsOutput) Overwrite

func (o UserSettingsOutput) Overwrite() pulumi.BoolOutput

Replace a file that already exists at `path` with different content when the resource is created or `path` changes. Without it, the preview fails instead, so an existing configuration (for example aliases added with `docker agent alias add`) is never lost silently. An existing file is always moved to `<file>.pulumi-backup` first and moved back when the resource is deleted.

func (UserSettingsOutput) Path

Where to write the file, for example `~/.config/cagent/config.yaml`. Resolved on the machine that runs Pulumi: `~` is that user's home directory and relative paths are relative to the Pulumi project directory. A symbolic link is followed and kept. When unset, nothing is written and the resource only renders `yaml`.

func (UserSettingsOutput) Providers

Global model providers (`providers:`), keyed by name. docker-agent merges them into every agent configuration it loads; an agent file's own definition wins on a name conflict.

func (UserSettingsOutput) SandboxAllowlist

func (o UserSettingsOutput) SandboxAllowlist() pulumi.StringArrayOutput

Hosts (with an optional `:port`) opened in the sandbox network proxy on every sandboxed run (`sandbox_allowlist:`), in addition to the hosts docker-agent opens itself and the agent's `runtime.network_allowlist`. Commas and whitespace are rejected.

func (UserSettingsOutput) Settings

Global preferences (`settings:`): TUI appearance and behaviour, notifications, the default safety mode, global permissions, hooks, keybindings and layout.

func (UserSettingsOutput) Sha256

The hex-encoded SHA-256 of `yaml`.

func (UserSettingsOutput) SkipValidation

func (o UserSettingsOutput) SkipValidation() pulumi.BoolPtrOutput

Skip docker-agent's semantic checks (safety modes, alias names, providers, hooks, TUI options). The document must still decode into docker-agent's types. Use it for values introduced by a docker-agent release newer than v1.150.0.

func (UserSettingsOutput) ToUserSettingsOutput

func (o UserSettingsOutput) ToUserSettingsOutput() UserSettingsOutput

func (UserSettingsOutput) ToUserSettingsOutputWithContext

func (o UserSettingsOutput) ToUserSettingsOutputWithContext(ctx context.Context) UserSettingsOutput

func (UserSettingsOutput) Yaml

The rendered configuration file, exactly as docker-agent itself writes it. After a refresh it holds the file's current content, so drift shows up in the next diff.

type UserSettingsState

type UserSettingsState struct {
}

func (UserSettingsState) ElementType

func (UserSettingsState) ElementType() reflect.Type

type UserTaskBudget

type UserTaskBudget struct {
	// The total budget, in tokens.
	Total int `pulumi:"total"`
	// The budget kind. Only `tokens` (default) is supported.
	Type *string `pulumi:"type"`
}

A total budget for an agentic task. `0` disables it.

type UserTaskBudgetArgs

type UserTaskBudgetArgs struct {
	// The total budget, in tokens.
	Total pulumi.IntInput `pulumi:"total"`
	// The budget kind. Only `tokens` (default) is supported.
	Type pulumi.StringPtrInput `pulumi:"type"`
}

A total budget for an agentic task. `0` disables it.

func (UserTaskBudgetArgs) ElementType

func (UserTaskBudgetArgs) ElementType() reflect.Type

func (UserTaskBudgetArgs) ToUserTaskBudgetOutput

func (i UserTaskBudgetArgs) ToUserTaskBudgetOutput() UserTaskBudgetOutput

func (UserTaskBudgetArgs) ToUserTaskBudgetOutputWithContext

func (i UserTaskBudgetArgs) ToUserTaskBudgetOutputWithContext(ctx context.Context) UserTaskBudgetOutput

func (UserTaskBudgetArgs) ToUserTaskBudgetPtrOutput

func (i UserTaskBudgetArgs) ToUserTaskBudgetPtrOutput() UserTaskBudgetPtrOutput

func (UserTaskBudgetArgs) ToUserTaskBudgetPtrOutputWithContext

func (i UserTaskBudgetArgs) ToUserTaskBudgetPtrOutputWithContext(ctx context.Context) UserTaskBudgetPtrOutput

type UserTaskBudgetInput

type UserTaskBudgetInput interface {
	pulumi.Input

	ToUserTaskBudgetOutput() UserTaskBudgetOutput
	ToUserTaskBudgetOutputWithContext(context.Context) UserTaskBudgetOutput
}

UserTaskBudgetInput is an input type that accepts UserTaskBudgetArgs and UserTaskBudgetOutput values. You can construct a concrete instance of `UserTaskBudgetInput` via:

UserTaskBudgetArgs{...}

type UserTaskBudgetOutput

type UserTaskBudgetOutput struct{ *pulumi.OutputState }

A total budget for an agentic task. `0` disables it.

func (UserTaskBudgetOutput) ElementType

func (UserTaskBudgetOutput) ElementType() reflect.Type

func (UserTaskBudgetOutput) ToUserTaskBudgetOutput

func (o UserTaskBudgetOutput) ToUserTaskBudgetOutput() UserTaskBudgetOutput

func (UserTaskBudgetOutput) ToUserTaskBudgetOutputWithContext

func (o UserTaskBudgetOutput) ToUserTaskBudgetOutputWithContext(ctx context.Context) UserTaskBudgetOutput

func (UserTaskBudgetOutput) ToUserTaskBudgetPtrOutput

func (o UserTaskBudgetOutput) ToUserTaskBudgetPtrOutput() UserTaskBudgetPtrOutput

func (UserTaskBudgetOutput) ToUserTaskBudgetPtrOutputWithContext

func (o UserTaskBudgetOutput) ToUserTaskBudgetPtrOutputWithContext(ctx context.Context) UserTaskBudgetPtrOutput

func (UserTaskBudgetOutput) Total

The total budget, in tokens.

func (UserTaskBudgetOutput) Type

The budget kind. Only `tokens` (default) is supported.

type UserTaskBudgetPtrInput

type UserTaskBudgetPtrInput interface {
	pulumi.Input

	ToUserTaskBudgetPtrOutput() UserTaskBudgetPtrOutput
	ToUserTaskBudgetPtrOutputWithContext(context.Context) UserTaskBudgetPtrOutput
}

UserTaskBudgetPtrInput is an input type that accepts UserTaskBudgetArgs, UserTaskBudgetPtr and UserTaskBudgetPtrOutput values. You can construct a concrete instance of `UserTaskBudgetPtrInput` via:

        UserTaskBudgetArgs{...}

or:

        nil

type UserTaskBudgetPtrOutput

type UserTaskBudgetPtrOutput struct{ *pulumi.OutputState }

func (UserTaskBudgetPtrOutput) Elem

func (UserTaskBudgetPtrOutput) ElementType

func (UserTaskBudgetPtrOutput) ElementType() reflect.Type

func (UserTaskBudgetPtrOutput) ToUserTaskBudgetPtrOutput

func (o UserTaskBudgetPtrOutput) ToUserTaskBudgetPtrOutput() UserTaskBudgetPtrOutput

func (UserTaskBudgetPtrOutput) ToUserTaskBudgetPtrOutputWithContext

func (o UserTaskBudgetPtrOutput) ToUserTaskBudgetPtrOutputWithContext(ctx context.Context) UserTaskBudgetPtrOutput

func (UserTaskBudgetPtrOutput) Total

The total budget, in tokens.

func (UserTaskBudgetPtrOutput) Type

The budget kind. Only `tokens` (default) is supported.

type UserThinkingBudget

type UserThinkingBudget struct {
	// An effort level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<effort>`.
	Effort *string `pulumi:"effort"`
	// A token budget. `0` disables thinking, `-1` lets the provider decide.
	Tokens *int `pulumi:"tokens"`
}

A reasoning budget. Set exactly one of `effort` and `tokens`.

type UserThinkingBudgetArgs

type UserThinkingBudgetArgs struct {
	// An effort level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<effort>`.
	Effort pulumi.StringPtrInput `pulumi:"effort"`
	// A token budget. `0` disables thinking, `-1` lets the provider decide.
	Tokens pulumi.IntPtrInput `pulumi:"tokens"`
}

A reasoning budget. Set exactly one of `effort` and `tokens`.

func (UserThinkingBudgetArgs) ElementType

func (UserThinkingBudgetArgs) ElementType() reflect.Type

func (UserThinkingBudgetArgs) ToUserThinkingBudgetOutput

func (i UserThinkingBudgetArgs) ToUserThinkingBudgetOutput() UserThinkingBudgetOutput

func (UserThinkingBudgetArgs) ToUserThinkingBudgetOutputWithContext

func (i UserThinkingBudgetArgs) ToUserThinkingBudgetOutputWithContext(ctx context.Context) UserThinkingBudgetOutput

func (UserThinkingBudgetArgs) ToUserThinkingBudgetPtrOutput

func (i UserThinkingBudgetArgs) ToUserThinkingBudgetPtrOutput() UserThinkingBudgetPtrOutput

func (UserThinkingBudgetArgs) ToUserThinkingBudgetPtrOutputWithContext

func (i UserThinkingBudgetArgs) ToUserThinkingBudgetPtrOutputWithContext(ctx context.Context) UserThinkingBudgetPtrOutput

type UserThinkingBudgetInput

type UserThinkingBudgetInput interface {
	pulumi.Input

	ToUserThinkingBudgetOutput() UserThinkingBudgetOutput
	ToUserThinkingBudgetOutputWithContext(context.Context) UserThinkingBudgetOutput
}

UserThinkingBudgetInput is an input type that accepts UserThinkingBudgetArgs and UserThinkingBudgetOutput values. You can construct a concrete instance of `UserThinkingBudgetInput` via:

UserThinkingBudgetArgs{...}

type UserThinkingBudgetOutput

type UserThinkingBudgetOutput struct{ *pulumi.OutputState }

A reasoning budget. Set exactly one of `effort` and `tokens`.

func (UserThinkingBudgetOutput) Effort

An effort level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<effort>`.

func (UserThinkingBudgetOutput) ElementType

func (UserThinkingBudgetOutput) ElementType() reflect.Type

func (UserThinkingBudgetOutput) ToUserThinkingBudgetOutput

func (o UserThinkingBudgetOutput) ToUserThinkingBudgetOutput() UserThinkingBudgetOutput

func (UserThinkingBudgetOutput) ToUserThinkingBudgetOutputWithContext

func (o UserThinkingBudgetOutput) ToUserThinkingBudgetOutputWithContext(ctx context.Context) UserThinkingBudgetOutput

func (UserThinkingBudgetOutput) ToUserThinkingBudgetPtrOutput

func (o UserThinkingBudgetOutput) ToUserThinkingBudgetPtrOutput() UserThinkingBudgetPtrOutput

func (UserThinkingBudgetOutput) ToUserThinkingBudgetPtrOutputWithContext

func (o UserThinkingBudgetOutput) ToUserThinkingBudgetPtrOutputWithContext(ctx context.Context) UserThinkingBudgetPtrOutput

func (UserThinkingBudgetOutput) Tokens

A token budget. `0` disables thinking, `-1` lets the provider decide.

type UserThinkingBudgetPtrInput

type UserThinkingBudgetPtrInput interface {
	pulumi.Input

	ToUserThinkingBudgetPtrOutput() UserThinkingBudgetPtrOutput
	ToUserThinkingBudgetPtrOutputWithContext(context.Context) UserThinkingBudgetPtrOutput
}

UserThinkingBudgetPtrInput is an input type that accepts UserThinkingBudgetArgs, UserThinkingBudgetPtr and UserThinkingBudgetPtrOutput values. You can construct a concrete instance of `UserThinkingBudgetPtrInput` via:

        UserThinkingBudgetArgs{...}

or:

        nil

type UserThinkingBudgetPtrOutput

type UserThinkingBudgetPtrOutput struct{ *pulumi.OutputState }

func (UserThinkingBudgetPtrOutput) Effort

An effort level: `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, `max`, `adaptive` or `adaptive/<effort>`.

func (UserThinkingBudgetPtrOutput) Elem

func (UserThinkingBudgetPtrOutput) ElementType

func (UserThinkingBudgetPtrOutput) ToUserThinkingBudgetPtrOutput

func (o UserThinkingBudgetPtrOutput) ToUserThinkingBudgetPtrOutput() UserThinkingBudgetPtrOutput

func (UserThinkingBudgetPtrOutput) ToUserThinkingBudgetPtrOutputWithContext

func (o UserThinkingBudgetPtrOutput) ToUserThinkingBudgetPtrOutputWithContext(ctx context.Context) UserThinkingBudgetPtrOutput

func (UserThinkingBudgetPtrOutput) Tokens

A token budget. `0` disables thinking, `-1` lets the provider decide.

type ValidateAgentConfigArgs

type ValidateAgentConfigArgs struct {
	// The docker-agent YAML document to validate.
	Yaml string `pulumi:"yaml"`
}

type ValidateAgentConfigOutputArgs

type ValidateAgentConfigOutputArgs struct {
	// The docker-agent YAML document to validate.
	Yaml pulumi.StringInput `pulumi:"yaml"`
}

func (ValidateAgentConfigOutputArgs) ElementType

type ValidateAgentConfigResult

type ValidateAgentConfigResult struct {
	// The agent names, in order (also reported for invalid documents when they can be parsed).
	AgentNames []string `pulumi:"agentNames"`
	// The agent docker-agent starts by default: `root` if an agent has that name, else the first agent.
	DefaultAgent string `pulumi:"defaultAgent"`
	// Why the document is invalid. Empty when `valid` is true.
	Errors []string `pulumi:"errors"`
	// Best effort list of the environment variables the configured models need at run time. Only computed for valid documents.
	RequiredEnvVars []string `pulumi:"requiredEnvVars"`
	// Whether the document is a valid docker-agent configuration.
	Valid bool `pulumi:"valid"`
}

func ValidateAgentConfig

func ValidateAgentConfig(ctx *pulumi.Context, args *ValidateAgentConfigArgs, opts ...pulumi.InvokeOption) (*ValidateAgentConfigResult, error)

Validates a Docker Agent YAML document with the docker-agent library the provider is built with (v1.150.0), the same checks `docker agent debug config` runs plus a check for unknown toolset types and model providers.

Use it for agent files you keep as raw YAML. The function never fails on an invalid document; it returns `valid: false` and the reasons in `errors`: every independent problem, not only the first one docker-agent stops at.

## Example Usage ### Validate an agent file ```go package main

import (

"os"

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func readFileOrPanic(path string) string {
	data, err := os.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return string(data)
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// An agent file kept as raw YAML next to the program.
		agentFile := readFileOrPanic("./agent.yaml")

		// Never fails on an invalid document: check `valid` and `errors`.
		result := dockeragent.ValidateAgentConfigOutput(ctx, dockeragent.ValidateAgentConfigOutputArgs{
			Yaml: pulumi.String(agentFile),
		}, nil)
		ctx.Export("valid", result.Valid())
		ctx.Export("errors", result.Errors())
		ctx.Export("requiredEnvVars", result.RequiredEnvVars())
		return nil
	})
}

``` ### Validate a shared agent before running it ```go package main

import (

"github.com/dirien/pulumi-docker-agent/sdk/go/dockeragent"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		shared := dockeragent.GetAgentOutput(ctx, dockeragent.GetAgentOutputArgs{
			Reference: pulumi.String("docker.io/my-org/assistant:latest"),
		}, nil)

		// Checks the pulled configuration against the docker-agent version of the provider.
		check := dockeragent.ValidateAgentConfigOutput(ctx, dockeragent.ValidateAgentConfigOutputArgs{
			Yaml: shared.Yaml(),
		}, nil)
		ctx.Export("valid", check.Valid())
		ctx.Export("errors", check.Errors())
		ctx.Export("agentNames", check.AgentNames())
		return nil
	})
}

```

type ValidateAgentConfigResultOutput

type ValidateAgentConfigResultOutput struct{ *pulumi.OutputState }

func (ValidateAgentConfigResultOutput) AgentNames

The agent names, in order (also reported for invalid documents when they can be parsed).

func (ValidateAgentConfigResultOutput) DefaultAgent

The agent docker-agent starts by default: `root` if an agent has that name, else the first agent.

func (ValidateAgentConfigResultOutput) ElementType

func (ValidateAgentConfigResultOutput) Errors

Why the document is invalid. Empty when `valid` is true.

func (ValidateAgentConfigResultOutput) RequiredEnvVars

Best effort list of the environment variables the configured models need at run time. Only computed for valid documents.

func (ValidateAgentConfigResultOutput) ToValidateAgentConfigResultOutput

func (o ValidateAgentConfigResultOutput) ToValidateAgentConfigResultOutput() ValidateAgentConfigResultOutput

func (ValidateAgentConfigResultOutput) ToValidateAgentConfigResultOutputWithContext

func (o ValidateAgentConfigResultOutput) ToValidateAgentConfigResultOutputWithContext(ctx context.Context) ValidateAgentConfigResultOutput

func (ValidateAgentConfigResultOutput) Valid

Whether the document is a valid docker-agent configuration.

type WebhookConfig

type WebhookConfig struct {
	// Destination chat id (provider: telegram)
	ChatId *string `pulumi:"chatId"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// HTTP headers sent with the request; use ${env.VAR} for tokens
	Headers map[string]string `pulumi:"headers"`
	// Payload shape for the target service. Allowed values: `slack`, `discord`, `ifttt`, `telegram`, `mattermost`, `rocketchat`, `googlechat`, `teams`, `generic`.
	Provider *string `pulumi:"provider"`
	// Webhook endpoint URL. Usually embeds a secret, so prefer ${env.VAR}
	Url string `pulumi:"url"`
}

Webhook tool configuration: delivery destination and credentials

type WebhookConfigArgs

type WebhookConfigArgs struct {
	// Destination chat id (provider: telegram)
	ChatId pulumi.StringPtrInput `pulumi:"chatId"`
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// HTTP headers sent with the request; use ${env.VAR} for tokens
	Headers pulumi.StringMapInput `pulumi:"headers"`
	// Payload shape for the target service. Allowed values: `slack`, `discord`, `ifttt`, `telegram`, `mattermost`, `rocketchat`, `googlechat`, `teams`, `generic`.
	Provider pulumi.StringPtrInput `pulumi:"provider"`
	// Webhook endpoint URL. Usually embeds a secret, so prefer ${env.VAR}
	Url pulumi.StringInput `pulumi:"url"`
}

Webhook tool configuration: delivery destination and credentials

func (WebhookConfigArgs) ElementType

func (WebhookConfigArgs) ElementType() reflect.Type

func (WebhookConfigArgs) ToWebhookConfigOutput

func (i WebhookConfigArgs) ToWebhookConfigOutput() WebhookConfigOutput

func (WebhookConfigArgs) ToWebhookConfigOutputWithContext

func (i WebhookConfigArgs) ToWebhookConfigOutputWithContext(ctx context.Context) WebhookConfigOutput

func (WebhookConfigArgs) ToWebhookConfigPtrOutput

func (i WebhookConfigArgs) ToWebhookConfigPtrOutput() WebhookConfigPtrOutput

func (WebhookConfigArgs) ToWebhookConfigPtrOutputWithContext

func (i WebhookConfigArgs) ToWebhookConfigPtrOutputWithContext(ctx context.Context) WebhookConfigPtrOutput

type WebhookConfigInput

type WebhookConfigInput interface {
	pulumi.Input

	ToWebhookConfigOutput() WebhookConfigOutput
	ToWebhookConfigOutputWithContext(context.Context) WebhookConfigOutput
}

WebhookConfigInput is an input type that accepts WebhookConfigArgs and WebhookConfigOutput values. You can construct a concrete instance of `WebhookConfigInput` via:

WebhookConfigArgs{...}

type WebhookConfigOutput

type WebhookConfigOutput struct{ *pulumi.OutputState }

Webhook tool configuration: delivery destination and credentials

func (WebhookConfigOutput) ChatId

Destination chat id (provider: telegram)

func (WebhookConfigOutput) ElementType

func (WebhookConfigOutput) ElementType() reflect.Type

func (WebhookConfigOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (WebhookConfigOutput) Headers

HTTP headers sent with the request; use ${env.VAR} for tokens

func (WebhookConfigOutput) Provider

Payload shape for the target service. Allowed values: `slack`, `discord`, `ifttt`, `telegram`, `mattermost`, `rocketchat`, `googlechat`, `teams`, `generic`.

func (WebhookConfigOutput) ToWebhookConfigOutput

func (o WebhookConfigOutput) ToWebhookConfigOutput() WebhookConfigOutput

func (WebhookConfigOutput) ToWebhookConfigOutputWithContext

func (o WebhookConfigOutput) ToWebhookConfigOutputWithContext(ctx context.Context) WebhookConfigOutput

func (WebhookConfigOutput) ToWebhookConfigPtrOutput

func (o WebhookConfigOutput) ToWebhookConfigPtrOutput() WebhookConfigPtrOutput

func (WebhookConfigOutput) ToWebhookConfigPtrOutputWithContext

func (o WebhookConfigOutput) ToWebhookConfigPtrOutputWithContext(ctx context.Context) WebhookConfigPtrOutput

func (WebhookConfigOutput) Url

Webhook endpoint URL. Usually embeds a secret, so prefer ${env.VAR}

type WebhookConfigPtrInput

type WebhookConfigPtrInput interface {
	pulumi.Input

	ToWebhookConfigPtrOutput() WebhookConfigPtrOutput
	ToWebhookConfigPtrOutputWithContext(context.Context) WebhookConfigPtrOutput
}

WebhookConfigPtrInput is an input type that accepts WebhookConfigArgs, WebhookConfigPtr and WebhookConfigPtrOutput values. You can construct a concrete instance of `WebhookConfigPtrInput` via:

        WebhookConfigArgs{...}

or:

        nil

type WebhookConfigPtrOutput

type WebhookConfigPtrOutput struct{ *pulumi.OutputState }

func (WebhookConfigPtrOutput) ChatId

Destination chat id (provider: telegram)

func (WebhookConfigPtrOutput) Elem

func (WebhookConfigPtrOutput) ElementType

func (WebhookConfigPtrOutput) ElementType() reflect.Type

func (WebhookConfigPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (WebhookConfigPtrOutput) Headers

HTTP headers sent with the request; use ${env.VAR} for tokens

func (WebhookConfigPtrOutput) Provider

Payload shape for the target service. Allowed values: `slack`, `discord`, `ifttt`, `telegram`, `mattermost`, `rocketchat`, `googlechat`, `teams`, `generic`.

func (WebhookConfigPtrOutput) ToWebhookConfigPtrOutput

func (o WebhookConfigPtrOutput) ToWebhookConfigPtrOutput() WebhookConfigPtrOutput

func (WebhookConfigPtrOutput) ToWebhookConfigPtrOutputWithContext

func (o WebhookConfigPtrOutput) ToWebhookConfigPtrOutputWithContext(ctx context.Context) WebhookConfigPtrOutput

func (WebhookConfigPtrOutput) Url

Webhook endpoint URL. Usually embeds a secret, so prefer ${env.VAR}

type WorkloadIdentityFederation

type WorkloadIdentityFederation struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra map[string]interface{} `pulumi:"extra"`
	// Anthropic OidcFederationRule ID. Must start with 'fdrl_'.
	FederationRuleId string `pulumi:"federationRuleId"`
	// How to obtain a fresh JWT identity token for each token exchange.
	IdentityToken IdentityTokenSource `pulumi:"identityToken"`
	// UUID of the Anthropic organization that owns the federation rule.
	OrganizationId string `pulumi:"organizationId"`
	// Optional expected-target check for federation rules with target_type=SERVICE_ACCOUNT. Must start with 'svac_'.
	ServiceAccountId *string `pulumi:"serviceAccountId"`
}

Anthropic OIDC Federation Rule parameters and the source of the JWT identity token to exchange. See https://platform.claude.com/docs/en/build-with-claude/workload-identity-federation

type WorkloadIdentityFederationArgs

type WorkloadIdentityFederationArgs struct {
	// Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.
	Extra pulumi.MapInput `pulumi:"extra"`
	// Anthropic OidcFederationRule ID. Must start with 'fdrl_'.
	FederationRuleId pulumi.StringInput `pulumi:"federationRuleId"`
	// How to obtain a fresh JWT identity token for each token exchange.
	IdentityToken IdentityTokenSourceInput `pulumi:"identityToken"`
	// UUID of the Anthropic organization that owns the federation rule.
	OrganizationId pulumi.StringInput `pulumi:"organizationId"`
	// Optional expected-target check for federation rules with target_type=SERVICE_ACCOUNT. Must start with 'svac_'.
	ServiceAccountId pulumi.StringPtrInput `pulumi:"serviceAccountId"`
}

Anthropic OIDC Federation Rule parameters and the source of the JWT identity token to exchange. See https://platform.claude.com/docs/en/build-with-claude/workload-identity-federation

func (WorkloadIdentityFederationArgs) ElementType

func (WorkloadIdentityFederationArgs) ToWorkloadIdentityFederationOutput

func (i WorkloadIdentityFederationArgs) ToWorkloadIdentityFederationOutput() WorkloadIdentityFederationOutput

func (WorkloadIdentityFederationArgs) ToWorkloadIdentityFederationOutputWithContext

func (i WorkloadIdentityFederationArgs) ToWorkloadIdentityFederationOutputWithContext(ctx context.Context) WorkloadIdentityFederationOutput

func (WorkloadIdentityFederationArgs) ToWorkloadIdentityFederationPtrOutput

func (i WorkloadIdentityFederationArgs) ToWorkloadIdentityFederationPtrOutput() WorkloadIdentityFederationPtrOutput

func (WorkloadIdentityFederationArgs) ToWorkloadIdentityFederationPtrOutputWithContext

func (i WorkloadIdentityFederationArgs) ToWorkloadIdentityFederationPtrOutputWithContext(ctx context.Context) WorkloadIdentityFederationPtrOutput

type WorkloadIdentityFederationInput

type WorkloadIdentityFederationInput interface {
	pulumi.Input

	ToWorkloadIdentityFederationOutput() WorkloadIdentityFederationOutput
	ToWorkloadIdentityFederationOutputWithContext(context.Context) WorkloadIdentityFederationOutput
}

WorkloadIdentityFederationInput is an input type that accepts WorkloadIdentityFederationArgs and WorkloadIdentityFederationOutput values. You can construct a concrete instance of `WorkloadIdentityFederationInput` via:

WorkloadIdentityFederationArgs{...}

type WorkloadIdentityFederationOutput

type WorkloadIdentityFederationOutput struct{ *pulumi.OutputState }

Anthropic OIDC Federation Rule parameters and the source of the JWT identity token to exchange. See https://platform.claude.com/docs/en/build-with-claude/workload-identity-federation

func (WorkloadIdentityFederationOutput) ElementType

func (WorkloadIdentityFederationOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (WorkloadIdentityFederationOutput) FederationRuleId

Anthropic OidcFederationRule ID. Must start with 'fdrl_'.

func (WorkloadIdentityFederationOutput) IdentityToken

How to obtain a fresh JWT identity token for each token exchange.

func (WorkloadIdentityFederationOutput) OrganizationId

UUID of the Anthropic organization that owns the federation rule.

func (WorkloadIdentityFederationOutput) ServiceAccountId

Optional expected-target check for federation rules with target_type=SERVICE_ACCOUNT. Must start with 'svac_'.

func (WorkloadIdentityFederationOutput) ToWorkloadIdentityFederationOutput

func (o WorkloadIdentityFederationOutput) ToWorkloadIdentityFederationOutput() WorkloadIdentityFederationOutput

func (WorkloadIdentityFederationOutput) ToWorkloadIdentityFederationOutputWithContext

func (o WorkloadIdentityFederationOutput) ToWorkloadIdentityFederationOutputWithContext(ctx context.Context) WorkloadIdentityFederationOutput

func (WorkloadIdentityFederationOutput) ToWorkloadIdentityFederationPtrOutput

func (o WorkloadIdentityFederationOutput) ToWorkloadIdentityFederationPtrOutput() WorkloadIdentityFederationPtrOutput

func (WorkloadIdentityFederationOutput) ToWorkloadIdentityFederationPtrOutputWithContext

func (o WorkloadIdentityFederationOutput) ToWorkloadIdentityFederationPtrOutputWithContext(ctx context.Context) WorkloadIdentityFederationPtrOutput

type WorkloadIdentityFederationPtrInput

type WorkloadIdentityFederationPtrInput interface {
	pulumi.Input

	ToWorkloadIdentityFederationPtrOutput() WorkloadIdentityFederationPtrOutput
	ToWorkloadIdentityFederationPtrOutputWithContext(context.Context) WorkloadIdentityFederationPtrOutput
}

WorkloadIdentityFederationPtrInput is an input type that accepts WorkloadIdentityFederationArgs, WorkloadIdentityFederationPtr and WorkloadIdentityFederationPtrOutput values. You can construct a concrete instance of `WorkloadIdentityFederationPtrInput` via:

        WorkloadIdentityFederationArgs{...}

or:

        nil

type WorkloadIdentityFederationPtrOutput

type WorkloadIdentityFederationPtrOutput struct{ *pulumi.OutputState }

func (WorkloadIdentityFederationPtrOutput) Elem

func (WorkloadIdentityFederationPtrOutput) ElementType

func (WorkloadIdentityFederationPtrOutput) Extra

Additional fields that are not modelled by this provider version, merged verbatim into this object's YAML mapping (snake_case keys). A key that is also set by a typed property overrides it.

func (WorkloadIdentityFederationPtrOutput) FederationRuleId

Anthropic OidcFederationRule ID. Must start with 'fdrl_'.

func (WorkloadIdentityFederationPtrOutput) IdentityToken

How to obtain a fresh JWT identity token for each token exchange.

func (WorkloadIdentityFederationPtrOutput) OrganizationId

UUID of the Anthropic organization that owns the federation rule.

func (WorkloadIdentityFederationPtrOutput) ServiceAccountId

Optional expected-target check for federation rules with target_type=SERVICE_ACCOUNT. Must start with 'svac_'.

func (WorkloadIdentityFederationPtrOutput) ToWorkloadIdentityFederationPtrOutput

func (o WorkloadIdentityFederationPtrOutput) ToWorkloadIdentityFederationPtrOutput() WorkloadIdentityFederationPtrOutput

func (WorkloadIdentityFederationPtrOutput) ToWorkloadIdentityFederationPtrOutputWithContext

func (o WorkloadIdentityFederationPtrOutput) ToWorkloadIdentityFederationPtrOutputWithContext(ctx context.Context) WorkloadIdentityFederationPtrOutput

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址