resource library

Azure resource groups, deployments, and policy assignments at the resource scope.

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.
AzurermResourceDeploymentScriptAzureCli
Factory wrapper for azurerm_resource_deployment_script_azure_cli.
AzurermResourceDeploymentScriptAzurePowerShell
Factory wrapper for azurerm_resource_deployment_script_azure_power_shell.
AzurermResourceGroup
Factory wrapper for azurerm_resource_group.
AzurermResourceGroupCostManagementExport
Factory wrapper for azurerm_resource_group_cost_management_export.
AzurermResourceGroupCostManagementView
Factory wrapper for azurerm_resource_group_cost_management_view.
AzurermResourceGroupPolicyAssignment
Factory wrapper for azurerm_resource_group_policy_assignment.
AzurermResourceGroupPolicyExemption
Factory wrapper for azurerm_resource_group_policy_exemption.
AzurermResourceGroupPolicyRemediation
Factory wrapper for azurerm_resource_group_policy_remediation.
AzurermResourceGroupTemplateDeployment
Factory wrapper for azurerm_resource_group_template_deployment.
Factory wrapper for azurerm_resource_management_private_link.
AzurermResourceManagementPrivateLinkAssociation
Factory wrapper for azurerm_resource_management_private_link_association.
AzurermResourcePolicyAssignment
Factory wrapper for azurerm_resource_policy_assignment.
AzurermResourcePolicyExemption
Factory wrapper for azurerm_resource_policy_exemption.
AzurermResourcePolicyRemediation
Factory wrapper for azurerm_resource_policy_remediation.
AzurermResourceProviderFeatureRegistration
Factory wrapper for azurerm_resource_provider_feature_registration.
AzurermResourceProviderRegistration
Factory wrapper for azurerm_resource_provider_registration.
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.
DataAzurermResourceGroup
Factory wrapper for azurerm_resource_group.
DataAzurermResourceGroupTemplateDeployment
Factory wrapper for azurerm_resource_group_template_deployment.
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.
ResourceDeploymentScriptAzureCliContainer
Typed helper for the container block of azurerm_resource_deployment_script_azure_cli (derived from provider schema).
ResourceDeploymentScriptAzureCliEnvironmentVariable
Typed helper for the environment_variable block of azurerm_resource_deployment_script_azure_cli (derived from provider schema).
ResourceDeploymentScriptAzureCliIdentity
Typed helper for the identity block of azurerm_resource_deployment_script_azure_cli (derived from provider schema).
ResourceDeploymentScriptAzureCliStorageAccount
Typed helper for the storage_account block of azurerm_resource_deployment_script_azure_cli (derived from provider schema).
ResourceDeploymentScriptAzurePowerShellContainer
Typed helper for the container block of azurerm_resource_deployment_script_azure_power_shell (derived from provider schema).
ResourceDeploymentScriptAzurePowerShellEnvironmentVariable
Typed helper for the environment_variable block of azurerm_resource_deployment_script_azure_power_shell (derived from provider schema).
ResourceDeploymentScriptAzurePowerShellIdentity
Typed helper for the identity block of azurerm_resource_deployment_script_azure_power_shell (derived from provider schema).
ResourceDeploymentScriptAzurePowerShellStorageAccount
Typed helper for the storage_account block of azurerm_resource_deployment_script_azure_power_shell (derived from provider schema).
ResourceGroupCostManagementExportDataOptions
Typed helper for the export_data_options block of azurerm_resource_group_cost_management_export (derived from provider schema).
ResourceGroupCostManagementExportDataStorageLocation
Typed helper for the export_data_storage_location block of azurerm_resource_group_cost_management_export (derived from provider schema).
ResourceGroupCostManagementViewAggregation
Typed helper for the dataset.aggregation block of azurerm_resource_group_cost_management_view (derived from provider schema).
ResourceGroupCostManagementViewDataset
Typed helper for the dataset block of azurerm_resource_group_cost_management_view (derived from provider schema).
ResourceGroupCostManagementViewGrouping
Typed helper for the dataset.grouping block of azurerm_resource_group_cost_management_view (derived from provider schema).
ResourceGroupCostManagementViewKpi
Typed helper for the kpi block of azurerm_resource_group_cost_management_view (derived from provider schema).
ResourceGroupCostManagementViewPivot
Typed helper for the pivot block of azurerm_resource_group_cost_management_view (derived from provider schema).
ResourceGroupCostManagementViewSorting
Typed helper for the dataset.sorting block of azurerm_resource_group_cost_management_view (derived from provider schema).
ResourceGroupPolicyAssignmentIdentity
Typed helper for the identity block of azurerm_resource_group_policy_assignment (derived from provider schema).
ResourceGroupPolicyAssignmentNonComplianceMessage
Typed helper for the non_compliance_message block of azurerm_resource_group_policy_assignment (derived from provider schema).
ResourceGroupPolicyAssignmentOverrides
Typed helper for the overrides block of azurerm_resource_group_policy_assignment (derived from provider schema).
ResourceGroupPolicyAssignmentOverridesSelectors
Typed helper for the overrides.selectors block of azurerm_resource_group_policy_assignment (derived from provider schema).
ResourceGroupPolicyAssignmentResourceSelectors
Typed helper for the resource_selectors block of azurerm_resource_group_policy_assignment (derived from provider schema).
ResourceGroupPolicyAssignmentResourceSelectorsSelectors
Typed helper for the resource_selectors.selectors block of azurerm_resource_group_policy_assignment (derived from provider schema).
ResourceGroupTemplateDeploymentTemplate
Exactly one of template_content, template_spec_version_id on azurerm_resource_group_template_deployment: the provider rejects none and more than one, so each variant sets one of them.
ResourceGroupTemplateDeploymentTemplateContent
The ResourceGroupTemplateDeploymentTemplate.templateContent choice: sets template_content.
ResourceGroupTemplateDeploymentTemplateSpecVersionId
The ResourceGroupTemplateDeploymentTemplate.templateSpecVersionId choice: sets template_spec_version_id.
ResourcePolicyAssignmentIdentity
Typed helper for the identity block of azurerm_resource_policy_assignment (derived from provider schema).
ResourcePolicyAssignmentNonComplianceMessage
Typed helper for the non_compliance_message block of azurerm_resource_policy_assignment (derived from provider schema).
ResourcePolicyAssignmentOverrides
Typed helper for the overrides block of azurerm_resource_policy_assignment (derived from provider schema).
ResourcePolicyAssignmentOverridesSelectors
Typed helper for the overrides.selectors block of azurerm_resource_policy_assignment (derived from provider schema).
ResourcePolicyAssignmentResourceSelectors
Typed helper for the resource_selectors block of azurerm_resource_policy_assignment (derived from provider schema).
ResourcePolicyAssignmentResourceSelectorsSelectors
Typed helper for the resource_selectors.selectors block of azurerm_resource_policy_assignment (derived from provider schema).
ResourceProviderRegistrationFeature
Typed helper for the feature block of azurerm_resource_provider_registration (derived from provider schema).
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

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, ...).
ResourceGroupPolicyRemediationResourceDiscoveryMode
Resource Group Policy Remediation Resource Discovery enum for resource_discovery_mode.
ResourceGroupTemplateDeploymentDebugLevel
Resource Group Template Deployment Debug enum for debug_level.
ResourcePolicyRemediationResourceDiscoveryMode
Resource Policy Remediation Resource Discovery enum for resource_discovery_mode.

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.