frontdoor library

Azure Resource Manager frontdoor resources.

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.
AzurermBackend
terraform { backend "azurerm" { ... } } configuration.
AzurermFrontdoor
Factory wrapper for azurerm_frontdoor.
AzurermFrontdoorCustomHttpsConfiguration
Factory wrapper for azurerm_frontdoor_custom_https_configuration.
AzurermFrontdoorFirewallPolicy
Factory wrapper for azurerm_frontdoor_firewall_policy.
AzurermFrontdoorRulesEngine
Factory wrapper for azurerm_frontdoor_rules_engine.
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.
FrontdoorBackend
Typed helper for the backend_pool.backend block of azurerm_frontdoor (derived from provider schema).
FrontdoorBackendPool
Typed helper for the backend_pool block of azurerm_frontdoor (derived from provider schema).
FrontdoorBackendPoolHealthProbe
Typed helper for the backend_pool_health_probe block of azurerm_frontdoor (derived from provider schema).
FrontdoorBackendPoolLoadBalancing
Typed helper for the backend_pool_load_balancing block of azurerm_frontdoor (derived from provider schema).
FrontdoorBackendPoolSettings
Typed helper for the backend_pool_settings block of azurerm_frontdoor (derived from provider schema).
FrontdoorCustomHttpsConfiguration
Typed helper for the custom_https_configuration block of azurerm_frontdoor_custom_https_configuration (derived from provider schema).
FrontdoorFirewallPolicyCustomRule
Typed helper for the custom_rule block of azurerm_frontdoor_firewall_policy (derived from provider schema).
FrontdoorFirewallPolicyExclusion
Typed helper for the managed_rule.exclusion block of azurerm_frontdoor_firewall_policy (derived from provider schema). Shared by every block of this shape in the resource.
FrontdoorFirewallPolicyManagedRule
Typed helper for the managed_rule block of azurerm_frontdoor_firewall_policy (derived from provider schema).
FrontdoorFirewallPolicyMatchCondition
Typed helper for the custom_rule.match_condition block of azurerm_frontdoor_firewall_policy (derived from provider schema).
FrontdoorFirewallPolicyOverride
Typed helper for the managed_rule.override block of azurerm_frontdoor_firewall_policy (derived from provider schema).
FrontdoorFirewallPolicyRule
Typed helper for the managed_rule.override.rule block of azurerm_frontdoor_firewall_policy (derived from provider schema).
FrontdoorForwardingConfiguration
Typed helper for the routing_rule.forwarding_configuration block of azurerm_frontdoor (derived from provider schema).
FrontdoorFrontendEndpoint
Typed helper for the frontend_endpoint block of azurerm_frontdoor (derived from provider schema).
FrontdoorRedirectConfiguration
Typed helper for the routing_rule.redirect_configuration block of azurerm_frontdoor (derived from provider schema).
FrontdoorRoutingRule
Typed helper for the routing_rule block of azurerm_frontdoor (derived from provider schema).
FrontdoorRulesEngineAction
Typed helper for the rule.action block of azurerm_frontdoor_rules_engine (derived from provider schema).
FrontdoorRulesEngineMatchCondition
Typed helper for the rule.match_condition block of azurerm_frontdoor_rules_engine (derived from provider schema).
FrontdoorRulesEngineRequestHeader
Typed helper for the rule.action.request_header block of azurerm_frontdoor_rules_engine (derived from provider schema).
FrontdoorRulesEngineResponseHeader
Typed helper for the rule.action.response_header block of azurerm_frontdoor_rules_engine (derived from provider schema).
FrontdoorRulesEngineRule
Typed helper for the rule block of azurerm_frontdoor_rules_engine (derived from provider schema).
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, AzurermBackend, 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 Stack.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

FrontdoorAcceptedProtocols
accepted_protocols — derived from the provider schema description.
FrontdoorCacheQueryParameterStripDirective
cache_query_parameter_strip_directive — derived from the provider schema description.
FrontdoorCustomHttpsConfigurationCertificateSource
certificate_source — derived from the provider schema description.
FrontdoorFirewallPolicyAction
action — derived from the provider schema description.
FrontdoorFirewallPolicyExclusionMatchVariable
match_variable — derived from the provider schema description.
FrontdoorFirewallPolicyExclusionOperator
operator — derived from the provider schema description.
FrontdoorFirewallPolicyMatchConditionMatchVariable
match_variable — derived from the provider schema description.
FrontdoorFirewallPolicyMatchConditionOperator
operator — derived from the provider schema description.
FrontdoorFirewallPolicyMode
Frontdoor Firewall Policy enum for mode.
FrontdoorFirewallPolicyTransforms
transforms — derived from the provider schema description.
FrontdoorFirewallPolicyType
type — derived from the provider schema description.
FrontdoorForwardingProtocol
forwarding_protocol — derived from the provider schema description.
FrontdoorProbeMethod
probe_method — derived from the provider schema description.
FrontdoorProtocol
protocol — derived from the provider schema description.
FrontdoorRedirectProtocol
redirect_protocol — derived from the provider schema description.
FrontdoorRedirectType
redirect_type — derived from the provider schema description.
FrontdoorRulesEngineHeaderActionType
header_action_type — derived from the provider schema description.
FrontdoorRulesEngineOperator
operator — derived from the provider schema description.
FrontdoorRulesEngineTransform
transform — derived from the provider schema description.
FrontdoorRulesEngineVariable
variable — 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.

Typedefs

EnumList<E extends TfArg<String>> = TfArg<List<E>>
A list-valued enum argument (allowed_grant_types, retry_conditions): a literal list of members of E, or one value Terraform resolves to the whole list.

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.