ai library

Cloudflare AI Gateway and AI Search.

Classes

AiGatewayDlp
Typed helper for the dlp block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayDynamicRoutingElements
Typed helper for the elements block of cloudflare_ai_gateway_dynamic_routing (derived from provider schema).
AiGatewayDynamicRoutingFallback
Typed helper for the elements.outputs.fallback block of cloudflare_ai_gateway_dynamic_routing (derived from provider schema).
AiGatewayDynamicRoutingFalse
Typed helper for the elements.outputs.false block of cloudflare_ai_gateway_dynamic_routing (derived from provider schema).
AiGatewayDynamicRoutingNext
Typed helper for the elements.outputs.next block of cloudflare_ai_gateway_dynamic_routing (derived from provider schema).
AiGatewayDynamicRoutingOutputs
Typed helper for the elements.outputs block of cloudflare_ai_gateway_dynamic_routing (derived from provider schema).
AiGatewayDynamicRoutingOutputsSuccess
Typed helper for the elements.outputs.success block of cloudflare_ai_gateway_dynamic_routing (derived from provider schema).
AiGatewayDynamicRoutingProperties
Typed helper for the elements.properties block of cloudflare_ai_gateway_dynamic_routing (derived from provider schema).
AiGatewayDynamicRoutingTrue
Typed helper for the elements.outputs.true block of cloudflare_ai_gateway_dynamic_routing (derived from provider schema).
AiGatewayGuardrails
Typed helper for the guardrails block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayMetadata
Typed helper for the spend_limits.rules.metadata block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayModel
Typed helper for the spend_limits.rules.model block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayOtel
Typed helper for the otel block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayPolicies
Typed helper for the dlp.policies block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayPrompt
Typed helper for the guardrails.prompt block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayProvider
Typed helper for the spend_limits.rules.ai_gateway_provider block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayResponse
Typed helper for the guardrails.response block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayRules
Typed helper for the spend_limits.rules block of cloudflare_ai_gateway (derived from provider schema).
AiGatewaySpendLimits
Typed helper for the spend_limits block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayStripe
Typed helper for the stripe block of cloudflare_ai_gateway (derived from provider schema).
AiGatewayUsageEvents
Typed helper for the stripe.usage_events block of cloudflare_ai_gateway (derived from provider schema).
AiSearchInstanceBoostBy
Typed helper for the retrieval_options.boost_by block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceChatCompletionsEndpoint
Typed helper for the public_endpoint_params.chat_completions_endpoint block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceContentSelector
Typed helper for the source_params.web_crawler.parse_options.content_selector block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceCustomMetadata
Typed helper for the custom_metadata block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceDiscoverOptions
Typed helper for the source_params.web_crawler.discover_options block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceIndexingOptions
Typed helper for the indexing_options block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceIndexMethod
Typed helper for the index_method block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceMcp
Typed helper for the public_endpoint_params.mcp block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceMetadata
Typed helper for the metadata block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceParseOptions
Typed helper for the source_params.web_crawler.parse_options block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstancePublicEndpointParams
Typed helper for the public_endpoint_params block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceRateLimit
Typed helper for the public_endpoint_params.rate_limit block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceRetrievalOptions
Typed helper for the retrieval_options block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceSearchEndpoint
Typed helper for the public_endpoint_params.search_endpoint block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceSourceParams
Typed helper for the source_params block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchInstanceWebCrawler
Typed helper for the source_params.web_crawler block of cloudflare_ai_search_instance (derived from provider schema).
AiSearchNamespaceChatCompletionsEndpoint
Typed helper for the public_endpoint_params.chat_completions_endpoint block of cloudflare_ai_search_namespace (derived from provider schema).
AiSearchNamespaceMcp
Typed helper for the public_endpoint_params.mcp block of cloudflare_ai_search_namespace (derived from provider schema).
AiSearchNamespacePublicEndpointParams
Typed helper for the public_endpoint_params block of cloudflare_ai_search_namespace (derived from provider schema).
AiSearchNamespaceRateLimit
Typed helper for the public_endpoint_params.rate_limit block of cloudflare_ai_search_namespace (derived from provider schema).
AiSearchNamespaceSearchEndpoint
Typed helper for the public_endpoint_params.search_endpoint block of cloudflare_ai_search_namespace (derived from provider schema).
AppConstant<T>
A value the Stack hands to application code as a static const in 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 const members 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.
CloudflareAiGateway
Factory wrapper for cloudflare_ai_gateway.
CloudflareAiGatewayDynamicRouting
Factory wrapper for cloudflare_ai_gateway_dynamic_routing.
CloudflareAiSearchInstance
Factory wrapper for cloudflare_ai_search_instance.
CloudflareAiSearchNamespace
Factory wrapper for cloudflare_ai_search_namespace.
CloudflareAiSearchToken
Factory wrapper for cloudflare_ai_search_token.
DartDefineOutput
An output whose value is the client build's --dart-define file, registered with Stack.addDartDefineOutput.
Data
Base of every user-instantiable Terraform data block.
DataAiGatewayFilter
Typed helper for the filter block of cloudflare_ai_gateway (derived from provider schema).
DataAiSearchInstanceFilter
Typed helper for the filter block of cloudflare_ai_search_instance (derived from provider schema).
DataAiSearchTokenFilter
Typed helper for the filter block of cloudflare_ai_search_token (derived from provider schema).
DataCloudflareAiGateway
Factory wrapper for cloudflare_ai_gateway.
DataCloudflareAiGatewayDynamicRouting
Factory wrapper for cloudflare_ai_gateway_dynamic_routing.
DataCloudflareAiGateways
Factory wrapper for cloudflare_ai_gateways.
DataCloudflareAiSearchInstance
Factory wrapper for cloudflare_ai_search_instance.
DataCloudflareAiSearchInstances
Factory wrapper for cloudflare_ai_search_instances.
DataCloudflareAiSearchNamespace
Factory wrapper for cloudflare_ai_search_namespace.
DataCloudflareAiSearchNamespaces
Factory wrapper for cloudflare_ai_search_namespaces.
DataCloudflareAiSearchToken
Factory wrapper for cloudflare_ai_search_token.
DataCloudflareAiSearchTokens
Factory wrapper for cloudflare_ai_search_tokens.
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.
IgnoreAllChanges
IgnoreChanges.all.
IgnoreAttributes
IgnoreChanges.of.
IgnoreChanges
What ignore_changes covers: every attribute, or the listed ones.
InvalidDartDefineOutput
An output of Stack.addDartDefineOutput that 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 lifecycle block Terraform rejects: a data source (or one of its attributes) in replaceTriggeredBy, all inside IgnoreChanges.of, or a condition with an empty error message.
InvalidMoveTarget
A moved block whose to names no resource of the Stack.
InvalidTimeout
A negative timeouts duration.
LifecycleCondition
A precondition or postcondition block: 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 (google for google_pubsub_topic), the one its provider meta-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.replaceTriggeredBy lists: a resource of the Stack or an attribute getter of one. Resource and TfRef implement it; synth reports a data source or a data-source attribute as an InvalidLifecycle.
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, and LocalBackend; anything else implements this interface in the caller. The Stack only stores the value and exposes a discriminator for synth's terraform { backend ... } emitter.
StackProvider
Coordination interface between Stack (in this package) and concrete providers (e.g. GoogleProvider in terradart_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(...) or map(...).
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 with Stack.addOutput.
TfPrimitiveType
string, number, bool or any.
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.variable or var.<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.ref whose 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 resource block or a data block in Terraform JSON.

Extension Types

AiGatewayAction
action — derived from the provider schema description.
AiGatewayCheck
check — derived from the provider schema description.
AiGatewayContentType
content_type — derived from the provider schema description.
AiGatewayDynamicRoutingLimitType
limit_type — derived from the provider schema description.
AiGatewayDynamicRoutingType
type — derived from the provider schema description.
AiGatewayLimitType
limit_type — derived from the provider schema description.
AiGatewayLogManagementStrategy
Ai Gateway Log Management enum for log_management_strategy.
AiGatewayMetadataMode
mode — derived from the provider schema description.
AiGatewayP1
p1 — derived from the provider schema description.
AiGatewayPoliciesAction
action — derived from the provider schema description.
AiGatewayProviderMode
mode — derived from the provider schema description.
AiGatewayRateLimitingTechnique
Ai Gateway Rate Limiting enum for rate_limiting_technique.
AiGatewayRetryBackoff
Ai Gateway Retry enum for retry_backoff.
AiGatewayS1
s1 — derived from the provider schema description.
AiGatewayS10
s10 — derived from the provider schema description.
AiGatewayS11
s11 — derived from the provider schema description.
AiGatewayS12
s12 — derived from the provider schema description.
AiGatewayS13
s13 — derived from the provider schema description.
AiGatewayS2
s2 — derived from the provider schema description.
AiGatewayS3
s3 — derived from the provider schema description.
AiGatewayS4
s4 — derived from the provider schema description.
AiGatewayS5
s5 — derived from the provider schema description.
AiGatewayS6
s6 — derived from the provider schema description.
AiGatewayS7
s7 — derived from the provider schema description.
AiGatewayS8
s8 — derived from the provider schema description.
AiGatewayS9
s9 — derived from the provider schema description.
AiGatewayTechnique
technique — derived from the provider schema description.
AiGatewayWorkersAiBillingMode
Ai Gateway Workers Ai Billing enum for workers_ai_billing_mode.
AiSearchInstanceCacheThreshold
Ai Search Instance Cache enum for cache_threshold.
AiSearchInstanceDataType
data_type — derived from the provider schema description.
AiSearchInstanceDirection
direction — derived from the provider schema description.
AiSearchInstanceDiscoverOptionsSource
source — derived from the provider schema description.
AiSearchInstanceFusionMethod
Ai Search Instance Fusion enum for fusion_method.
AiSearchInstanceKeywordMatchMode
keyword_match_mode — derived from the provider schema description.
AiSearchInstanceKeywordTokenizer
keyword_tokenizer — derived from the provider schema description.
AiSearchInstanceParseType
parse_type — derived from the provider schema description.
AiSearchInstanceTechnique
technique — derived from the provider schema description.
AiSearchInstanceType
Ai Search Instance enum for type.
AiSearchNamespaceTechnique
technique — derived from the provider schema description.
DataAiSearchInstanceOrderBy
order_by — derived from the provider schema description.
DataAiSearchInstanceOrderByDirection
order_by_direction — derived from the provider schema description.
OutputEnvironment
The environment Stack.outputEnvironment returns: 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 terradart command 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 env and 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 ModuleCall registered twice under one name.
DuplicateResourceError
Thrown by Stack.add when an entry with the same (kind, terraformType, localName) triple is registered twice.
SynthException
Thrown by Stack.synth() and Stack.writeTo() when the Stack has one or more SynthIssues. Nothing is written.