batch library

Azure Resource Manager batch 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.
AzurermBatchAccount
Factory wrapper for azurerm_batch_account.
AzurermBatchApplication
Factory wrapper for azurerm_batch_application.
AzurermBatchJob
Factory wrapper for azurerm_batch_job.
AzurermBatchPool
Factory wrapper for azurerm_batch_pool.
BatchAccountAccess
Typed helper for the network_profile.account_access block of azurerm_batch_account (derived from provider schema).
BatchAccountIdentity
Typed helper for the identity block of azurerm_batch_account (derived from provider schema).
BatchAccountIpRule
Typed helper for the network_profile.account_access.ip_rule block of azurerm_batch_account (derived from provider schema). Shared by every block of this shape in the resource.
BatchAccountKeyVaultReference
Typed helper for the key_vault_reference block of azurerm_batch_account (derived from provider schema).
BatchAccountNetworkProfile
Typed helper for the network_profile block of azurerm_batch_account (derived from provider schema).
BatchAccountNodeManagementAccess
Typed helper for the network_profile.node_management_access block of azurerm_batch_account (derived from provider schema).
BatchPoolAutoScale
Typed helper for the auto_scale block of azurerm_batch_pool (derived from provider schema).
BatchPoolAutoUser
Typed helper for the start_task.user_identity.auto_user block of azurerm_batch_pool (derived from provider schema).
BatchPoolAzureBlobFileSystem
Typed helper for the mount.azure_blob_file_system block of azurerm_batch_pool (derived from provider schema).
BatchPoolAzureFileShare
Typed helper for the mount.azure_file_share block of azurerm_batch_pool (derived from provider schema).
BatchPoolCifsMount
Typed helper for the mount.cifs_mount block of azurerm_batch_pool (derived from provider schema).
BatchPoolContainer
Typed helper for the start_task.container block of azurerm_batch_pool (derived from provider schema).
BatchPoolContainerConfiguration
Typed helper for the container_configuration block of azurerm_batch_pool (derived from provider schema).
BatchPoolDataDisks
Typed helper for the data_disks block of azurerm_batch_pool (derived from provider schema).
BatchPoolDiskEncryption
Typed helper for the disk_encryption block of azurerm_batch_pool (derived from provider schema).
BatchPoolEndpointConfiguration
Typed helper for the network_configuration.endpoint_configuration block of azurerm_batch_pool (derived from provider schema).
BatchPoolExtensions
Typed helper for the extensions block of azurerm_batch_pool (derived from provider schema).
BatchPoolFixedScale
Typed helper for the fixed_scale block of azurerm_batch_pool (derived from provider schema).
BatchPoolIdentity
Typed helper for the identity block of azurerm_batch_pool (derived from provider schema).
BatchPoolLinuxUserConfiguration
Typed helper for the user_accounts.linux_user_configuration block of azurerm_batch_pool (derived from provider schema).
BatchPoolMount
Typed helper for the mount block of azurerm_batch_pool (derived from provider schema).
BatchPoolNetworkConfiguration
Typed helper for the network_configuration block of azurerm_batch_pool (derived from provider schema).
BatchPoolNetworkSecurityGroupRules
Typed helper for the network_configuration.endpoint_configuration.network_security_group_rules block of azurerm_batch_pool (derived from provider schema).
BatchPoolNfsMount
Typed helper for the mount.nfs_mount block of azurerm_batch_pool (derived from provider schema).
BatchPoolNodePlacement
Typed helper for the node_placement block of azurerm_batch_pool (derived from provider schema).
BatchPoolRegistry
Typed helper for the start_task.container.registry block of azurerm_batch_pool (derived from provider schema).
BatchPoolResourceFile
Typed helper for the start_task.resource_file block of azurerm_batch_pool (derived from provider schema).
BatchPoolSecurityProfile
Typed helper for the security_profile block of azurerm_batch_pool (derived from provider schema).
BatchPoolStartTask
Typed helper for the start_task block of azurerm_batch_pool (derived from provider schema).
BatchPoolStorageImageReference
Typed helper for the storage_image_reference block of azurerm_batch_pool (derived from provider schema).
BatchPoolTaskSchedulingPolicy
Typed helper for the task_scheduling_policy block of azurerm_batch_pool (derived from provider schema).
BatchPoolUserAccounts
Typed helper for the user_accounts block of azurerm_batch_pool (derived from provider schema).
BatchPoolUserIdentity
Typed helper for the start_task.user_identity block of azurerm_batch_pool (derived from provider schema).
BatchPoolWindows
Typed helper for the windows block of azurerm_batch_pool (derived from provider schema).
BatchPoolWindowsUserConfiguration
Typed helper for the user_accounts.windows_user_configuration block of azurerm_batch_pool (derived from provider schema).
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.
DataAzurermBatchAccount
Factory wrapper for azurerm_batch_account.
DataAzurermBatchApplication
Factory wrapper for azurerm_batch_application.
DataAzurermBatchPool
Factory wrapper for azurerm_batch_pool.
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.
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

BatchAccountAction
action — derived from the provider schema description.
BatchAccountAllowedAuthenticationModes
Batch Account Allowed Authentication enum for allowed_authentication_modes.
BatchAccountDefaultAction
default_action — derived from the provider schema description.
BatchAccountPoolAllocationMode
Batch Account Pool Allocation enum for pool_allocation_mode.
BatchAccountStorageAccountAuthenticationMode
Batch Account Storage Account Authentication enum for storage_account_authentication_mode.
BatchPoolAccess
access — derived from the provider schema description.
BatchPoolCaching
caching — derived from the provider schema description.
BatchPoolDiskEncryptionTarget
disk_encryption_target — derived from the provider schema description.
BatchPoolDynamicVnetAssignmentScope
dynamic_vnet_assignment_scope — derived from the provider schema description.
BatchPoolElevationLevel
elevation_level — derived from the provider schema description.
BatchPoolInterNodeCommunication
Batch Pool Inter Node enum for inter_node_communication.
BatchPoolLoginMode
login_mode — derived from the provider schema description.
BatchPoolNodeDeallocationMethod
node_deallocation_method — derived from the provider schema description.
BatchPoolNodeFillType
node_fill_type — derived from the provider schema description.
BatchPoolOsDiskPlacement
Batch Pool Os Disk enum for os_disk_placement.
BatchPoolPolicy
policy — derived from the provider schema description.
BatchPoolProtocol
protocol — derived from the provider schema description.
BatchPoolPublicAddressProvisioningType
public_address_provisioning_type — derived from the provider schema description.
BatchPoolScope
scope — derived from the provider schema description.
BatchPoolSecurityType
security_type — derived from the provider schema description.
BatchPoolStorageAccountType
storage_account_type — derived from the provider schema description.
BatchPoolTargetNodeCommunicationMode
Batch Pool Target Node Communication enum for target_node_communication_mode.
BatchPoolWorkingDirectory
working_directory — 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.