waf library

AWS WAF Classic.

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.
AwsWafByteMatchSet
Factory wrapper for aws_waf_byte_match_set.
AwsWafGeoMatchSet
Factory wrapper for aws_waf_geo_match_set.
AwsWafIpset
Factory wrapper for aws_waf_ipset.
AwsWafRateBasedRule
Factory wrapper for aws_waf_rate_based_rule.
AwsWafRegexMatchSet
Factory wrapper for aws_waf_regex_match_set.
AwsWafRegexPatternSet
Factory wrapper for aws_waf_regex_pattern_set.
AwsWafRule
Factory wrapper for aws_waf_rule.
AwsWafRuleGroup
Factory wrapper for aws_waf_rule_group.
AwsWafSizeConstraintSet
Factory wrapper for aws_waf_size_constraint_set.
AwsWafSqlInjectionMatchSet
Factory wrapper for aws_waf_sql_injection_match_set.
AwsWafWebAcl
Factory wrapper for aws_waf_web_acl.
AwsWafXssMatchSet
Factory wrapper for aws_waf_xss_match_set.
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.
DataAwsWafIpset
Factory wrapper for aws_waf_ipset.
DataAwsWafRateBasedRule
Factory wrapper for aws_waf_rate_based_rule.
DataAwsWafRule
Factory wrapper for aws_waf_rule.
DataAwsWafSubscribedRuleGroup
Factory wrapper for aws_waf_subscribed_rule_group.
DataAwsWafWebAcl
Factory wrapper for aws_waf_web_acl.
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.
WafByteMatchSetByteMatchTuples
Typed helper for the byte_match_tuples block of aws_waf_byte_match_set (derived from provider schema).
WafByteMatchSetFieldToMatch
Typed helper for the byte_match_tuples.field_to_match block of aws_waf_byte_match_set (derived from provider schema).
WafGeoMatchSetGeoMatchConstraint
Typed helper for the geo_match_constraint block of aws_waf_geo_match_set (derived from provider schema).
WafIpsetIpSetDescriptors
Typed helper for the ip_set_descriptors block of aws_waf_ipset (derived from provider schema).
WafRateBasedRulePredicates
Typed helper for the predicates block of aws_waf_rate_based_rule (derived from provider schema).
WafRegexMatchSetFieldToMatch
Typed helper for the regex_match_tuple.field_to_match block of aws_waf_regex_match_set (derived from provider schema).
WafRegexMatchSetRegexMatchTuple
Typed helper for the regex_match_tuple block of aws_waf_regex_match_set (derived from provider schema).
WafRuleGroupAction
Typed helper for the activated_rule.action block of aws_waf_rule_group (derived from provider schema).
WafRuleGroupActivatedRule
Typed helper for the activated_rule block of aws_waf_rule_group (derived from provider schema).
WafRulePredicates
Typed helper for the predicates block of aws_waf_rule (derived from provider schema).
WafSizeConstraintSetFieldToMatch
Typed helper for the size_constraints.field_to_match block of aws_waf_size_constraint_set (derived from provider schema).
WafSizeConstraintSetSizeConstraints
Typed helper for the size_constraints block of aws_waf_size_constraint_set (derived from provider schema).
WafSqlInjectionMatchSetFieldToMatch
Typed helper for the sql_injection_match_tuples.field_to_match block of aws_waf_sql_injection_match_set (derived from provider schema).
WafSqlInjectionMatchSetSqlInjectionMatchTuples
Typed helper for the sql_injection_match_tuples block of aws_waf_sql_injection_match_set (derived from provider schema).
WafWebAclAction
Typed helper for the rules.action block of aws_waf_web_acl (derived from provider schema).
WafWebAclDefaultAction
Typed helper for the default_action block of aws_waf_web_acl (derived from provider schema).
WafWebAclFieldToMatch
Typed helper for the logging_configuration.redacted_fields.field_to_match block of aws_waf_web_acl (derived from provider schema).
WafWebAclLoggingConfiguration
Typed helper for the logging_configuration block of aws_waf_web_acl (derived from provider schema).
WafWebAclOverrideAction
Typed helper for the rules.override_action block of aws_waf_web_acl (derived from provider schema).
WafWebAclRedactedFields
Typed helper for the logging_configuration.redacted_fields block of aws_waf_web_acl (derived from provider schema).
WafWebAclRules
Typed helper for the rules block of aws_waf_web_acl (derived from provider schema).
WafXssMatchSetFieldToMatch
Typed helper for the xss_match_tuples.field_to_match block of aws_waf_xss_match_set (derived from provider schema).
WafXssMatchSetXssMatchTuples
Typed helper for the xss_match_tuples block of aws_waf_xss_match_set (derived from provider schema).

Enums

ResourceKind
Whether a Stack entry is a resource block or a data block in Terraform JSON.

Extension Types

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, ...).
WafByteMatchSetType
type — derived from the provider schema description.
WafIpsetType
type — derived from the provider schema description.
WafRateBasedRuleType
type — derived from the provider schema description.
WafRuleType
type — derived from the provider schema description.
WafWebAclType
type — derived from the provider schema description.
WafXssMatchSetTextTransformation
text_transformation — derived from the provider schema description.
WafXssMatchSetType
type — derived from the provider schema description.

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").

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.