storage library

Azure Resource Manager storage 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.
AzurermStorageAccount
Factory wrapper for azurerm_storage_account.
AzurermStorageAccountCustomerManagedKey
Factory wrapper for azurerm_storage_account_customer_managed_key.
AzurermStorageAccountLocalUser
Factory wrapper for azurerm_storage_account_local_user.
AzurermStorageAccountNetworkRules
Factory wrapper for azurerm_storage_account_network_rules.
AzurermStorageAccountQueueProperties
Factory wrapper for azurerm_storage_account_queue_properties.
AzurermStorageAccountStaticWebsite
Factory wrapper for azurerm_storage_account_static_website.
AzurermStorageAccountTableProperties
Factory wrapper for azurerm_storage_account_table_properties.
AzurermStorageBlob
Factory wrapper for azurerm_storage_blob.
AzurermStorageBlobInventoryPolicy
Factory wrapper for azurerm_storage_blob_inventory_policy.
AzurermStorageContainer
Factory wrapper for azurerm_storage_container.
AzurermStorageContainerImmutabilityPolicy
Factory wrapper for azurerm_storage_container_immutability_policy.
AzurermStorageDataLakeGen2Filesystem
Factory wrapper for azurerm_storage_data_lake_gen2_filesystem.
AzurermStorageDataLakeGen2Path
Factory wrapper for azurerm_storage_data_lake_gen2_path.
AzurermStorageDiscoveryWorkspace
Factory wrapper for azurerm_storage_discovery_workspace.
AzurermStorageEncryptionScope
Factory wrapper for azurerm_storage_encryption_scope.
AzurermStorageManagementPolicy
Factory wrapper for azurerm_storage_management_policy.
AzurermStorageMover
Factory wrapper for azurerm_storage_mover.
AzurermStorageMoverAgent
Factory wrapper for azurerm_storage_mover_agent.
AzurermStorageMoverJobDefinition
Factory wrapper for azurerm_storage_mover_job_definition.
AzurermStorageMoverProject
Factory wrapper for azurerm_storage_mover_project.
AzurermStorageMoverSourceEndpoint
Factory wrapper for azurerm_storage_mover_source_endpoint.
AzurermStorageMoverTargetEndpoint
Factory wrapper for azurerm_storage_mover_target_endpoint.
AzurermStorageObjectReplication
Factory wrapper for azurerm_storage_object_replication.
AzurermStorageQueue
Factory wrapper for azurerm_storage_queue.
AzurermStorageShare
Factory wrapper for azurerm_storage_share.
AzurermStorageShareDirectory
Factory wrapper for azurerm_storage_share_directory.
AzurermStorageShareFile
Factory wrapper for azurerm_storage_share_file.
AzurermStorageSync
Factory wrapper for azurerm_storage_sync.
AzurermStorageSyncCloudEndpoint
Factory wrapper for azurerm_storage_sync_cloud_endpoint.
AzurermStorageSyncGroup
Factory wrapper for azurerm_storage_sync_group.
AzurermStorageSyncServerEndpoint
Factory wrapper for azurerm_storage_sync_server_endpoint.
AzurermStorageTable
Factory wrapper for azurerm_storage_table.
AzurermStorageTableEntity
Factory wrapper for azurerm_storage_table_entity.
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.
DataAzurermStorageAccount
Factory wrapper for azurerm_storage_account.
DataAzurermStorageAccountBlobContainerSas
Factory wrapper for azurerm_storage_account_blob_container_sas.
DataAzurermStorageAccountSas
Factory wrapper for azurerm_storage_account_sas.
DataAzurermStorageAccountStaticWebsite
Factory wrapper for azurerm_storage_account_static_website.
DataAzurermStorageBlob
Factory wrapper for azurerm_storage_blob.
DataAzurermStorageContainer
Factory wrapper for azurerm_storage_container.
DataAzurermStorageContainers
Factory wrapper for azurerm_storage_containers.
DataAzurermStorageEncryptionScope
Factory wrapper for azurerm_storage_encryption_scope.
DataAzurermStorageManagementPolicy
Factory wrapper for azurerm_storage_management_policy.
DataAzurermStorageQueue
Factory wrapper for azurerm_storage_queue.
DataAzurermStorageShare
Factory wrapper for azurerm_storage_share.
DataAzurermStorageSync
Factory wrapper for azurerm_storage_sync.
DataAzurermStorageSyncGroup
Factory wrapper for azurerm_storage_sync_group.
DataAzurermStorageTable
Factory wrapper for azurerm_storage_table.
DataAzurermStorageTableEntities
Factory wrapper for azurerm_storage_table_entities.
DataAzurermStorageTableEntity
Factory wrapper for azurerm_storage_table_entity.
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
DataStorageAccountBlobContainerSasPermissions
Typed helper for the permissions block of azurerm_storage_account_blob_container_sas (derived from provider schema).
DataStorageAccountSasPermissions
Typed helper for the permissions block of azurerm_storage_account_sas (derived from provider schema).
DataStorageAccountSasResourceTypes
Typed helper for the resource_types block of azurerm_storage_account_sas (derived from provider schema).
DataStorageAccountSasServices
Typed helper for the services block of azurerm_storage_account_sas (derived from provider schema).
DataStorageShareAcl
Typed helper for the acl block of azurerm_storage_share (derived from provider schema).
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.
StorageAccountActiveDirectory
Typed helper for the azure_files_authentication.active_directory block of azurerm_storage_account (derived from provider schema).
StorageAccountAzureFilesAuthentication
Typed helper for the azure_files_authentication block of azurerm_storage_account (derived from provider schema).
StorageAccountBlobProperties
Typed helper for the blob_properties block of azurerm_storage_account (derived from provider schema).
StorageAccountContainerDeleteRetentionPolicy
Typed helper for the blob_properties.container_delete_retention_policy block of azurerm_storage_account (derived from provider schema).
StorageAccountCorsRule
Typed helper for the blob_properties.cors_rule block of azurerm_storage_account (derived from provider schema). Shared by every block of this shape in the resource.
StorageAccountCustomDomain
Typed helper for the custom_domain block of azurerm_storage_account (derived from provider schema).
StorageAccountCustomerManagedKey
Typed helper for the customer_managed_key block of azurerm_storage_account (derived from provider schema).
StorageAccountDeleteRetentionPolicy
Typed helper for the blob_properties.delete_retention_policy block of azurerm_storage_account (derived from provider schema).
StorageAccountIdentity
Typed helper for the identity block of azurerm_storage_account (derived from provider schema).
StorageAccountImmutabilityPolicy
Typed helper for the immutability_policy block of azurerm_storage_account (derived from provider schema).
StorageAccountLocalUserPermissions
Typed helper for the permission_scope.permissions block of azurerm_storage_account_local_user (derived from provider schema).
StorageAccountLocalUserPermissionScope
Typed helper for the permission_scope block of azurerm_storage_account_local_user (derived from provider schema).
StorageAccountLocalUserSshAuthorizedKey
Typed helper for the ssh_authorized_key block of azurerm_storage_account_local_user (derived from provider schema).
StorageAccountNetworkRules
Typed helper for the network_rules block of azurerm_storage_account (derived from provider schema).
StorageAccountNetworkRulesPrivateLinkAccess
Typed helper for the private_link_access block of azurerm_storage_account_network_rules (derived from provider schema).
StorageAccountPrivateLinkAccess
Typed helper for the network_rules.private_link_access block of azurerm_storage_account (derived from provider schema).
StorageAccountQueuePropertiesCorsRule
Typed helper for the cors_rule block of azurerm_storage_account_queue_properties (derived from provider schema).
StorageAccountQueuePropertiesHourMetrics
Typed helper for the hour_metrics block of azurerm_storage_account_queue_properties (derived from provider schema).
StorageAccountQueuePropertiesLogging
Typed helper for the logging block of azurerm_storage_account_queue_properties (derived from provider schema).
StorageAccountQueuePropertiesMinuteMetrics
Typed helper for the minute_metrics block of azurerm_storage_account_queue_properties (derived from provider schema).
StorageAccountRestorePolicy
Typed helper for the blob_properties.restore_policy block of azurerm_storage_account (derived from provider schema).
StorageAccountRetentionPolicy
Typed helper for the share_properties.retention_policy block of azurerm_storage_account (derived from provider schema).
StorageAccountRouting
Typed helper for the routing block of azurerm_storage_account (derived from provider schema).
StorageAccountSasPolicy
Typed helper for the sas_policy block of azurerm_storage_account (derived from provider schema).
StorageAccountShareProperties
Typed helper for the share_properties block of azurerm_storage_account (derived from provider schema).
StorageAccountSmb
Typed helper for the share_properties.smb block of azurerm_storage_account (derived from provider schema).
StorageAccountTablePropertiesCorsRule
Typed helper for the cors_rule block of azurerm_storage_account_table_properties (derived from provider schema).
StorageAccountTablePropertiesHourMetrics
Typed helper for the hour_metrics block of azurerm_storage_account_table_properties (derived from provider schema).
StorageAccountTablePropertiesLogging
Typed helper for the logging block of azurerm_storage_account_table_properties (derived from provider schema).
StorageAccountTablePropertiesMinuteMetrics
Typed helper for the minute_metrics block of azurerm_storage_account_table_properties (derived from provider schema).
StorageBlobInventoryPolicyFilter
Typed helper for the rules.filter block of azurerm_storage_blob_inventory_policy (derived from provider schema).
StorageBlobInventoryPolicyRules
Typed helper for the rules block of azurerm_storage_blob_inventory_policy (derived from provider schema).
StorageDataLakeGen2FilesystemAce
Typed helper for the ace block of azurerm_storage_data_lake_gen2_filesystem (derived from provider schema).
StorageDataLakeGen2PathAce
Typed helper for the ace block of azurerm_storage_data_lake_gen2_path (derived from provider schema).
StorageDiscoveryWorkspaceScope
Typed helper for the scope block of azurerm_storage_discovery_workspace (derived from provider schema).
StorageManagementPolicyActions
Typed helper for the rule.actions block of azurerm_storage_management_policy (derived from provider schema).
StorageManagementPolicyBaseBlob
Typed helper for the rule.actions.base_blob block of azurerm_storage_management_policy (derived from provider schema).
StorageManagementPolicyFilters
Typed helper for the rule.filters block of azurerm_storage_management_policy (derived from provider schema).
StorageManagementPolicyMatchBlobIndexTag
Typed helper for the rule.filters.match_blob_index_tag block of azurerm_storage_management_policy (derived from provider schema).
StorageManagementPolicyRule
Typed helper for the rule block of azurerm_storage_management_policy (derived from provider schema).
StorageManagementPolicySnapshot
Typed helper for the rule.actions.snapshot block of azurerm_storage_management_policy (derived from provider schema).
StorageManagementPolicyVersion
Typed helper for the rule.actions.version block of azurerm_storage_management_policy (derived from provider schema).
StorageObjectReplicationRules
Typed helper for the rules block of azurerm_storage_object_replication (derived from provider schema).
StorageShareAccessPolicy
Typed helper for the acl.access_policy block of azurerm_storage_share (derived from provider schema).
StorageShareAcl
Typed helper for the acl block of azurerm_storage_share (derived from provider schema).
StorageTableAccessPolicy
Typed helper for the acl.access_policy block of azurerm_storage_table (derived from provider schema).
StorageTableAcl
Typed helper for the acl block of azurerm_storage_table (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, ...).
StorageAccountAccessTier
Storage Account Access enum for access_tier.
StorageAccountAllowedCopyScope
Storage Account Allowed Copy enum for allowed_copy_scope.
StorageAccountAllowedMethods
allowed_methods — derived from the provider schema description.
StorageAccountAuthenticationTypes
authentication_types — derived from the provider schema description.
StorageAccountBypass
bypass — derived from the provider schema description.
StorageAccountChannelEncryptionType
channel_encryption_type — derived from the provider schema description.
StorageAccountChoice
choice — derived from the provider schema description.
StorageAccountDefaultAction
default_action — derived from the provider schema description.
StorageAccountDefaultShareLevelPermission
default_share_level_permission — derived from the provider schema description.
StorageAccountDirectoryType
directory_type — derived from the provider schema description.
StorageAccountDnsEndpointType
Storage Account Dns Endpoint enum for dns_endpoint_type.
StorageAccountExpirationAction
expiration_action — derived from the provider schema description.
StorageAccountKerberosTicketEncryptionType
kerberos_ticket_encryption_type — derived from the provider schema description.
StorageAccountKind
Storage Account enum for account_kind.
StorageAccountLocalUserService
service — derived from the provider schema description.
StorageAccountMinTlsVersion
Storage Account Min Tls enum for min_tls_version.
StorageAccountNetworkRulesBypass
Storage Account Network Rules enum for bypass.
StorageAccountNetworkRulesDefaultAction
Storage Account Network Rules Default enum for default_action.
StorageAccountProvisionedBillingModelVersion
Storage Account Provisioned Billing Model enum for provisioned_billing_model_version.
StorageAccountPublicNetworkAccess
Storage Account Public Network enum for public_network_access.
StorageAccountQueueEncryptionKeyType
Storage Account Queue Encryption Key enum for queue_encryption_key_type.
StorageAccountQueuePropertiesAllowedMethods
allowed_methods — derived from the provider schema description.
StorageAccountReplicationType
Storage Account Replication enum for account_replication_type.
StorageAccountState
state — derived from the provider schema description.
StorageAccountTableEncryptionKeyType
Storage Account Table Encryption Key enum for table_encryption_key_type.
StorageAccountTablePropertiesAllowedMethods
allowed_methods — derived from the provider schema description.
StorageAccountTier
Storage Account enum for account_tier.
StorageAccountVersions
versions — derived from the provider schema description.
StorageBlobAccessTier
Storage Blob Access enum for access_tier.
StorageBlobInventoryPolicyBlobTypes
blob_types — derived from the provider schema description.
StorageBlobInventoryPolicyFormat
format — derived from the provider schema description.
StorageBlobInventoryPolicySchedule
schedule — derived from the provider schema description.
StorageBlobInventoryPolicyScope
scope — derived from the provider schema description.
StorageBlobType
Storage Blob enum for type.
StorageContainerAccessType
Storage Container Access enum for container_access_type.
StorageDataLakeGen2FilesystemScope
scope — derived from the provider schema description.
StorageDataLakeGen2FilesystemType
type — derived from the provider schema description.
StorageDataLakeGen2PathResource
Storage Data Lake Gen2 Path enum for resource.
StorageDataLakeGen2PathScope
scope — derived from the provider schema description.
StorageDataLakeGen2PathType
type — derived from the provider schema description.
StorageDiscoveryWorkspaceResourceTypes
resource_types — derived from the provider schema description.
StorageDiscoveryWorkspaceSku
Storage Discovery Workspace enum for sku.
StorageEncryptionScopeSource
Storage Encryption Scope enum for source.
StorageManagementPolicyBlobTypes
blob_types — derived from the provider schema description.
StorageManagementPolicyOperation
operation — derived from the provider schema description.
StorageMoverJobDefinitionCopyMode
Storage Mover Job Definition Copy enum for copy_mode.
StorageMoverSourceEndpointNfsVersion
Storage Mover Source Endpoint Nfs enum for nfs_version.
StorageShareAccessTier
Storage Share Access enum for access_tier.
StorageShareEnabledProtocol
Storage Share Enabled enum for enabled_protocol.
StorageSyncIncomingTrafficPolicy
Storage Sync Incoming Traffic enum for incoming_traffic_policy.
StorageSyncServerEndpointInitialDownloadPolicy
Storage Sync Server Endpoint Initial Download enum for initial_download_policy.
StorageSyncServerEndpointLocalCacheMode
Storage Sync Server Endpoint Local Cache enum for local_cache_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.