dynamodb library

AWS DynamoDB.

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.
AwsDynamodbContributorInsights
Factory wrapper for aws_dynamodb_contributor_insights.
AwsDynamodbGlobalSecondaryIndex
Factory wrapper for aws_dynamodb_global_secondary_index.
AwsDynamodbGlobalTable
Factory wrapper for aws_dynamodb_global_table.
AwsDynamodbKinesisStreamingDestination
Factory wrapper for aws_dynamodb_kinesis_streaming_destination.
AwsDynamodbResourcePolicy
Factory wrapper for aws_dynamodb_resource_policy.
AwsDynamodbTable
Factory wrapper for aws_dynamodb_table.
AwsDynamodbTableExport
Factory wrapper for aws_dynamodb_table_export.
AwsDynamodbTableItem
Factory wrapper for aws_dynamodb_table_item.
AwsDynamodbTableReplica
Factory wrapper for aws_dynamodb_table_replica.
AwsDynamodbTag
Factory wrapper for aws_dynamodb_tag.
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.
DataAwsDynamodbBackups
Factory wrapper for aws_dynamodb_backups.
DataAwsDynamodbTable
Factory wrapper for aws_dynamodb_table.
DataAwsDynamodbTableItem
Factory wrapper for aws_dynamodb_table_item.
DataAwsDynamodbTables
Factory wrapper for aws_dynamodb_tables.
DataDynamodbTableServerSideEncryption
Typed helper for the server_side_encryption block of aws_dynamodb_table (derived from provider schema).
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
DynamodbGlobalSecondaryIndexKeySchema
Typed helper for the key_schema block of aws_dynamodb_global_secondary_index (derived from provider schema).
DynamodbGlobalSecondaryIndexOnDemandThroughput
Typed helper for the on_demand_throughput block of aws_dynamodb_global_secondary_index (derived from provider schema).
DynamodbGlobalSecondaryIndexProjection
Typed helper for the projection block of aws_dynamodb_global_secondary_index (derived from provider schema).
DynamodbGlobalSecondaryIndexProvisionedThroughput
Typed helper for the provisioned_throughput block of aws_dynamodb_global_secondary_index (derived from provider schema).
DynamodbGlobalTableReplica
Typed helper for the replica block of aws_dynamodb_global_table (derived from provider schema).
DynamodbTableAttribute
Typed helper for the attribute block of aws_dynamodb_table (derived from provider schema).
DynamodbTableCsv
Typed helper for the import_table.input_format_options.csv block of aws_dynamodb_table (derived from provider schema).
DynamodbTableExportIncrementalExportSpecification
Typed helper for the incremental_export_specification block of aws_dynamodb_table_export (derived from provider schema).
DynamodbTableGlobalSecondaryIndex
Typed helper for the global_secondary_index block of aws_dynamodb_table (derived from provider schema).
DynamodbTableGlobalTableWitness
Typed helper for the global_table_witness block of aws_dynamodb_table (derived from provider schema).
DynamodbTableImportTable
Typed helper for the import_table block of aws_dynamodb_table (derived from provider schema).
DynamodbTableInputFormatOptions
Typed helper for the import_table.input_format_options block of aws_dynamodb_table (derived from provider schema).
DynamodbTableKeySchema
Typed helper for the global_secondary_index.key_schema block of aws_dynamodb_table (derived from provider schema).
DynamodbTableLocalSecondaryIndex
Typed helper for the local_secondary_index block of aws_dynamodb_table (derived from provider schema).
DynamodbTableOnDemandThroughput
Typed helper for the on_demand_throughput block of aws_dynamodb_table (derived from provider schema). Shared by every block of this shape in the resource.
DynamodbTablePointInTimeRecovery
Typed helper for the point_in_time_recovery block of aws_dynamodb_table (derived from provider schema).
DynamodbTableReplica
Typed helper for the replica block of aws_dynamodb_table (derived from provider schema).
DynamodbTableS3BucketSource
Typed helper for the import_table.s3_bucket_source block of aws_dynamodb_table (derived from provider schema).
DynamodbTableServerSideEncryption
Typed helper for the server_side_encryption block of aws_dynamodb_table (derived from provider schema).
DynamodbTableSource
At most one of import_table, restore_backup_arn, restore_source_name, restore_source_table_arn on aws_dynamodb_table: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DynamodbTableSourceImportTable
The DynamodbTableSource.importTable choice: sets import_table.
DynamodbTableSourceRestoreBackupArn
The DynamodbTableSource.restoreBackupArn choice: sets restore_backup_arn.
DynamodbTableSourceRestoreSourceName
The DynamodbTableSource.restoreSourceName choice: sets restore_source_name.
DynamodbTableSourceRestoreSourceTableArn
The DynamodbTableSource.restoreSourceTableArn choice: sets restore_source_table_arn.
DynamodbTableTtl
Typed helper for the ttl block of aws_dynamodb_table (derived from provider schema).
DynamodbTableWarmThroughput
Typed helper for the warm_throughput block of aws_dynamodb_table (derived from provider schema). Shared by every block of this shape in the resource.
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, 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

DynamodbContributorInsightsMode
Dynamodb Contributor Insights enum for mode.
DynamodbGlobalSecondaryIndexAttributeType
attribute_type — derived from the provider schema description.
DynamodbGlobalSecondaryIndexKeyType
key_type — derived from the provider schema description.
DynamodbGlobalSecondaryIndexProjectionType
projection_type — derived from the provider schema description.
DynamodbKinesisStreamingDestinationApproximateCreationDateTimePrecision
Dynamodb Kinesis Streaming Destination Approximate Creation Date Time enum for approximate_creation_date_time_precision.
DynamodbTableBillingMode
Dynamodb Table Billing enum for billing_mode.
DynamodbTableClass
Dynamodb Table enum for table_class.
DynamodbTableConsistencyMode
consistency_mode — derived from the provider schema description.
DynamodbTableExportFormat
Dynamodb Table Export enum for export_format.
DynamodbTableExportS3SseAlgorithm
Dynamodb Table Export S3 Sse enum for s3_sse_algorithm.
DynamodbTableExportType
Dynamodb Table Export enum for export_type.
DynamodbTableExportViewType
export_view_type — derived from the provider schema description.
DynamodbTableInputCompressionType
input_compression_type — derived from the provider schema description.
DynamodbTableInputFormat
input_format — derived from the provider schema description.
DynamodbTableKeyType
key_type — derived from the provider schema description.
DynamodbTableProjectionType
projection_type — derived from the provider schema description.
DynamodbTableReplicaTableClassOverride
Dynamodb Table Replica Table Class enum for table_class_override.
DynamodbTableStreamViewType
Dynamodb Table Stream View enum for stream_view_type.
DynamodbTableType
type — 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").

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.