storage library
Cloud Storage buckets, bucket objects, Pub/Sub object-change notifications, inventory reports, Storage Transfer jobs, and fine-grained ACLs.
Classes
-
AppConstant<
T> -
A value the Stack hands to application code as a
static constin 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 constmembers 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. - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - DataGoogleStorageBucket
-
Factory wrapper for
google_storage_bucket. - DataGoogleStorageBucketIamPolicy
-
Factory wrapper for
google_storage_bucket_iam_policy. - DataGoogleStorageBucketObject
-
Factory wrapper for
google_storage_bucket_object. - DataGoogleStorageBucketObjectContent
-
Factory wrapper for
google_storage_bucket_object_content. - DataGoogleStorageBucketObjectContents
-
Factory wrapper for
google_storage_bucket_object_contents. - DataGoogleStorageBucketObjects
-
Factory wrapper for
google_storage_bucket_objects. - DataGoogleStorageBuckets
-
Factory wrapper for
google_storage_buckets. - DataGoogleStorageInsightsDatasetConfig
-
Factory wrapper for
google_storage_insights_dataset_config. - DataGoogleStorageManagedFolderIamPolicy
-
Factory wrapper for
google_storage_managed_folder_iam_policy. - DataGoogleStorageObjectSignedUrl
-
Factory wrapper for
google_storage_object_signed_url. - DataGoogleStorageProjectServiceAccount
-
Factory wrapper for
google_storage_project_service_account. - DataGoogleStorageTransferProjectServiceAccount
-
Factory wrapper for
google_storage_transfer_project_service_account. -
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. - GoogleStorageAnywhereCache
-
Factory wrapper for
google_storage_anywhere_cache. - GoogleStorageBatchOperationsJob
-
Factory wrapper for
google_storage_batch_operations_job. - GoogleStorageBucket
-
Factory wrapper for
google_storage_bucket. - GoogleStorageBucketAccessControl
-
Factory wrapper for
google_storage_bucket_access_control. - GoogleStorageBucketAcl
-
Factory wrapper for
google_storage_bucket_acl. - GoogleStorageBucketIamBinding
-
Factory wrapper for
google_storage_bucket_iam_binding. - GoogleStorageBucketIamMember
-
Factory wrapper for
google_storage_bucket_iam_member. - GoogleStorageBucketIamPolicy
-
Factory wrapper for
google_storage_bucket_iam_policy. - GoogleStorageBucketObject
-
Factory wrapper for
google_storage_bucket_object. - GoogleStorageDefaultObjectAccessControl
-
Factory wrapper for
google_storage_default_object_access_control. - GoogleStorageDefaultObjectAcl
-
Factory wrapper for
google_storage_default_object_acl. - GoogleStorageFolder
-
Factory wrapper for
google_storage_folder. - GoogleStorageFtpServer
-
Factory wrapper for
google_storage_ftp_server. - GoogleStorageFtpUser
-
Factory wrapper for
google_storage_ftp_user. - GoogleStorageHmacKey
-
Factory wrapper for
google_storage_hmac_key. - GoogleStorageInsightsDatasetConfig
-
Factory wrapper for
google_storage_insights_dataset_config. - GoogleStorageInsightsReportConfig
-
Factory wrapper for
google_storage_insights_report_config. - GoogleStorageManagedFolder
-
Factory wrapper for
google_storage_managed_folder. - GoogleStorageManagedFolderIamBinding
-
Factory wrapper for
google_storage_managed_folder_iam_binding. - GoogleStorageManagedFolderIamMember
-
Factory wrapper for
google_storage_managed_folder_iam_member. - GoogleStorageManagedFolderIamPolicy
-
Factory wrapper for
google_storage_managed_folder_iam_policy. - GoogleStorageNotification
-
Factory wrapper for
google_storage_notification. - GoogleStorageObjectAccessControl
-
Factory wrapper for
google_storage_object_access_control. - GoogleStorageObjectAcl
-
Factory wrapper for
google_storage_object_acl. - GoogleStorageTransferAgentPool
-
Factory wrapper for
google_storage_transfer_agent_pool. - GoogleStorageTransferJob
-
Factory wrapper for
google_storage_transfer_job. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_changescovers: every attribute, or the listed ones. - InvalidDartDefineOutput
-
An output of
Stack.addDartDefineOutputthat 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
lifecycleblock Terraform rejects: a data source (or one of its attributes) inreplaceTriggeredBy,allinside IgnoreChanges.of, or a condition with an empty error message. - InvalidMoveTarget
-
A
movedblock whosetonames no resource of the Stack. - InvalidTimeout
-
A negative
timeoutsduration. - LifecycleCondition
-
A
preconditionorpostconditionblock: 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 (
googleforgoogle_pubsub_topic), the one itsprovidermeta-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.replaceTriggeredBylists: a resource of the Stack or an attribute getter of one.Resourceand TfRef implement it; synth reports a data source or a data-source attribute as anInvalidLifecycle. - 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, andLocalBackend; anything else implements this interface in the caller. TheStackonly stores the value and exposes a discriminator for synth'sterraform { backend ... }emitter. - StackProvider
-
Coordination interface between
Stack(in this package) and concrete providers (e.g.GoogleProviderinterradart_google). Concrete providers implement every getter using their baked-in constants from Stage 2 codegen. - StorageBatchOperationsJobBucketList
-
Typed helper for the
bucket_listblock ofgoogle_storage_batch_operations_job(derived from provider schema). - StorageBatchOperationsJobBuckets
-
Typed helper for the
bucket_list.bucketsblock ofgoogle_storage_batch_operations_job(derived from provider schema). - StorageBatchOperationsJobDeleteObject
-
Typed helper for the
delete_objectblock ofgoogle_storage_batch_operations_job(derived from provider schema). - StorageBatchOperationsJobManifest
-
Typed helper for the
bucket_list.buckets.manifestblock ofgoogle_storage_batch_operations_job(derived from provider schema). - StorageBatchOperationsJobObjects
-
Exactly one of
prefix_list,manifeston thebucket_list.bucketsblock ofgoogle_storage_batch_operations_job: the provider rejects none and more than one, so each variant sets one of them. - StorageBatchOperationsJobObjectsManifest
-
The StorageBatchOperationsJobObjects.manifest choice: sets
manifest. - StorageBatchOperationsJobObjectsPrefixList
-
The StorageBatchOperationsJobObjects.prefixList choice: sets
prefix_list. - StorageBatchOperationsJobOperation
-
Exactly one of
delete_object,put_metadata,rewrite_object,put_object_holdongoogle_storage_batch_operations_job: the provider rejects none and more than one, so each variant sets one of them. - StorageBatchOperationsJobOperationDeleteObject
-
The StorageBatchOperationsJobOperation.deleteObject choice: sets
delete_object. - StorageBatchOperationsJobOperationPutMetadata
-
The StorageBatchOperationsJobOperation.putMetadata choice: sets
put_metadata. - StorageBatchOperationsJobOperationPutObjectHold
-
The StorageBatchOperationsJobOperation.putObjectHold choice: sets
put_object_hold. - StorageBatchOperationsJobOperationRewriteObject
-
The StorageBatchOperationsJobOperation.rewriteObject choice: sets
rewrite_object. - StorageBatchOperationsJobPrefixList
-
Typed helper for the
bucket_list.buckets.prefix_listblock ofgoogle_storage_batch_operations_job(derived from provider schema). - StorageBatchOperationsJobPutMetadata
-
Typed helper for the
put_metadatablock ofgoogle_storage_batch_operations_job(derived from provider schema). - StorageBatchOperationsJobPutObjectHold
-
Typed helper for the
put_object_holdblock ofgoogle_storage_batch_operations_job(derived from provider schema). - StorageBatchOperationsJobRewriteObject
-
Typed helper for the
rewrite_objectblock ofgoogle_storage_batch_operations_job(derived from provider schema). - StorageBucketAction
-
Typed helper for the
lifecycle_rule.actionblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketAutoclass
-
Typed helper for the
autoclassblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketCondition
-
Typed helper for the
lifecycle_rule.conditionblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketCors
-
Typed helper for the
corsblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketCustomerManagedEncryptionEnforcementConfig
-
Typed helper for the
encryption.customer_managed_encryption_enforcement_configblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketCustomerSuppliedEncryptionEnforcementConfig
-
Typed helper for the
encryption.customer_supplied_encryption_enforcement_configblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketCustomPlacementConfig
-
Typed helper for the
custom_placement_configblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketEncryption
-
Typed helper for the
encryptionblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketGoogleManagedEncryptionEnforcementConfig
-
Typed helper for the
encryption.google_managed_encryption_enforcement_configblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketHierarchicalNamespace
-
Typed helper for the
hierarchical_namespaceblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_storage_bucket_iam_binding(derived from provider schema). - StorageBucketIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_storage_bucket_iam_member(derived from provider schema). - StorageBucketIpFilter
-
Typed helper for the
ip_filterblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketLifecycleRule
-
Typed helper for the
lifecycle_ruleblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketLogging
-
Typed helper for the
loggingblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketObjectBody
-
Object payload for
google_storage_bucket_object. Sealed to make thesource/contentexactly_one_ofconstraint exhaustive at the type level. - StorageBucketObjectBodyContent
-
Inline string payload. The provider marks
contentasSensitive, so the value is redacted interraform planoutput but still ends up in Terraform state — prefer StorageBucketObjectBodySource for any non-trivial data. - StorageBucketObjectBodySource
- Upload from a local filesystem path. Terraform reads the file at apply time and uploads it to GCS.
- StorageBucketObjectContexts
-
Typed helper for the
contextsblock ofgoogle_storage_bucket_object(derived from provider schema). - StorageBucketObjectCustom
-
Typed helper for the
contexts.customblock ofgoogle_storage_bucket_object(derived from provider schema). - StorageBucketObjectCustomerEncryption
-
Customer-supplied encryption (CSEK) for
customer_encryption. - StorageBucketObjectRetention
-
Object-level retention policy (
retentionblock). - StorageBucketPublicNetworkSource
-
Typed helper for the
ip_filter.public_network_sourceblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketRetentionPolicy
-
Typed helper for the
retention_policyblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketSoftDeletePolicy
-
Typed helper for the
soft_delete_policyblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketVersioning
-
Typed helper for the
versioningblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketVpcNetworkSources
-
Typed helper for the
ip_filter.vpc_network_sourcesblock ofgoogle_storage_bucket(derived from provider schema). - StorageBucketWebsite
-
Typed helper for the
websiteblock ofgoogle_storage_bucket(derived from provider schema). - StorageFtpServerConfig
-
Exactly one of
internal_config,external_configongoogle_storage_ftp_server: the provider rejects none and more than one, so each variant sets one of them. - StorageFtpServerConsumerAcceptList
-
Typed helper for the
internal_config.consumer_accept_listblock ofgoogle_storage_ftp_server(derived from provider schema). - StorageFtpServerConsumerRejectList
-
Typed helper for the
internal_config.consumer_reject_listblock ofgoogle_storage_ftp_server(derived from provider schema). - StorageFtpServerExternalConfig
-
Typed helper for the
external_configblock ofgoogle_storage_ftp_server(derived from provider schema). - StorageFtpServerExternalConfigChoice
-
The StorageFtpServerConfig.externalConfig choice: sets
external_config. - StorageFtpServerInternalConfig
-
Typed helper for the
internal_configblock ofgoogle_storage_ftp_server(derived from provider schema). - StorageFtpServerInternalConfigChoice
-
The StorageFtpServerConfig.internalConfig choice: sets
internal_config. - StorageFtpUserCredentials
-
Typed helper for the
user_credentialsblock ofgoogle_storage_ftp_user(derived from provider schema). - StorageFtpUserStorageDirectoryMappings
-
Typed helper for the
storage_directory_mappingsblock ofgoogle_storage_ftp_user(derived from provider schema). - StorageInsightsDatasetConfigCloudStorageBuckets
-
At most one of
include_cloud_storage_buckets,exclude_cloud_storage_bucketsongoogle_storage_insights_dataset_config: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - StorageInsightsDatasetConfigCloudStorageLocations
-
At most one of
include_cloud_storage_locations,exclude_cloud_storage_locationsongoogle_storage_insights_dataset_config: the provider rejects more than one, so each variant sets one of them and a null choice sets none. - StorageInsightsDatasetConfigExcludeCloudStorageBuckets
-
Typed helper for the
exclude_cloud_storage_bucketsblock ofgoogle_storage_insights_dataset_config(derived from provider schema). - StorageInsightsDatasetConfigExcludeCloudStorageBucketsChoice
-
The StorageInsightsDatasetConfigCloudStorageBuckets.excludeCloudStorageBuckets choice: sets
exclude_cloud_storage_buckets. - StorageInsightsDatasetConfigExcludeCloudStorageBucketsCloudStorageBuckets
-
Typed helper for the
exclude_cloud_storage_buckets.cloud_storage_bucketsblock ofgoogle_storage_insights_dataset_config(derived from provider schema). Shared by every block of this shape in the resource. - StorageInsightsDatasetConfigExcludeCloudStorageLocations
-
Typed helper for the
exclude_cloud_storage_locationsblock ofgoogle_storage_insights_dataset_config(derived from provider schema). - StorageInsightsDatasetConfigExcludeCloudStorageLocationsChoice
-
The StorageInsightsDatasetConfigCloudStorageLocations.excludeCloudStorageLocations choice: sets
exclude_cloud_storage_locations. - StorageInsightsDatasetConfigIdentity
-
Typed helper for the
identityblock ofgoogle_storage_insights_dataset_config(derived from provider schema). - StorageInsightsDatasetConfigIncludeCloudStorageBuckets
-
Typed helper for the
include_cloud_storage_bucketsblock ofgoogle_storage_insights_dataset_config(derived from provider schema). - StorageInsightsDatasetConfigIncludeCloudStorageBucketsChoice
-
The StorageInsightsDatasetConfigCloudStorageBuckets.includeCloudStorageBuckets choice: sets
include_cloud_storage_buckets. - StorageInsightsDatasetConfigIncludeCloudStorageLocations
-
Typed helper for the
include_cloud_storage_locationsblock ofgoogle_storage_insights_dataset_config(derived from provider schema). - StorageInsightsDatasetConfigIncludeCloudStorageLocationsChoice
-
The StorageInsightsDatasetConfigCloudStorageLocations.includeCloudStorageLocations choice: sets
include_cloud_storage_locations. - StorageInsightsDatasetConfigOrganizationScope
-
organization_scope— index the whole organization. - StorageInsightsDatasetConfigSource
-
Exactly one dataset source scope (MM
exactly_one_of:source_projects/source_folders/organization_scope). - StorageInsightsDatasetConfigSourceFolders
-
source_folders— index these folder numbers. - StorageInsightsDatasetConfigSourceProjects
-
source_projects— index these project numbers. - StorageInsightsReportConfigCsvFormat
-
csv_options— CSV inventory reports. - StorageInsightsReportConfigEndDate
-
Typed helper for the
frequency_options.end_dateblock ofgoogle_storage_insights_report_config(derived from provider schema). - StorageInsightsReportConfigFormat
-
Inventory report file format (MM
exactly_one_of:csv_options/parquet_options). - StorageInsightsReportConfigFrequencyOptions
-
Typed helper for the
frequency_optionsblock ofgoogle_storage_insights_report_config(derived from provider schema). - StorageInsightsReportConfigObjectMetadataReportOptions
-
Typed helper for the
object_metadata_report_optionsblock ofgoogle_storage_insights_report_config(derived from provider schema). - StorageInsightsReportConfigParquetFormat
-
parquet_options— Parquet inventory reports (empty options object). - StorageInsightsReportConfigStartDate
-
Typed helper for the
frequency_options.start_dateblock ofgoogle_storage_insights_report_config(derived from provider schema). - StorageInsightsReportConfigStorageDestinationOptions
-
Typed helper for the
object_metadata_report_options.storage_destination_optionsblock ofgoogle_storage_insights_report_config(derived from provider schema). - StorageInsightsReportConfigStorageFilters
-
Typed helper for the
object_metadata_report_options.storage_filtersblock ofgoogle_storage_insights_report_config(derived from provider schema). - StorageManagedFolderIamBindingCondition
-
Typed helper for the
conditionblock ofgoogle_storage_managed_folder_iam_binding(derived from provider schema). - StorageManagedFolderIamMemberCondition
-
Typed helper for the
conditionblock ofgoogle_storage_managed_folder_iam_member(derived from provider schema). - StorageTransferAgentPoolBandwidthLimit
-
Typed helper for the
bandwidth_limitblock ofgoogle_storage_transfer_agent_pool(derived from provider schema). - StorageTransferJobAwsAccessKey
-
Typed helper for the
transfer_spec.aws_s3_data_source.aws_access_keyblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobAwsS3CompatibleDataSource
-
Typed helper for the
transfer_spec.aws_s3_compatible_data_sourceblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobAwsS3DataSource
-
Typed helper for the
transfer_spec.aws_s3_data_sourceblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobAzureBlobStorageDataSource
-
Typed helper for the
transfer_spec.azure_blob_storage_data_sourceblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobAzureCredentials
-
Typed helper for the
transfer_spec.azure_blob_storage_data_source.azure_credentialsblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobEventStream
-
Typed helper for the
event_streamblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobFederatedIdentityConfig
-
Typed helper for the
transfer_spec.azure_blob_storage_data_source.federated_identity_configblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobGcsDataSink
-
Typed helper for the
replication_spec.gcs_data_sinkblock ofgoogle_storage_transfer_job(derived from provider schema). Shared by every block of this shape in the resource. - StorageTransferJobGcsDataSource
-
Typed helper for the
replication_spec.gcs_data_sourceblock ofgoogle_storage_transfer_job(derived from provider schema). Shared by every block of this shape in the resource. - StorageTransferJobHdfsDataSource
-
Typed helper for the
transfer_spec.hdfs_data_sourceblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobHttpDataSource
-
Typed helper for the
transfer_spec.http_data_sourceblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobLoggingConfig
-
Typed helper for the
logging_configblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobMetadataOptions
-
Typed helper for the
replication_spec.transfer_options.metadata_optionsblock ofgoogle_storage_transfer_job(derived from provider schema). Shared by every block of this shape in the resource. - StorageTransferJobNotificationConfig
-
Typed helper for the
notification_configblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobObjectConditions
-
Typed helper for the
replication_spec.object_conditionsblock ofgoogle_storage_transfer_job(derived from provider schema). Shared by every block of this shape in the resource. - StorageTransferJobPosixDataSink
-
Typed helper for the
transfer_spec.posix_data_sinkblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobPosixDataSource
-
Typed helper for the
transfer_spec.posix_data_sourceblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobReplicationSpec
-
Typed helper for the
replication_specblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobS3Metadata
-
Typed helper for the
transfer_spec.aws_s3_compatible_data_source.s3_metadatablock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobSchedule
-
Typed helper for the
scheduleblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobScheduleEndDate
-
Typed helper for the
schedule.schedule_end_dateblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobScheduleStartDate
-
Typed helper for the
schedule.schedule_start_dateblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobStartTimeOfDay
-
Typed helper for the
schedule.start_time_of_dayblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobTransferManifest
-
Typed helper for the
transfer_spec.transfer_manifestblock ofgoogle_storage_transfer_job(derived from provider schema). - StorageTransferJobTransferOptions
-
Typed helper for the
replication_spec.transfer_optionsblock ofgoogle_storage_transfer_job(derived from provider schema). Shared by every block of this shape in the resource. - StorageTransferJobTransferSpec
-
Typed helper for the
transfer_specblock ofgoogle_storage_transfer_job(derived from provider schema). - 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(...)ormap(...). - 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 withStack.addOutput. - TfPrimitiveType
-
string,number,boolorany. -
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.variableorvar.<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.refwhose 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
resourceblock or adatablock in Terraform JSON.
Extension Types
- BucketObjectStorageClass
-
Storage class for
google_storage_bucket_object.storage_class. - BucketStorageClass
-
Storage class for
google_storage_bucket.storage_class. - LifecycleActionType
-
Action type for
lifecycle_rule.action.type. - OutputEnvironment
-
The environment
Stack.outputEnvironmentreturns: 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, ...). - StorageAnywhereCacheAdmissionPolicy
-
Terraform
admission_policyfor GoogleStorageAnywhereCache. - StorageBucketAccessControlRole
-
Storage Bucket Access Control enum for
role. - StorageDefaultObjectAccessControlRole
-
Storage Default Object Access Control enum for
role. - StorageFtpServerAccessType
-
Storage Ftp Server Access enum for
access_type. - StorageFtpUserPermission
-
permission— derived from the provider schema description. - StorageHmacKeyState
-
Storage Hmac Key enum for
state. - StorageInsightsDatasetConfigState
-
Storage Insights Dataset Config enum for
dataset_config_state. - StorageInsightsDatasetConfigType
-
type— derived from the provider schema description. - StorageInsightsReportConfigFrequency
-
frequency— derived from the provider schema description. - StorageNotificationEventType
-
One entry in
event_types[]. Selects which object-mutation events the notification subscribes to. Omitting the list entirely (or passing all four values) subscribes to every event type. - StorageNotificationPayloadFormat
-
payload_format. Picks the body the Pub/Sub message carries for each event. - StorageObjectAccessControlRole
-
Storage Object Access Control enum for
role. - StorageTransferAgentPoolState
-
Storage Transfer Agent Pool enum for
state.
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
terradartcommand 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
envand 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.
Exceptions / Errors
- DuplicateModuleError
-
A
ModuleCallregistered twice under one name. - DuplicateResourceError
-
Thrown by
Stack.addwhen an entry with the same(kind, terraformType, localName)triple is registered twice. - SynthException
-
Thrown by
Stack.synth()andStack.writeTo()when the Stack has one or more SynthIssues. Nothing is written.