ces library
Customer Engagement Suite (Conversational Agents): apps, agents, root-agent association, app versions, guardrails, tools, toolsets, few-shot examples, and deployments. Session SKUs fire only on chat/voice traffic — creating design-time config or a channel binding does not send sessions.
Classes
-
AppConstant<
T> -
A value the Stack hands to application code as a
static constin the generated AppExports file — known when synth runs, so the app compiles against it. - AppExports
-
Where synth writes the Dart file application code imports: the Stack's
constants, as the
static constmembers of<name>Constants, and a typed reader of its Terraform outputs,<name>Outputs. -
AttributeRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.attribute()may construct instances. - CesAgentAfterAgentCallbacks
-
Typed helper for the
after_agent_callbacksblock ofgoogle_ces_agent(derived from provider schema). - CesAgentAfterModelCallbacks
-
Typed helper for the
after_model_callbacksblock ofgoogle_ces_agent(derived from provider schema). - CesAgentAfterToolCallbacks
-
Typed helper for the
after_tool_callbacksblock ofgoogle_ces_agent(derived from provider schema). - CesAgentBeforeAgentCallbacks
-
Typed helper for the
before_agent_callbacksblock ofgoogle_ces_agent(derived from provider schema). - CesAgentBeforeModelCallbacks
-
Typed helper for the
before_model_callbacksblock ofgoogle_ces_agent(derived from provider schema). - CesAgentBeforeToolCallbacks
-
Typed helper for the
before_tool_callbacksblock ofgoogle_ces_agent(derived from provider schema). - CesAgentDeterministicTransfer
-
Typed helper for the
transfer_rules.deterministic_transferblock ofgoogle_ces_agent(derived from provider schema). - CesAgentDisablePlannerTransfer
-
Typed helper for the
transfer_rules.disable_planner_transferblock ofgoogle_ces_agent(derived from provider schema). - CesAgentExpressionCondition
-
Typed helper for the
transfer_rules.deterministic_transfer.expression_conditionblock ofgoogle_ces_agent(derived from provider schema). Shared by every block of this shape in the resource. - CesAgentLlmAgent
-
Typed helper for the
llm_agentblock ofgoogle_ces_agent(derived from provider schema). - CesAgentModelSettings
-
Typed helper for the
model_settingsblock ofgoogle_ces_agent(derived from provider schema). - CesAgentPythonCodeCondition
-
Typed helper for the
transfer_rules.deterministic_transfer.python_code_conditionblock ofgoogle_ces_agent(derived from provider schema). - CesAgentRemoteDialogflowAgent
-
Typed helper for the
remote_dialogflow_agentblock ofgoogle_ces_agent(derived from provider schema). - CesAgentToolsets
-
Typed helper for the
toolsetsblock ofgoogle_ces_agent(derived from provider schema). - CesAgentTransferRules
-
Typed helper for the
transfer_rulesblock ofgoogle_ces_agent(derived from provider schema). - CesAppAmbientSoundConfig
-
Typed helper for the
audio_processing_config.ambient_sound_configblock ofgoogle_ces_app(derived from provider schema). - CesAppAudioProcessingConfig
-
Typed helper for the
audio_processing_configblock ofgoogle_ces_app(derived from provider schema). - CesAppAudioRecordingConfig
-
Typed helper for the
logging_settings.audio_recording_configblock ofgoogle_ces_app(derived from provider schema). - CesAppBargeInConfig
-
Typed helper for the
audio_processing_config.barge_in_configblock ofgoogle_ces_app(derived from provider schema). - CesAppBigqueryExportSettings
-
Typed helper for the
logging_settings.bigquery_export_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppClientCertificateSettings
-
Typed helper for the
client_certificate_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppCloudLoggingSettings
-
Typed helper for the
logging_settings.cloud_logging_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppConversationLoggingSettings
-
Typed helper for the
logging_settings.conversation_logging_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppDefaultChannelProfile
-
Typed helper for the
default_channel_profileblock ofgoogle_ces_app(derived from provider schema). - CesAppEndSessionConfig
-
Typed helper for the
error_handling_settings.end_session_configblock ofgoogle_ces_app(derived from provider schema). - CesAppErrorHandlingSettings
-
Typed helper for the
error_handling_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppEvaluationMetricsThresholds
-
Typed helper for the
evaluation_metrics_thresholdsblock ofgoogle_ces_app(derived from provider schema). - CesAppExpectationLevelMetricsThresholds
-
Typed helper for the
evaluation_metrics_thresholds.golden_evaluation_metrics_thresholds.expectation_level_metrics_thresholdsblock ofgoogle_ces_app(derived from provider schema). - CesAppFallbackResponseConfig
-
Typed helper for the
error_handling_settings.fallback_response_configblock ofgoogle_ces_app(derived from provider schema). - CesAppGoldenEvaluationMetricsThresholds
-
Typed helper for the
evaluation_metrics_thresholds.golden_evaluation_metrics_thresholdsblock ofgoogle_ces_app(derived from provider schema). - CesAppLanguageSettings
-
Typed helper for the
language_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppLoggingSettings
-
Typed helper for the
logging_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppMetricAnalysisSettings
-
Typed helper for the
logging_settings.metric_analysis_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppModelSettings
-
Typed helper for the
model_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppPersonaProperty
-
Typed helper for the
default_channel_profile.persona_propertyblock ofgoogle_ces_app(derived from provider schema). - CesAppRedactionConfig
-
Typed helper for the
logging_settings.redaction_configblock ofgoogle_ces_app(derived from provider schema). - CesAppSchema
-
Typed helper for the
variable_declarations.schemablock ofgoogle_ces_app(derived from provider schema). - CesAppSecuritySettings
-
Typed helper for the
default_channel_profile.web_widget_config.security_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppSynthesizeSpeechConfigs
-
Typed helper for the
audio_processing_config.synthesize_speech_configsblock ofgoogle_ces_app(derived from provider schema). - CesAppTimeZoneSettings
-
Typed helper for the
time_zone_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppToolMatchingSettings
-
Typed helper for the
evaluation_metrics_thresholds.golden_evaluation_metrics_thresholds.tool_matching_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppTurnLevelMetricsThresholds
-
Typed helper for the
evaluation_metrics_thresholds.golden_evaluation_metrics_thresholds.turn_level_metrics_thresholdsblock ofgoogle_ces_app(derived from provider schema). - CesAppVariableDeclarations
-
Typed helper for the
variable_declarationsblock ofgoogle_ces_app(derived from provider schema). - CesAppVpcScSettings
-
Typed helper for the
vpc_sc_settingsblock ofgoogle_ces_app(derived from provider schema). - CesAppWebWidgetConfig
-
Typed helper for the
default_channel_profile.web_widget_configblock ofgoogle_ces_app(derived from provider schema). - CesAppWhatsappConfig
-
Typed helper for the
default_channel_profile.whatsapp_configblock ofgoogle_ces_app(derived from provider schema). - CesDeploymentChannelProfile
-
Typed helper for the
channel_profileblock ofgoogle_ces_deployment(derived from provider schema). - CesDeploymentInstagramCredentials
-
Typed helper for the
instagram_credentialsblock ofgoogle_ces_deployment(derived from provider schema). - CesDeploymentInstagramCredentialsAuthCode
-
Exactly one of
auth_code,auth_code_woon theinstagram_credentialsblock ofgoogle_ces_deployment: the provider rejects none and more than one, so each variant sets one of them. - CesDeploymentInstagramCredentialsAuthCodeChoice
-
The CesDeploymentInstagramCredentialsAuthCode.authCode choice: sets
auth_code. - CesDeploymentInstagramCredentialsAuthCodeWo
-
The CesDeploymentInstagramCredentialsAuthCode.authCodeWo choice: sets
auth_code_wo. - CesDeploymentPersonaProperty
-
Typed helper for the
channel_profile.persona_propertyblock ofgoogle_ces_deployment(derived from provider schema). - CesDeploymentPin
-
Exactly one of
pin,pin_woon thewhatsapp_credentialsblock ofgoogle_ces_deployment: the provider rejects none and more than one, so each variant sets one of them. - CesDeploymentPinChoice
-
The CesDeploymentPin.pin choice: sets
pin. - CesDeploymentPinWo
-
The CesDeploymentPin.pinWo choice: sets
pin_wo. - CesDeploymentSecuritySettings
-
Typed helper for the
channel_profile.web_widget_config.security_settingsblock ofgoogle_ces_deployment(derived from provider schema). - CesDeploymentWebWidgetConfig
-
Typed helper for the
channel_profile.web_widget_configblock ofgoogle_ces_deployment(derived from provider schema). - CesDeploymentWhatsappConfig
-
Typed helper for the
channel_profile.whatsapp_configblock ofgoogle_ces_deployment(derived from provider schema). - CesDeploymentWhatsappCredentials
-
Typed helper for the
whatsapp_credentialsblock ofgoogle_ces_deployment(derived from provider schema). - CesDeploymentWhatsappCredentialsAuthCode
-
Exactly one of
auth_code,auth_code_woon thewhatsapp_credentialsblock ofgoogle_ces_deployment: the provider rejects none and more than one, so each variant sets one of them. - CesDeploymentWhatsappCredentialsAuthCodeChoice
-
The CesDeploymentWhatsappCredentialsAuthCode.authCode choice: sets
auth_code. - CesDeploymentWhatsappCredentialsAuthCodeWo
-
The CesDeploymentWhatsappCredentialsAuthCode.authCodeWo choice: sets
auth_code_wo. - CesExampleAgentTransfer
-
Typed helper for the
messages.chunks.agent_transferblock ofgoogle_ces_example(derived from provider schema). - CesExampleBlob
-
Typed helper for the
messages.chunks.blobblock ofgoogle_ces_example(derived from provider schema). - CesExampleChunks
-
Typed helper for the
messages.chunksblock ofgoogle_ces_example(derived from provider schema). - CesExampleImage
-
Typed helper for the
messages.chunks.imageblock ofgoogle_ces_example(derived from provider schema). - CesExampleMessages
-
Typed helper for the
messagesblock ofgoogle_ces_example(derived from provider schema). - CesExampleToolCall
-
Typed helper for the
messages.chunks.tool_callblock ofgoogle_ces_example(derived from provider schema). - CesExampleToolResponse
-
Typed helper for the
messages.chunks.tool_responseblock ofgoogle_ces_example(derived from provider schema). - CesExampleToolsetTool
-
Typed helper for the
messages.chunks.tool_call.toolset_toolblock ofgoogle_ces_example(derived from provider schema). Shared by every block of this shape in the resource. - CesGuardrailAction
-
Typed helper for the
actionblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailAfterAgentCallback
-
Typed helper for the
code_callback.after_agent_callbackblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailAfterModelCallback
-
Typed helper for the
code_callback.after_model_callbackblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailBeforeAgentCallback
-
Typed helper for the
code_callback.before_agent_callbackblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailBeforeModelCallback
-
Typed helper for the
code_callback.before_model_callbackblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailCodeCallback
-
Typed helper for the
code_callbackblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailContentFilter
-
Typed helper for the
content_filterblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailCustomPolicy
-
Typed helper for the
llm_prompt_security.custom_policyblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailDefaultSettings
-
Typed helper for the
llm_prompt_security.default_settingsblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailGenerativeAnswer
-
Typed helper for the
action.generative_answerblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailLlmPolicy
-
Typed helper for the
llm_policyblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailLlmPromptSecurity
-
Typed helper for the
llm_prompt_securityblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailModelSafety
-
Typed helper for the
model_safetyblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailModelSettings
-
Typed helper for the
llm_policy.model_settingsblock ofgoogle_ces_guardrail(derived from provider schema). Shared by every block of this shape in the resource. - CesGuardrailRespondImmediately
-
Typed helper for the
action.respond_immediatelyblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailResponses
-
Typed helper for the
action.respond_immediately.responsesblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailSafetySettings
-
Typed helper for the
model_safety.safety_settingsblock ofgoogle_ces_guardrail(derived from provider schema). - CesGuardrailTransferAgent
-
Typed helper for the
action.transfer_agentblock ofgoogle_ces_guardrail(derived from provider schema). - CesToolAgentTool
-
Typed helper for the
agent_toolblock ofgoogle_ces_tool(derived from provider schema). - CesToolBoostControlSpec
-
Typed helper for the
data_store_tool.boost_specs.spec.condition_boost_specs.boost_control_specblock ofgoogle_ces_tool(derived from provider schema). - CesToolBoostSpecs
-
Typed helper for the
data_store_tool.boost_specsblock ofgoogle_ces_tool(derived from provider schema). - CesToolClientFunction
-
Typed helper for the
client_functionblock ofgoogle_ces_tool(derived from provider schema). - CesToolCodeBlock
-
Typed helper for the
tool_fake_config.code_blockblock ofgoogle_ces_tool(derived from provider schema). - CesToolConditionBoostSpecs
-
Typed helper for the
data_store_tool.boost_specs.spec.condition_boost_specsblock ofgoogle_ces_tool(derived from provider schema). - CesToolControlPoints
-
Typed helper for the
data_store_tool.boost_specs.spec.condition_boost_specs.boost_control_spec.control_pointsblock ofgoogle_ces_tool(derived from provider schema). - CesToolDataMapping
-
Typed helper for the
widget_tool.data_mappingblock ofgoogle_ces_tool(derived from provider schema). - CesToolDataMappingPythonFunction
-
Typed helper for the
widget_tool.data_mapping.python_functionblock ofgoogle_ces_tool(derived from provider schema). - CesToolDataStore
-
Typed helper for the
data_store_tool.data_store_source.data_storeblock ofgoogle_ces_tool(derived from provider schema). Shared by every block of this shape in the resource. - CesToolDataStoreSource
-
Typed helper for the
data_store_tool.data_store_sourceblock ofgoogle_ces_tool(derived from provider schema). - CesToolDataStoreSourceChoice
-
The CesToolSource.dataStoreSource choice: sets
data_store_source. - CesToolDataStoreSources
-
Typed helper for the
data_store_tool.engine_source.data_store_sourcesblock ofgoogle_ces_tool(derived from provider schema). - CesToolDataStoreTool
-
Typed helper for the
data_store_toolblock ofgoogle_ces_tool(derived from provider schema). - CesToolEngineSource
-
Typed helper for the
data_store_tool.engine_sourceblock ofgoogle_ces_tool(derived from provider schema). - CesToolEngineSourceChoice
-
The CesToolSource.engineSource choice: sets
engine_source. - CesToolFakeConfig
-
Typed helper for the
tool_fake_configblock ofgoogle_ces_tool(derived from provider schema). - CesToolFileSearchTool
-
Typed helper for the
file_search_toolblock ofgoogle_ces_tool(derived from provider schema). - CesToolGoogleSearchTool
-
Typed helper for the
google_search_toolblock ofgoogle_ces_tool(derived from provider schema). - CesToolGroundingConfig
-
Typed helper for the
data_store_tool.modality_configs.grounding_configblock ofgoogle_ces_tool(derived from provider schema). - CesToolModalityConfigs
-
Typed helper for the
data_store_tool.modality_configsblock ofgoogle_ces_tool(derived from provider schema). - CesToolModelSettings
-
Typed helper for the
data_store_tool.modality_configs.rewriter_config.model_settingsblock ofgoogle_ces_tool(derived from provider schema). Shared by every block of this shape in the resource. - CesToolParameters
-
Typed helper for the
client_function.parametersblock ofgoogle_ces_tool(derived from provider schema). Shared by every block of this shape in the resource. - CesToolPromptConfig
-
Typed helper for the
google_search_tool.prompt_configblock ofgoogle_ces_tool(derived from provider schema). - CesToolPythonFunction
-
Typed helper for the
python_functionblock ofgoogle_ces_tool(derived from provider schema). - CesToolResponse
-
Typed helper for the
client_function.responseblock ofgoogle_ces_tool(derived from provider schema). - CesToolRewriterConfig
-
Typed helper for the
data_store_tool.modality_configs.rewriter_configblock ofgoogle_ces_tool(derived from provider schema). - CesToolServiceDirectoryConfig
-
Typed helper for the
python_function.service_directory_configblock ofgoogle_ces_tool(derived from provider schema). - CesToolsetApiAuthentication
-
Typed helper for the
mcp_toolset.api_authenticationblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetApiKeyConfig
-
Typed helper for the
mcp_toolset.api_authentication.api_key_configblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetAuthConfig
-
Typed helper for the
connector_toolset.auth_configblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetBearerTokenConfig
-
Typed helper for the
mcp_toolset.api_authentication.bearer_token_configblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetCaCerts
-
Typed helper for the
mcp_toolset.tls_config.ca_certsblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetCodeBlock
-
Typed helper for the
tool_fake_config.code_blockblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetConnectorActions
-
Typed helper for the
connector_toolset.connector_actionsblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetConnectorToolset
-
Typed helper for the
connector_toolsetblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetEntityOperation
-
Typed helper for the
connector_toolset.connector_actions.entity_operationblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetMcpToolset
-
Typed helper for the
mcp_toolsetblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetOauth2AuthCodeConfig
-
Typed helper for the
connector_toolset.auth_config.oauth2_auth_code_configblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetOauth2JwtBearerConfig
-
Typed helper for the
connector_toolset.auth_config.oauth2_jwt_bearer_configblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetOauthConfig
-
Typed helper for the
mcp_toolset.api_authentication.oauth_configblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetOpenApiToolset
-
Typed helper for the
open_api_toolsetblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetServiceAccountAuthConfig
-
Typed helper for the
mcp_toolset.api_authentication.service_account_auth_configblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetServiceAgentIdTokenAuthConfig
-
Typed helper for the
mcp_toolset.api_authentication.service_agent_id_token_auth_configblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetServiceDirectoryConfig
-
Typed helper for the
mcp_toolset.service_directory_configblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetTlsConfig
-
Typed helper for the
mcp_toolset.tls_configblock ofgoogle_ces_toolset(derived from provider schema). Shared by every block of this shape in the resource. - CesToolsetToolFakeConfig
-
Typed helper for the
tool_fake_configblock ofgoogle_ces_toolset(derived from provider schema). - CesToolsetToolOverrides
-
Typed helper for the
mcp_toolset.tool_overridesblock ofgoogle_ces_toolset(derived from provider schema). - CesToolSnippetsConfig
-
Typed helper for the
data_store_tool.modality_configs.snippets_configblock ofgoogle_ces_tool(derived from provider schema). - CesToolSource
-
At most one of
data_store_source,engine_sourceon thedata_store_toolblock ofgoogle_ces_tool: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - CesToolSpec
-
Typed helper for the
data_store_tool.boost_specs.specblock ofgoogle_ces_tool(derived from provider schema). - CesToolSummarizationConfig
-
Typed helper for the
data_store_tool.modality_configs.summarization_configblock ofgoogle_ces_tool(derived from provider schema). - CesToolTextResponseConfig
-
Typed helper for the
widget_tool.text_response_configblock ofgoogle_ces_tool(derived from provider schema). - CesToolWidgetTool
-
Typed helper for the
widget_toolblock ofgoogle_ces_tool(derived from provider schema). - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. -
DataRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.data()may construct instances. - EnvironmentConstant
- The AppConstant.fromEnvironment choice.
- GcsBackend
-
terraform { backend "gcs" { ... } }configuration. - GoogleCesAgent
-
Factory wrapper for
google_ces_agent. - GoogleCesApp
-
Factory wrapper for
google_ces_app. - GoogleCesAppRootAgentAssociation
-
Factory wrapper for
google_ces_app_root_agent_association. - GoogleCesAppVersion
-
Factory wrapper for
google_ces_app_version. - GoogleCesDeployment
-
Factory wrapper for
google_ces_deployment. - GoogleCesExample
-
Factory wrapper for
google_ces_example. - GoogleCesGuardrail
-
Factory wrapper for
google_ces_guardrail. - GoogleCesTool
-
Factory wrapper for
google_ces_tool. - GoogleCesToolset
-
Factory wrapper for
google_ces_toolset. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_changescovers: every attribute, or the listed ones. - InvalidDartDefineOutput
-
An output of
Stack.addDartDefineOutputthat cannot carry what it names: an output that is not registered, is sensitive or has no environment value, two outputs read from one variable, or no output at all. - InvalidLifecycle
-
A
lifecycleblock Terraform rejects: a data source (or one of its attributes) inreplaceTriggeredBy,allinside IgnoreChanges.of, or a condition with an empty error message. - InvalidMoveTarget
-
A
movedblock whosetonames no resource of the Stack. - InvalidTimeout
-
A negative
timeoutsduration. - LifecycleCondition
-
A
preconditionorpostconditionblock: Terraform fails the plan (LifecycleCondition.pre) or the apply (LifecycleCondition.post) with errorMessage when condition is false. - LifecycleOptions
-
lifecycle { ... }block on a resource. - LocalBackend
-
terraform { backend "local" { ... } }configuration. - MissingProvider
-
A block needs a provider configuration the Stack does not register:
the provider its type implies (
googleforgoogle_pubsub_topic), the one itsprovidermeta-argument names, or one a module call passes on. - ModuleCall
-
A
module "<localName>" { ... }call as a Dart value. - NoProviders
- The Stack registers no provider, but declares resources or data sources.
- ProviderConflict
- Two provider registrations Terraform rejects together: two defaults of one name, a repeated alias, an alias that is not an identifier, or configurations of one name with different source / version constraints.
-
RefConstant<
T> - The AppConstant.ref choice.
- ReplaceTrigger
-
What
lifecycle.replaceTriggeredBylists: a resource of the Stack or an attribute getter of one.Resourceand TfRef implement it; synth reports a data source or a data-source attribute as anInvalidLifecycle. - Resource
- Base of every user-instantiable Terraform resource.
- ResourceRef
-
Public for sealed pattern matching, but constructor is private — only
TfRef.resource()may construct instances. - S3Backend
-
terraform { backend "s3" { ... } }configuration. -
Sensitive<
T> -
What an argument Terraform marks sensitive takes: a variable, an
expression or an attribute getter — a value Terraform resolves, never a
Dart literal that would be written into
main.tf.json. - SensitiveLiteral
-
A sensitive field is set to a literal, which would write the secret in
plain text into
main.tf.json. - Stack
- User-extended IaC composition root.
- StackBackend
-
Lightweight backend hook. Core ships
GcsBackend,S3Backend, andLocalBackend; anything else implements this interface in the caller. TheStackonly stores the value and exposes a discriminator for synth'sterraform { backend ... }emitter. - StackProvider
-
Coordination interface between
Stack(in this package) and concrete providers (e.g.GoogleProviderinterradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen. - SynthIssue
- One reason a Stack cannot be synthesized.
- SynthResult
-
Bundle returned by
StackSynth.synth. - TfAddressed
-
Anything that exposes a Terraform address, e.g.
google_pubsub_topic.orders. -
TfArg<
T> - A Terraform argument: a Dart-side literal, a reference to another block's attribute (TfRef), a variable or a raw expression.
-
TfArgExpression<
T> - A raw Terraform expression — the tf.json template string, verbatim.
-
TfArgLiteral<
T> -
TfArgVariable<
T> - TfCollectionType
-
list(...),set(...)ormap(...). - TfMoved
-
One
moved { from = ... to = ... }block: the state object at from now belongs to the resource at to, so a rename does not become a destroy-and-create. - TfObjectType
-
object({ ... }). - TfOptionalType
-
optional(<type>[, <default>]). -
TfOutput<
T> -
An
output "<name>" { value = ... }block, registered withStack.addOutput. - TfPrimitiveType
-
string,number,boolorany. -
TfRef<
T> - A Terraform-side reference: an attribute of a resource (AttributeRef) or a data source (DataRef), or a whole resource (ResourceRef).
- TfTimeouts
-
timeouts { ... }on a resource or data source: how long Terraform waits for each operation before giving up. - TfTupleType
-
tuple([...]). - TfType
-
A Terraform type constraint:
string,list(number),object({ name = string }). - TfVariable
-
One
variable "<name>" { ... }declaration. - UndeclaredVariable
-
A
TfArg.variableorvar.<name>in an expression names a variable the Stack does not declare. - UnregisteredReference
-
A block references another block that was never registered on the
Stack: built, but not passed to
add(...)/addModule(...). - UnresolvableConstant
-
An
AppConstant.refwhose value is not known at synth: the attribute is not set to a literal, is sensitive, does not match the constant's type, or belongs to a block that is not registered. -
ValueConstant<
T> - The AppConstant.value choice.
Enums
- ResourceKind
-
Whether a Stack entry is a
resourceblock or adatablock in Terraform JSON.
Extension Types
- CesAgentDirection
-
direction— derived from the provider schema description. - CesAppExtraToolCallBehavior
-
extra_tool_call_behavior— derived from the provider schema description. - CesAppGoldenHallucinationMetricBehavior
-
golden_hallucination_metric_behavior— derived from the provider schema description. - CesAppScenarioHallucinationMetricBehavior
-
scenario_hallucination_metric_behavior— derived from the provider schema description. - CesGuardrailCategory
-
category— derived from the provider schema description. - CesGuardrailPolicyScope
-
policy_scope— derived from the provider schema description. - CesGuardrailThreshold
-
threshold— derived from the provider schema description. - CesToolCorpusType
-
corpus_type— derived from the provider schema description. - CesToolFilterParameterBehavior
-
filter_parameter_behavior— derived from the provider schema description. - CesToolMode
-
mode— derived from the provider schema description. - CesToolType
-
type— derived from the provider schema description. - CesToolWidgetType
-
widget_type— derived from the provider schema description. - OutputEnvironment
-
The environment
Stack.outputEnvironmentreturns: each variable and its value, in registration order. - RefTo
-
A reference to a resource of type
R, for an argument that names another resource (network,vpc_id,role_arn, ...).
Extensions
-
RefToList
on TfArg<
List< RefTo< >R> > -
A list-valued reference argument (
security_group_ids,subnet_ids): a literal list of RefTos, or one value that is the whole list (TfArg.variable('subnet_ids'),TfArg.expression(...)). - TerraformDurationExt on Duration
- Converts a Dart Duration into a Terraform duration string ("604800s").
Constants
- terradartManifestVariable → const String
-
The environment variable the
terradartcommand sets to the file runStack and runEnvironments describe what they wrote in.
Functions
-
runEnvironments<
E extends Enum> (List< String> args, List<E> environments, Stack build(E env), {String dir(E env)?, String? workspace(E env)?, List<String> backendConfig(E env)?, E? defaultEnv}) → Future<void> -
The entry point of a project with one Stack per environment. The
environments are the members of an enum of the project's own — any
names, each carrying its values — so the Stack takes a typed
envand derives everything per environment from it, its backend included: -
runStack(
List< String> args, Stack build(), {String out = 'tf-out'}) → Future<void> -
The entry point of a project with one Stack: writes it to
out.
Exceptions / Errors
- DuplicateModuleError
-
A
ModuleCallregistered twice under one name. - DuplicateResourceError
-
Thrown by
Stack.addwhen an entry with the same(kind, terraformType, localName)triple is registered twice. - SynthException
-
Thrown by
Stack.synth()andStack.writeTo()when the Stack has one or more SynthIssues. Nothing is written.