fsx library

AWS FSx.

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.
AwsFsxBackup
Factory wrapper for aws_fsx_backup.
AwsFsxDataRepositoryAssociation
Factory wrapper for aws_fsx_data_repository_association.
AwsFsxFileCache
Factory wrapper for aws_fsx_file_cache.
AwsFsxLustreFileSystem
Factory wrapper for aws_fsx_lustre_file_system.
AwsFsxOntapFileSystem
Factory wrapper for aws_fsx_ontap_file_system.
AwsFsxOntapStorageVirtualMachine
Factory wrapper for aws_fsx_ontap_storage_virtual_machine.
AwsFsxOntapVolume
Factory wrapper for aws_fsx_ontap_volume.
AwsFsxOpenzfsFileSystem
Factory wrapper for aws_fsx_openzfs_file_system.
AwsFsxOpenzfsSnapshot
Factory wrapper for aws_fsx_openzfs_snapshot.
AwsFsxOpenzfsVolume
Factory wrapper for aws_fsx_openzfs_volume.
AwsFsxS3AccessPointAttachment
Factory wrapper for aws_fsx_s3_access_point_attachment.
AwsFsxWindowsFileSystem
Factory wrapper for aws_fsx_windows_file_system.
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.
DataAwsFsxOntapFileSystem
Factory wrapper for aws_fsx_ontap_file_system.
DataAwsFsxOntapStorageVirtualMachine
Factory wrapper for aws_fsx_ontap_storage_virtual_machine.
DataAwsFsxOntapStorageVirtualMachines
Factory wrapper for aws_fsx_ontap_storage_virtual_machines.
DataAwsFsxOpenzfsSnapshot
Factory wrapper for aws_fsx_openzfs_snapshot.
DataAwsFsxWindowsFileSystem
Factory wrapper for aws_fsx_windows_file_system.
DataFsxOntapStorageVirtualMachineFilter
Typed helper for the filter block of aws_fsx_ontap_storage_virtual_machine (derived from provider schema).
DataFsxOntapStorageVirtualMachinesFilter
Typed helper for the filter block of aws_fsx_ontap_storage_virtual_machines (derived from provider schema).
DataFsxOpenzfsSnapshotFilter
Typed helper for the filter block of aws_fsx_openzfs_snapshot (derived from provider schema).
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
EnvironmentConstant
The AppConstant.fromEnvironment choice.
FsxDataRepositoryAssociationAutoExportPolicy
Typed helper for the s3.auto_export_policy block of aws_fsx_data_repository_association (derived from provider schema).
FsxDataRepositoryAssociationAutoImportPolicy
Typed helper for the s3.auto_import_policy block of aws_fsx_data_repository_association (derived from provider schema).
FsxDataRepositoryAssociationS3
Typed helper for the s3 block of aws_fsx_data_repository_association (derived from provider schema).
FsxFileCacheDataRepositoryAssociation
Typed helper for the data_repository_association block of aws_fsx_file_cache (derived from provider schema).
FsxFileCacheLustreConfiguration
Typed helper for the lustre_configuration block of aws_fsx_file_cache (derived from provider schema).
FsxFileCacheMetadataConfiguration
Typed helper for the lustre_configuration.metadata_configuration block of aws_fsx_file_cache (derived from provider schema).
FsxFileCacheNfs
Typed helper for the data_repository_association.nfs block of aws_fsx_file_cache (derived from provider schema).
FsxLustreFileSystemDataReadCacheConfiguration
Typed helper for the data_read_cache_configuration block of aws_fsx_lustre_file_system (derived from provider schema).
FsxLustreFileSystemLogConfiguration
Typed helper for the log_configuration block of aws_fsx_lustre_file_system (derived from provider schema).
FsxLustreFileSystemMetadataConfiguration
Typed helper for the metadata_configuration block of aws_fsx_lustre_file_system (derived from provider schema).
FsxLustreFileSystemRootSquashConfiguration
Typed helper for the root_squash_configuration block of aws_fsx_lustre_file_system (derived from provider schema).
FsxOntapFileSystemDiskIopsConfiguration
Typed helper for the disk_iops_configuration block of aws_fsx_ontap_file_system (derived from provider schema).
FsxOntapFileSystemThroughputCapacity
Exactly one of throughput_capacity, throughput_capacity_per_ha_pair on aws_fsx_ontap_file_system: the provider rejects none and more than one, so each variant sets one of them.
FsxOntapFileSystemThroughputCapacityChoice
The FsxOntapFileSystemThroughputCapacity.throughputCapacity choice: sets throughput_capacity.
FsxOntapFileSystemThroughputCapacityPerHaPair
The FsxOntapFileSystemThroughputCapacity.throughputCapacityPerHaPair choice: sets throughput_capacity_per_ha_pair.
FsxOntapStorageVirtualMachineActiveDirectoryConfiguration
Typed helper for the active_directory_configuration block of aws_fsx_ontap_storage_virtual_machine (derived from provider schema).
FsxOntapStorageVirtualMachineSelfManagedActiveDirectoryConfiguration
Typed helper for the active_directory_configuration.self_managed_active_directory_configuration block of aws_fsx_ontap_storage_virtual_machine (derived from provider schema).
FsxOntapVolumeAggregateConfiguration
Typed helper for the aggregate_configuration block of aws_fsx_ontap_volume (derived from provider schema).
FsxOntapVolumeAutocommitPeriod
Typed helper for the snaplock_configuration.autocommit_period block of aws_fsx_ontap_volume (derived from provider schema).
FsxOntapVolumeDefaultRetention
Typed helper for the snaplock_configuration.retention_period.default_retention block of aws_fsx_ontap_volume (derived from provider schema).
FsxOntapVolumeMaximumRetention
Typed helper for the snaplock_configuration.retention_period.maximum_retention block of aws_fsx_ontap_volume (derived from provider schema).
FsxOntapVolumeMinimumRetention
Typed helper for the snaplock_configuration.retention_period.minimum_retention block of aws_fsx_ontap_volume (derived from provider schema).
FsxOntapVolumeRetentionPeriod
Typed helper for the snaplock_configuration.retention_period block of aws_fsx_ontap_volume (derived from provider schema).
FsxOntapVolumeSize
Exactly one of size_in_bytes, size_in_megabytes on aws_fsx_ontap_volume: the provider rejects none and more than one, so each variant sets one of them.
FsxOntapVolumeSizeInBytes
The FsxOntapVolumeSize.sizeInBytes choice: sets size_in_bytes.
FsxOntapVolumeSizeInMegabytes
The FsxOntapVolumeSize.sizeInMegabytes choice: sets size_in_megabytes.
FsxOntapVolumeSnaplockConfiguration
Typed helper for the snaplock_configuration block of aws_fsx_ontap_volume (derived from provider schema).
FsxOntapVolumeTieringPolicy
Typed helper for the tiering_policy block of aws_fsx_ontap_volume (derived from provider schema).
FsxOpenzfsFileSystemClientConfigurations
Typed helper for the root_volume_configuration.nfs_exports.client_configurations block of aws_fsx_openzfs_file_system (derived from provider schema).
FsxOpenzfsFileSystemDiskIopsConfiguration
Typed helper for the disk_iops_configuration block of aws_fsx_openzfs_file_system (derived from provider schema).
FsxOpenzfsFileSystemNfsExports
Typed helper for the root_volume_configuration.nfs_exports block of aws_fsx_openzfs_file_system (derived from provider schema).
FsxOpenzfsFileSystemReadCacheConfiguration
Typed helper for the read_cache_configuration block of aws_fsx_openzfs_file_system (derived from provider schema).
FsxOpenzfsFileSystemRootVolumeConfiguration
Typed helper for the root_volume_configuration block of aws_fsx_openzfs_file_system (derived from provider schema).
FsxOpenzfsFileSystemUserAndGroupQuotas
Typed helper for the root_volume_configuration.user_and_group_quotas block of aws_fsx_openzfs_file_system (derived from provider schema).
FsxOpenzfsVolumeClientConfigurations
Typed helper for the nfs_exports.client_configurations block of aws_fsx_openzfs_volume (derived from provider schema).
FsxOpenzfsVolumeNfsExports
Typed helper for the nfs_exports block of aws_fsx_openzfs_volume (derived from provider schema).
FsxOpenzfsVolumeOriginSnapshot
Typed helper for the origin_snapshot block of aws_fsx_openzfs_volume (derived from provider schema).
FsxOpenzfsVolumeUserAndGroupQuotas
Typed helper for the user_and_group_quotas block of aws_fsx_openzfs_volume (derived from provider schema).
FsxS3AccessPointAttachmentFileSystemIdentity
Typed helper for the openzfs_configuration.file_system_identity block of aws_fsx_s3_access_point_attachment (derived from provider schema).
FsxS3AccessPointAttachmentOpenzfsConfiguration
Typed helper for the openzfs_configuration block of aws_fsx_s3_access_point_attachment (derived from provider schema).
FsxS3AccessPointAttachmentPosixUser
Typed helper for the openzfs_configuration.file_system_identity.posix_user block of aws_fsx_s3_access_point_attachment (derived from provider schema).
FsxS3AccessPointAttachmentS3AccessPoint
Typed helper for the s3_access_point block of aws_fsx_s3_access_point_attachment (derived from provider schema).
FsxS3AccessPointAttachmentVpcConfiguration
Typed helper for the s3_access_point.vpc_configuration block of aws_fsx_s3_access_point_attachment (derived from provider schema).
FsxWindowsFileSystemActiveDirectory
At most one of active_directory_id, self_managed_active_directory on aws_fsx_windows_file_system: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
FsxWindowsFileSystemActiveDirectoryId
The FsxWindowsFileSystemActiveDirectory.activeDirectoryId choice: sets active_directory_id.
FsxWindowsFileSystemAuditLogConfiguration
Typed helper for the audit_log_configuration block of aws_fsx_windows_file_system (derived from provider schema).
FsxWindowsFileSystemDiskIopsConfiguration
Typed helper for the disk_iops_configuration block of aws_fsx_windows_file_system (derived from provider schema).
FsxWindowsFileSystemSelfManagedActiveDirectory
Typed helper for the self_managed_active_directory block of aws_fsx_windows_file_system (derived from provider schema).
FsxWindowsFileSystemSelfManagedActiveDirectoryChoice
The FsxWindowsFileSystemActiveDirectory.selfManagedActiveDirectory choice: sets self_managed_active_directory.
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

