backup library
AWS Backup.
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. - AwsBackupFramework
-
Factory wrapper for
aws_backup_framework. - AwsBackupGlobalSettings
-
Factory wrapper for
aws_backup_global_settings. - AwsBackupLogicallyAirGappedVault
-
Factory wrapper for
aws_backup_logically_air_gapped_vault. - AwsBackupPlan
-
Factory wrapper for
aws_backup_plan. - AwsBackupRegionSettings
-
Factory wrapper for
aws_backup_region_settings. - AwsBackupReportPlan
-
Factory wrapper for
aws_backup_report_plan. - AwsBackupRestoreTestingPlan
-
Factory wrapper for
aws_backup_restore_testing_plan. - AwsBackupRestoreTestingSelection
-
Factory wrapper for
aws_backup_restore_testing_selection. - AwsBackupSelection
-
Factory wrapper for
aws_backup_selection. - AwsBackupVault
-
Factory wrapper for
aws_backup_vault. - AwsBackupVaultLockConfiguration
-
Factory wrapper for
aws_backup_vault_lock_configuration. - AwsBackupVaultNotifications
-
Factory wrapper for
aws_backup_vault_notifications. - AwsBackupVaultPolicy
-
Factory wrapper for
aws_backup_vault_policy. - BackupFrameworkControl
-
Typed helper for the
controlblock ofaws_backup_framework(derived from provider schema). - BackupFrameworkInputParameter
-
Typed helper for the
control.input_parameterblock ofaws_backup_framework(derived from provider schema). - BackupFrameworkScope
-
Typed helper for the
control.scopeblock ofaws_backup_framework(derived from provider schema). - BackupPlanAdvancedBackupSetting
-
Typed helper for the
advanced_backup_settingblock ofaws_backup_plan(derived from provider schema). - BackupPlanCopyAction
-
Typed helper for the
rule.copy_actionblock ofaws_backup_plan(derived from provider schema). - BackupPlanLifecycle
-
Typed helper for the
rule.lifecycleblock ofaws_backup_plan(derived from provider schema). Shared by every block of this shape in the resource. - BackupPlanRule
-
Typed helper for the
ruleblock ofaws_backup_plan(derived from provider schema). - BackupPlanScanAction
-
Typed helper for the
rule.scan_actionblock ofaws_backup_plan(derived from provider schema). - BackupPlanScanSetting
-
Typed helper for the
scan_settingblock ofaws_backup_plan(derived from provider schema). - BackupReportPlanReportDeliveryChannel
-
Typed helper for the
report_delivery_channelblock ofaws_backup_report_plan(derived from provider schema). - BackupReportPlanReportSetting
-
Typed helper for the
report_settingblock ofaws_backup_report_plan(derived from provider schema). - BackupRestoreTestingPlanRecoveryPointSelection
-
Typed helper for the
recovery_point_selectionblock ofaws_backup_restore_testing_plan(derived from provider schema). - BackupRestoreTestingSelectionProtectedResource
-
Exactly one of
protected_resource_arns,protected_resource_conditionsonaws_backup_restore_testing_selection: the provider rejects none and more than one, so each variant sets one of them. - BackupRestoreTestingSelectionProtectedResourceArns
-
The BackupRestoreTestingSelectionProtectedResource.protectedResourceArns choice: sets
protected_resource_arns. - BackupRestoreTestingSelectionProtectedResourceConditions
-
Typed helper for the
protected_resource_conditionsblock ofaws_backup_restore_testing_selection(derived from provider schema). - BackupRestoreTestingSelectionProtectedResourceConditionsChoice
-
The BackupRestoreTestingSelectionProtectedResource.protectedResourceConditions choice: sets
protected_resource_conditions. - BackupRestoreTestingSelectionStringEquals
-
Typed helper for the
protected_resource_conditions.string_equalsblock ofaws_backup_restore_testing_selection(derived from provider schema). - BackupRestoreTestingSelectionStringNotEquals
-
Typed helper for the
protected_resource_conditions.string_not_equalsblock ofaws_backup_restore_testing_selection(derived from provider schema). - BackupSelectionCondition
-
Typed helper for the
conditionblock ofaws_backup_selection(derived from provider schema). - BackupSelectionStringEquals
-
Typed helper for the
condition.string_equalsblock ofaws_backup_selection(derived from provider schema). - BackupSelectionStringLike
-
Typed helper for the
condition.string_likeblock ofaws_backup_selection(derived from provider schema). - BackupSelectionStringNotEquals
-
Typed helper for the
condition.string_not_equalsblock ofaws_backup_selection(derived from provider schema). - BackupSelectionStringNotLike
-
Typed helper for the
condition.string_not_likeblock ofaws_backup_selection(derived from provider schema). - BackupSelectionTag
-
Typed helper for the
selection_tagblock ofaws_backup_selection(derived from provider schema). - DartDefineOutput
-
An
outputwhose value is the client build's--dart-definefile, registered withStack.addDartDefineOutput. - Data
-
Base of every user-instantiable Terraform
datablock. - DataAwsBackupFramework
-
Factory wrapper for
aws_backup_framework. - DataAwsBackupPlan
-
Factory wrapper for
aws_backup_plan. - DataAwsBackupReportPlan
-
Factory wrapper for
aws_backup_report_plan. - DataAwsBackupSelection
-
Factory wrapper for
aws_backup_selection. - DataAwsBackupVault
-
Factory wrapper for
aws_backup_vault. -
DataRef<
T> -
Public for sealed pattern matching, but constructor is private — only
TfRef.data()may construct instances. - EnvironmentConstant
- The AppConstant.fromEnvironment choice.
- GcsBackend
-
terraform { backend "gcs" { ... } }configuration. - IgnoreAllChanges
- IgnoreChanges.all.
- IgnoreAttributes
- IgnoreChanges.of.
- IgnoreChanges
-
What
ignore_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. - 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
- BackupPlanMalwareScanner
-
malware_scanner— derived from the provider schema description. - BackupPlanResourceType
-
resource_type— derived from the provider schema description. - BackupPlanScanMode
-
scan_mode— derived from the provider schema description. - BackupReportPlanFormats
-
formats— derived from the provider schema description. - BackupReportPlanReportTemplate
-
report_template— derived from the provider schema description. - BackupRestoreTestingPlanAlgorithm
-
algorithm— derived from the provider schema description. - BackupRestoreTestingPlanRecoveryPointTypes
-
recovery_point_types— derived from the provider schema description. - BackupSelectionType
-
type— derived from the provider schema description. - BackupVaultNotificationsBackupVaultEvents
-
Backup Vault Notifications Backup Vault enum for
backup_vault_events. - 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, ...).
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
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.