budgets library

AWS Budgets.

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.
AwsBudgetsBudget
Factory wrapper for aws_budgets_budget.
AwsBudgetsBudgetAction
Factory wrapper for aws_budgets_budget_action.
BudgetsBudgetActionDefinition
Typed helper for the definition block of aws_budgets_budget_action (derived from provider schema).
BudgetsBudgetActionIamActionDefinition
Typed helper for the definition.iam_action_definition block of aws_budgets_budget_action (derived from provider schema).
BudgetsBudgetActionScpActionDefinition
Typed helper for the definition.scp_action_definition block of aws_budgets_budget_action (derived from provider schema).
BudgetsBudgetActionSsmActionDefinition
Typed helper for the definition.ssm_action_definition block of aws_budgets_budget_action (derived from provider schema).
BudgetsBudgetActionSubscriber
Typed helper for the subscriber block of aws_budgets_budget_action (derived from provider schema).
BudgetsBudgetActionThreshold
Typed helper for the action_threshold block of aws_budgets_budget_action (derived from provider schema).
BudgetsBudgetAnd
Typed helper for the filter_expression.and block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetAndAnd
Typed helper for the filter_expression.and.and block of aws_budgets_budget (derived from provider schema). Shared by every block of this shape in the resource.
BudgetsBudgetAndCostCategories
Typed helper for the filter_expression.and.cost_categories block of aws_budgets_budget (derived from provider schema). Shared by every block of this shape in the resource.
BudgetsBudgetAndDimensions
Typed helper for the filter_expression.and.dimensions block of aws_budgets_budget (derived from provider schema). Shared by every block of this shape in the resource.
BudgetsBudgetAndNot
Typed helper for the filter_expression.and.not block of aws_budgets_budget (derived from provider schema). Shared by every block of this shape in the resource.
BudgetsBudgetAndOr
Typed helper for the filter_expression.and.or block of aws_budgets_budget (derived from provider schema). Shared by every block of this shape in the resource.
BudgetsBudgetAndTags
Typed helper for the filter_expression.and.tags block of aws_budgets_budget (derived from provider schema). Shared by every block of this shape in the resource.
BudgetsBudgetAutoAdjustData
Typed helper for the auto_adjust_data block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetCostCategories
Typed helper for the filter_expression.cost_categories block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetCostFilter
Typed helper for the cost_filter block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetCostTypes
Typed helper for the cost_types block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetDimensions
Typed helper for the filter_expression.dimensions block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetFilterExpression
Typed helper for the filter_expression block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetFilterExpressionTags
Typed helper for the filter_expression.tags block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetHistoricalOptions
Typed helper for the auto_adjust_data.historical_options block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetMeasure
At most one of cost_types, metrics on aws_budgets_budget: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
BudgetsBudgetMeasureCostTypes
The BudgetsBudgetMeasure.costTypes choice: sets cost_types.
BudgetsBudgetMeasureMetrics
The BudgetsBudgetMeasure.metrics choice: sets metrics.
BudgetsBudgetName
At most one of name, name_prefix on aws_budgets_budget: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
BudgetsBudgetNameChoice
The BudgetsBudgetName.name choice: sets name.
BudgetsBudgetNamePrefix
The BudgetsBudgetName.namePrefix choice: sets name_prefix.
BudgetsBudgetNot
Typed helper for the filter_expression.not block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetNotification
Typed helper for the notification block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetOr
Typed helper for the filter_expression.or block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetPlannedLimit
Typed helper for the planned_limit block of aws_budgets_budget (derived from provider schema).
BudgetsBudgetScope
At most one of cost_filter, filter_expression on aws_budgets_budget: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
BudgetsBudgetScopeCostFilter
The BudgetsBudgetScope.costFilter choice: sets cost_filter.
BudgetsBudgetScopeFilterExpression
The BudgetsBudgetScope.filterExpression choice: sets filter_expression.
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.
DataAwsBudgetsBudget
Factory wrapper for aws_budgets_budget.
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

BudgetsBudgetActionApprovalModel
Budgets Budget Action Approval enum for approval_model.
BudgetsBudgetActionNotificationType
Budgets Budget Action Notification enum for notification_type.
BudgetsBudgetActionSubscriptionType
subscription_type — derived from the provider schema description.
BudgetsBudgetActionSubType
action_sub_type — derived from the provider schema description.
BudgetsBudgetActionThresholdType
action_threshold_type — derived from the provider schema description.
BudgetsBudgetActionType
Budgets Budget Action enum for action_type.
BudgetsBudgetAutoAdjustType
auto_adjust_type — derived from the provider schema description.
BudgetsBudgetComparisonOperator
comparison_operator — derived from the provider schema description.
BudgetsBudgetKey
key — derived from the provider schema description.
BudgetsBudgetMatchOptions
match_options — derived from the provider schema description.
BudgetsBudgetMetrics
Budgets Budget enum for metrics.
BudgetsBudgetNotificationType
notification_type — derived from the provider schema description.
BudgetsBudgetThresholdType
threshold_type — derived from the provider schema description.
BudgetsBudgetTimeUnit
Budgets Budget Time enum for time_unit.
BudgetsBudgetType
Budgets Budget enum for budget_type.
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").

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.