backup_dr library

Backup and DR Service — vaults, plans, associations, management server, service config, and restore workloads.

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.
BackupDrBackupPlanBackupRules
Typed helper for the backup_rules block of google_backup_dr_backup_plan (derived from provider schema).
BackupDrBackupPlanBackupWindow
Typed helper for the backup_rules.standard_schedule.backup_window block of google_backup_dr_backup_plan (derived from provider schema).
BackupDrBackupPlanComputeInstanceBackupPlanProperties
Typed helper for the compute_instance_backup_plan_properties block of google_backup_dr_backup_plan (derived from provider schema).
BackupDrBackupPlanDiskBackupPlanProperties
Typed helper for the disk_backup_plan_properties block of google_backup_dr_backup_plan (derived from provider schema).
BackupDrBackupPlanStandardSchedule
Typed helper for the backup_rules.standard_schedule block of google_backup_dr_backup_plan (derived from provider schema).
BackupDrBackupPlanWeekDayOfMonth
Typed helper for the backup_rules.standard_schedule.week_day_of_month block of google_backup_dr_backup_plan (derived from provider schema).
BackupDrBackupVaultEncryptionConfig
Typed helper for the encryption_config block of google_backup_dr_backup_vault (derived from provider schema).
BackupDrManagementServerNetworks
Typed helper for the networks block of google_backup_dr_management_server (derived from provider schema).
BackupDrRestoreWorkloadAccessConfigs
Typed helper for the compute_instance_restore_properties.network_interfaces.access_configs block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadAdvancedMachineFeatures
Typed helper for the compute_instance_restore_properties.advanced_machine_features block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadAliasIpRanges
Typed helper for the compute_instance_restore_properties.network_interfaces.alias_ip_ranges block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadAllocationAffinity
Typed helper for the compute_instance_restore_properties.allocation_affinity block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadComputeInstanceRestoreProperties
Typed helper for the compute_instance_restore_properties block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadComputeInstanceTargetEnvironment
Typed helper for the compute_instance_target_environment block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadConfidentialInstanceConfig
Typed helper for the compute_instance_restore_properties.confidential_instance_config block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadDiskEncryptionKey
Typed helper for the disk_restore_properties.disk_encryption_key block of google_backup_dr_restore_workload (derived from provider schema). Shared by every block of this shape in the resource.
BackupDrRestoreWorkloadDiskRestoreProperties
Typed helper for the disk_restore_properties block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadDisks
Typed helper for the compute_instance_restore_properties.disks block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadDiskTargetEnvironment
Typed helper for the disk_target_environment block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadDisplayDevice
Typed helper for the compute_instance_restore_properties.display_device block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadGuestAccelerators
Typed helper for the compute_instance_restore_properties.guest_accelerators block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadGuestOsFeature
Typed helper for the disk_restore_properties.guest_os_feature block of google_backup_dr_restore_workload (derived from provider schema). Shared by every block of this shape in the resource.
BackupDrRestoreWorkloadInitializeParams
Typed helper for the compute_instance_restore_properties.disks.initialize_params block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadInstanceEncryptionKey
Typed helper for the compute_instance_restore_properties.instance_encryption_key block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadIpv6AccessConfigs
Typed helper for the compute_instance_restore_properties.network_interfaces.ipv6_access_configs block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadItems
Typed helper for the compute_instance_restore_properties.metadata.items block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadLabels
Typed helper for the compute_instance_restore_properties.labels block of google_backup_dr_restore_workload (derived from provider schema). Shared by every block of this shape in the resource.
BackupDrRestoreWorkloadLocalSsdRecoveryTimeout
Typed helper for the compute_instance_restore_properties.scheduling.local_ssd_recovery_timeout block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadMaxRunDuration
Typed helper for the compute_instance_restore_properties.scheduling.max_run_duration block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadMetadata
Typed helper for the compute_instance_restore_properties.metadata block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadNetworkInterfaces
Typed helper for the compute_instance_restore_properties.network_interfaces block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadNetworkPerformanceConfig
Typed helper for the compute_instance_restore_properties.network_performance_config block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadNodeAffinities
Typed helper for the compute_instance_restore_properties.scheduling.node_affinities block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadParams
Typed helper for the compute_instance_restore_properties.params block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadRegionDiskTargetEnvironment
Typed helper for the region_disk_target_environment block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadResourceManagerTags
Typed helper for the disk_restore_properties.resource_manager_tags block of google_backup_dr_restore_workload (derived from provider schema). Shared by every block of this shape in the resource.
BackupDrRestoreWorkloadScheduling
Typed helper for the compute_instance_restore_properties.scheduling block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadServiceAccounts
Typed helper for the compute_instance_restore_properties.service_accounts block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadShieldedInstanceConfig
Typed helper for the compute_instance_restore_properties.shielded_instance_config block of google_backup_dr_restore_workload (derived from provider schema).
BackupDrRestoreWorkloadTags
Typed helper for the compute_instance_restore_properties.tags block of google_backup_dr_restore_workload (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.
DataGoogleBackupDrBackup
Factory wrapper for google_backup_dr_backup.
DataGoogleBackupDrBackupPlan
Factory wrapper for google_backup_dr_backup_plan.
DataGoogleBackupDrBackupPlanAssociation
Factory wrapper for google_backup_dr_backup_plan_association.
DataGoogleBackupDrBackupPlanAssociations
Factory wrapper for google_backup_dr_backup_plan_associations.
DataGoogleBackupDrBackupVault
Factory wrapper for google_backup_dr_backup_vault.
DataGoogleBackupDrDataSource
Factory wrapper for google_backup_dr_data_source.
DataGoogleBackupDrDataSourceReference
Factory wrapper for google_backup_dr_data_source_reference.
DataGoogleBackupDrDataSourceReferences
Factory wrapper for google_backup_dr_data_source_references.
DataGoogleBackupDrDataSources
Factory wrapper for google_backup_dr_data_sources.
DataGoogleBackupDrManagementServer
Factory wrapper for google_backup_dr_management_server.
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.
GoogleBackupDrBackupPlan
Factory wrapper for google_backup_dr_backup_plan.
GoogleBackupDrBackupPlanAssociation
Factory wrapper for google_backup_dr_backup_plan_association.
GoogleBackupDrBackupVault
Factory wrapper for google_backup_dr_backup_vault.
GoogleBackupDrManagementServer
Factory wrapper for google_backup_dr_management_server.
GoogleBackupDrRestoreWorkload
Factory wrapper for google_backup_dr_restore_workload.
GoogleBackupDrServiceConfig
Factory wrapper for google_backup_dr_service_config.
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

BackupDrBackupPlanDayOfWeek
day_of_week — derived from the provider schema description.
BackupDrBackupPlanDaysOfWeek
days_of_week — derived from the provider schema description.
BackupDrBackupPlanMonths
months — derived from the provider schema description.
BackupDrBackupPlanRecurrenceType
recurrence_type — derived from the provider schema description.
BackupDrBackupPlanWeekOfMonth
week_of_month — derived from the provider schema description.
BackupDrBackupVaultAccessRestriction
Backup Dr Backup Vault Access enum for access_restriction.
BackupDrBackupVaultBackupRetentionInheritance
Backup Dr Backup Vault Backup Retention enum for backup_retention_inheritance.
BackupDrManagementServerType
Backup Dr Management Server enum for type.
BackupDrRestoreWorkloadAccessConfigsType
type — derived from the provider schema description.
BackupDrRestoreWorkloadAccessMode
access_mode — derived from the provider schema description.
BackupDrRestoreWorkloadArchitecture
architecture — derived from the provider schema description.
BackupDrRestoreWorkloadConsumeAllocationType
consume_allocation_type — derived from the provider schema description.
BackupDrRestoreWorkloadDiskInterface
disk_interface — derived from the provider schema description.
BackupDrRestoreWorkloadDisksType
type — derived from the provider schema description.
BackupDrRestoreWorkloadGuestOsFeatureType
type — derived from the provider schema description.
BackupDrRestoreWorkloadInstanceTerminationAction
instance_termination_action — derived from the provider schema description.
BackupDrRestoreWorkloadIpv6AccessType
ipv6_access_type — derived from the provider schema description.
BackupDrRestoreWorkloadKeyRevocationActionType
key_revocation_action_type — derived from the provider schema description.
BackupDrRestoreWorkloadMode
mode — derived from the provider schema description.
BackupDrRestoreWorkloadNetworkTier
network_tier — derived from the provider schema description.
BackupDrRestoreWorkloadNicType
nic_type — derived from the provider schema description.
BackupDrRestoreWorkloadOnHostMaintenance
on_host_maintenance — derived from the provider schema description.
BackupDrRestoreWorkloadOperator
operator — derived from the provider schema description.
BackupDrRestoreWorkloadPrivateIpv6GoogleAccess
private_ipv6_google_access — derived from the provider schema description.
BackupDrRestoreWorkloadProvisioningModel
provisioning_model — derived from the provider schema description.
BackupDrRestoreWorkloadSavedState
saved_state — derived from the provider schema description.
BackupDrRestoreWorkloadStackType
stack_type — derived from the provider schema description.
BackupDrRestoreWorkloadTotalEgressBandwidthTier
total_egress_bandwidth_tier — 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.

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.