Skip to content

Configuration ​

TPF configuration is split by when the setting is read and what boundary it affects.

Use this guide to choose the right configuration surface first. Use All Settings when you need the full key inventory.

Reading Path ​

NeedStart here
Generated artifacts, annotation processor options, REST path overridesBuild-Time Settings
Runtime execution, clients, telemetry, health, in-flight probeRuntime Settings
Await, command steps, queue-async, checkpoint handoff, background executionAwait, Command, and Checkpoint Settings
REST, gRPC, LOCAL transport modes; FUNCTION platform and generated entry pointsTransport and Platform Settings
Persistence, caching, materialization, reject sinksProviders and Plugins
Replay Viewer URL/query parameter behaviorReplay Viewer Parameters
Lambda-specific configuration sliceLambda-Focused Configuration

Configuration Rule ​

Keep application decisions in YAML and Java contracts. Use runtime properties for deployment choices, provider selection, endpoint locations, retry budgets, and observability settings.

If changing a setting would alter the generated code shape, it belongs in build-time configuration. If changing it only changes how a generated runtime connects, stores, observes, or schedules work, it belongs in runtime configuration.