FsxDataRepositoryAssociationEvents
events — derived from the provider schema description.
FsxFileCacheDeploymentType
deployment_type — derived from the provider schema description.
FsxFileCacheType
Fsx File Cache enum for file_cache_type.
FsxFileCacheVersion
version — derived from the provider schema description.
FsxLustreFileSystemAutoImportPolicy
Fsx Lustre File System Auto Import enum for auto_import_policy.
FsxLustreFileSystemDataCompressionType
Fsx Lustre File System Data Compression enum for data_compression_type.
FsxLustreFileSystemDeploymentType
Fsx Lustre File System Deployment enum for deployment_type.
FsxLustreFileSystemDriveCacheType
Fsx Lustre File System Drive Cache enum for drive_cache_type.
FsxLustreFileSystemLevel
level — derived from the provider schema description.
FsxLustreFileSystemMode
mode — derived from the provider schema description.
FsxLustreFileSystemSizingMode
sizing_mode — derived from the provider schema description.
FsxLustreFileSystemStorageType
Fsx Lustre File System Storage enum for storage_type.
FsxOntapFileSystemDeploymentType
Fsx Ontap File System Deployment enum for deployment_type.
FsxOntapFileSystemMode
mode — derived from the provider schema description.
FsxOntapFileSystemNetworkType
Fsx Ontap File System Network enum for network_type.
FsxOntapFileSystemStorageType
Fsx Ontap File System Storage enum for storage_type.
FsxOntapStorageVirtualMachineRootVolumeSecurityStyle
Fsx Ontap Storage Virtual Machine Root Volume Security enum for root_volume_security_style.
FsxOntapVolumeAutocommitPeriodType
type — derived from the provider schema description.
FsxOntapVolumeDefaultRetentionType
type — derived from the provider schema description.
FsxOntapVolumeOntapVolumeType
Fsx Ontap Volume Ontap Volume enum for ontap_volume_type.
FsxOntapVolumePrivilegedDelete
privileged_delete — derived from the provider schema description.
FsxOntapVolumeSecurityStyle
Fsx Ontap Volume Security enum for security_style.
FsxOntapVolumeSnaplockType
snaplock_type — derived from the provider schema description.
FsxOntapVolumeStyle
Fsx Ontap Volume enum for volume_style.
FsxOntapVolumeTieringPolicyName
name — derived from the provider schema description.
FsxOntapVolumeType
Fsx Ontap Volume enum for volume_type.
FsxOpenzfsFileSystemDataCompressionType
data_compression_type — derived from the provider schema description.
FsxOpenzfsFileSystemDeleteOptions
Fsx Openzfs File System Delete enum for delete_options.
FsxOpenzfsFileSystemDeploymentType
Fsx Openzfs File System Deployment enum for deployment_type.
FsxOpenzfsFileSystemMode
mode — derived from the provider schema description.
FsxOpenzfsFileSystemNetworkType
Fsx Openzfs File System Network enum for network_type.
FsxOpenzfsFileSystemSizingMode
sizing_mode — derived from the provider schema description.
FsxOpenzfsFileSystemStorageType
Fsx Openzfs File System Storage enum for storage_type.
FsxOpenzfsFileSystemType
type — derived from the provider schema description.
FsxOpenzfsVolumeCopyStrategy
copy_strategy — derived from the provider schema description.
FsxOpenzfsVolumeDataCompressionType
Fsx Openzfs Volume Data Compression enum for data_compression_type.
FsxOpenzfsVolumeDeleteVolumeOptions
Fsx Openzfs Volume Delete Volume enum for delete_volume_options.
FsxOpenzfsVolumeType
Fsx Openzfs Volume enum for volume_type.
FsxOpenzfsVolumeUserAndGroupQuotasType
type — derived from the provider schema description.
FsxS3AccessPointAttachmentFileSystemIdentityType
type — derived from the provider schema description.
FsxS3AccessPointAttachmentType
Fsx S3 Access Point Attachment enum for type.
FsxWindowsFileSystemDeploymentType
Fsx Windows File System Deployment enum for deployment_type.
FsxWindowsFileSystemFileAccessAuditLogLevel
file_access_audit_log_level — derived from the provider schema description.
FsxWindowsFileSystemFileShareAccessAuditLogLevel
file_share_access_audit_log_level — derived from the provider schema description.
FsxWindowsFileSystemMode
mode — derived from the provider schema description.
FsxWindowsFileSystemNetworkType
Fsx Windows File System Network enum for network_type.
FsxWindowsFileSystemStorageType
Fsx Windows File System Storage enum for storage_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.