synapse library

Azure Resource Manager synapse 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.
AzurermSynapseFirewallRule
Factory wrapper for azurerm_synapse_firewall_rule.
AzurermSynapseIntegrationRuntimeAzure
Factory wrapper for azurerm_synapse_integration_runtime_azure.
AzurermSynapseIntegrationRuntimeSelfHosted
Factory wrapper for azurerm_synapse_integration_runtime_self_hosted.
AzurermSynapseLinkedService
Factory wrapper for azurerm_synapse_linked_service.
AzurermSynapseManagedPrivateEndpoint
Factory wrapper for azurerm_synapse_managed_private_endpoint.
AzurermSynapsePrivateLinkHub
Factory wrapper for azurerm_synapse_private_link_hub.
AzurermSynapseRoleAssignment
Factory wrapper for azurerm_synapse_role_assignment.
AzurermSynapseSparkPool
Factory wrapper for azurerm_synapse_spark_pool.
AzurermSynapseSqlPool
Factory wrapper for azurerm_synapse_sql_pool.
AzurermSynapseSqlPoolExtendedAuditingPolicy
Factory wrapper for azurerm_synapse_sql_pool_extended_auditing_policy.
AzurermSynapseSqlPoolSecurityAlertPolicy
Factory wrapper for azurerm_synapse_sql_pool_security_alert_policy.
AzurermSynapseSqlPoolVulnerabilityAssessment
Factory wrapper for azurerm_synapse_sql_pool_vulnerability_assessment.
AzurermSynapseSqlPoolVulnerabilityAssessmentBaseline
Factory wrapper for azurerm_synapse_sql_pool_vulnerability_assessment_baseline.
AzurermSynapseSqlPoolWorkloadClassifier
Factory wrapper for azurerm_synapse_sql_pool_workload_classifier.
AzurermSynapseSqlPoolWorkloadGroup
Factory wrapper for azurerm_synapse_sql_pool_workload_group.
AzurermSynapseWorkspace
Factory wrapper for azurerm_synapse_workspace.
AzurermSynapseWorkspaceAadAdmin
Factory wrapper for azurerm_synapse_workspace_aad_admin.
AzurermSynapseWorkspaceExtendedAuditingPolicy
Factory wrapper for azurerm_synapse_workspace_extended_auditing_policy.
AzurermSynapseWorkspaceKey
Factory wrapper for azurerm_synapse_workspace_key.
AzurermSynapseWorkspaceSecurityAlertPolicy
Factory wrapper for azurerm_synapse_workspace_security_alert_policy.
AzurermSynapseWorkspaceSqlAadAdmin
Factory wrapper for azurerm_synapse_workspace_sql_aad_admin.
AzurermSynapseWorkspaceVulnerabilityAssessment
Factory wrapper for azurerm_synapse_workspace_vulnerability_assessment.
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.
DataAzurermSynapseWorkspace
Factory wrapper for azurerm_synapse_workspace.
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, 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.
SynapseLinkedServiceIntegrationRuntime
Typed helper for the integration_runtime block of azurerm_synapse_linked_service (derived from provider schema).
SynapseRoleAssignmentSynapse
Exactly one of synapse_spark_pool_id, synapse_workspace_id on azurerm_synapse_role_assignment: the provider rejects none and more than one, so each variant sets one of them.
SynapseRoleAssignmentSynapseSparkPoolId
The SynapseRoleAssignmentSynapse.synapseSparkPoolId choice: sets synapse_spark_pool_id.
SynapseRoleAssignmentSynapseWorkspaceId
The SynapseRoleAssignmentSynapse.synapseWorkspaceId choice: sets synapse_workspace_id.
SynapseSparkPoolAutoPause
Typed helper for the auto_pause block of azurerm_synapse_spark_pool (derived from provider schema).
SynapseSparkPoolAutoScale
Typed helper for the auto_scale block of azurerm_synapse_spark_pool (derived from provider schema).
SynapseSparkPoolAutoScaleChoice
The SynapseSparkPoolScale.autoScale choice: sets auto_scale.
SynapseSparkPoolLibraryRequirement
Typed helper for the library_requirement block of azurerm_synapse_spark_pool (derived from provider schema).
SynapseSparkPoolScale
Exactly one of auto_scale, node_count on azurerm_synapse_spark_pool: the provider rejects none and more than one, so each variant sets one of them.
SynapseSparkPoolScaleNodeCount
The SynapseSparkPoolScale.nodeCount choice: sets node_count.
SynapseSparkPoolSparkConfig
Typed helper for the spark_config block of azurerm_synapse_spark_pool (derived from provider schema).
SynapseSqlPoolRecovery
At most one of recovery_database_id, restore on azurerm_synapse_sql_pool: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
SynapseSqlPoolRecoveryDatabaseId
The SynapseSqlPoolRecovery.recoveryDatabaseId choice: sets recovery_database_id.
SynapseSqlPoolRecoveryRestore
The SynapseSqlPoolRecovery.restore choice: sets restore.
SynapseSqlPoolRestore
Typed helper for the restore block of azurerm_synapse_sql_pool (derived from provider schema).
SynapseSqlPoolVulnerabilityAssessmentBaseline
Typed helper for the baseline block of azurerm_synapse_sql_pool_vulnerability_assessment_baseline (derived from provider schema).
SynapseSqlPoolVulnerabilityAssessmentRecurringScans
Typed helper for the recurring_scans block of azurerm_synapse_sql_pool_vulnerability_assessment (derived from provider schema).
SynapseWorkspaceAzureDevopsRepo
Typed helper for the azure_devops_repo block of azurerm_synapse_workspace (derived from provider schema).
SynapseWorkspaceAzureDevopsRepoChoice
The SynapseWorkspaceRepo.azureDevopsRepo choice: sets azure_devops_repo.
SynapseWorkspaceCustomerManagedKey
Typed helper for the customer_managed_key block of azurerm_synapse_workspace (derived from provider schema).
SynapseWorkspaceGithubRepo
Typed helper for the github_repo block of azurerm_synapse_workspace (derived from provider schema).
SynapseWorkspaceGithubRepoChoice
The SynapseWorkspaceRepo.githubRepo choice: sets github_repo.
SynapseWorkspaceIdentity
Typed helper for the identity block of azurerm_synapse_workspace (derived from provider schema).
SynapseWorkspaceRepo
At most one of azure_devops_repo, github_repo on azurerm_synapse_workspace: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
SynapseWorkspaceVulnerabilityAssessmentRecurringScans
Typed helper for the recurring_scans block of azurerm_synapse_workspace_vulnerability_assessment (derived from provider schema).
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, ...).
SynapseRoleAssignmentPrincipalType
Synapse Role Assignment Principal enum for principal_type.
SynapseRoleAssignmentRoleName
Synapse Role Assignment Role enum for role_name.
SynapseSparkPoolNodeSize
Synapse Spark Pool Node enum for node_size.
SynapseSparkPoolNodeSizeFamily
Synapse Spark Pool Node Size enum for node_size_family.
SynapseSparkPoolSparkVersion
Synapse Spark Pool Spark enum for spark_version.
SynapseSqlPoolCreateMode
Synapse Sql Pool Create enum for create_mode.
SynapseSqlPoolSecurityAlertPolicyDisabledAlerts
Synapse Sql Pool Security Alert Policy Disabled enum for disabled_alerts.
SynapseSqlPoolSkuName
Synapse Sql Pool Sku enum for sku_name.
SynapseSqlPoolWorkloadClassifierImportance
Synapse Sql Pool Workload Classifier enum for importance.
SynapseWorkspaceSecurityAlertPolicyDisabledAlerts
Synapse Workspace Security Alert Policy Disabled enum for disabled_alerts.

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.