firebase_app_hosting library

Classes

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.
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.
DataRef<T>: Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
EnvironmentConstant: The AppConstant.fromEnvironment choice.
FirebaseAppHostingBackendCodebase: codebase block. Links the backend to a Developer Connect-managed git repository, so commits flowing into the configured branch trigger builds (see GoogleFirebaseAppHostingTraffic.rolloutPolicy).
FirebaseAppHostingBuildCodebase: Typed helper for the source.codebase block of google_firebase_app_hosting_build (derived from provider schema).
FirebaseAppHostingBuildContainer: Typed helper for the source.container block of google_firebase_app_hosting_build (derived from provider schema).
FirebaseAppHostingBuildSource: Exactly one of container, codebase on the source block of google_firebase_app_hosting_build: the provider rejects none and more than one, so each variant sets one of them.
FirebaseAppHostingBuildSourceCodebase: The FirebaseAppHostingBuildSource.codebase choice: sets codebase.
FirebaseAppHostingBuildSourceContainer: The FirebaseAppHostingBuildSource.container choice: sets container.
FirebaseAppHostingDomainRedirect: serve.redirect sub-block. Returns an HTTP 3xx redirect for every request hitting this domain.
FirebaseAppHostingDomainServe: serve block. When omitted (the default), the domain serves the backend's live content. When set, the redirect sub-block takes over -- requests are answered with an HTTP 3xx response pointing at the configured URI.
FirebaseAppHostingTrafficRolloutPolicy: rollout_policy block. Drives automated builds and rollouts off a git branch in the backend's linked Developer Connect repository. When omitted, the backend never auto-rolls out -- builds are triggered exclusively by explicit GoogleFirebaseAppHostingBuild resources.
FirebaseAppHostingTrafficRouting: Exactly one of rollout_policy, target on google_firebase_app_hosting_traffic: the provider rejects none and more than one, so each variant sets one of them.
FirebaseAppHostingTrafficRoutingRolloutPolicy: The FirebaseAppHostingTrafficRouting.rolloutPolicy choice: sets rollout_policy.
FirebaseAppHostingTrafficRoutingTarget: The FirebaseAppHostingTrafficRouting.target choice: sets target.
FirebaseAppHostingTrafficSplit: One entry in target.splits. Pairs a build with the percentage of traffic it should receive.
FirebaseAppHostingTrafficTarget: target block. Manually pin the desired traffic split across builds. The state's current field eventually reconverges to this value. Split percentages must sum to 100, and per the provider's current schema each individual entry must be exactly 0 or 100 (so today this behaves as "single live build" rather than a true weighted split).
GcsBackend: terraform { backend "gcs" { ... } } configuration.
GoogleFirebaseAppHostingBackend: Factory wrapper for google_firebase_app_hosting_backend.
GoogleFirebaseAppHostingBuild: Factory wrapper for google_firebase_app_hosting_build.
GoogleFirebaseAppHostingDefaultDomain: Factory wrapper for google_firebase_app_hosting_default_domain.
GoogleFirebaseAppHostingDomain: Factory wrapper for google_firebase_app_hosting_domain.
GoogleFirebaseAppHostingTraffic: Factory wrapper for google_firebase_app_hosting_traffic.
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

AppHostingServingLocality: serving_locality -- where App Hosting will serve content from. Set on create; immutable thereafter (changing forces replacement). regionalStrict pins serving to the backend's location; globalAccess lets App Hosting replicate across its global edge fleet.
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.

firebase_app_hosting library

Classes

Enums

Extension Types

Extensions

Constants

Functions

Exceptions / Errors

terradart_google package

firebase_app_hosting library