docdb library

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.
AwsDocdbCluster: Factory wrapper for aws_docdb_cluster.
AwsDocdbClusterInstance: Factory wrapper for aws_docdb_cluster_instance.
AwsDocdbClusterParameterGroup: Factory wrapper for aws_docdb_cluster_parameter_group.
AwsDocdbClusterSnapshot: Factory wrapper for aws_docdb_cluster_snapshot.
AwsDocdbEventSubscription: Factory wrapper for aws_docdb_event_subscription.
AwsDocdbGlobalCluster: Factory wrapper for aws_docdb_global_cluster.
AwsDocdbSubnetGroup: Factory wrapper for aws_docdb_subnet_group.
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.
DataAwsDocdbEngineVersion: Factory wrapper for aws_docdb_engine_version.
DataAwsDocdbOrderableDbInstance: Factory wrapper for aws_docdb_orderable_db_instance.
DataRef<T>: Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
DocdbClusterIdentifier: At most one of cluster_identifier, cluster_identifier_prefix on aws_docdb_cluster: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DocdbClusterIdentifierChoice: The DocdbClusterIdentifier.clusterIdentifier choice: sets cluster_identifier.
DocdbClusterIdentifierPrefix: The DocdbClusterIdentifier.clusterIdentifierPrefix choice: sets cluster_identifier_prefix.
DocdbClusterInstanceIdentifier: At most one of identifier, identifier_prefix on aws_docdb_cluster_instance: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DocdbClusterInstanceIdentifierChoice: The DocdbClusterInstanceIdentifier.identifier choice: sets identifier.
DocdbClusterInstanceIdentifierPrefix: The DocdbClusterInstanceIdentifier.identifierPrefix choice: sets identifier_prefix.
DocdbClusterMasterPassword: At most one of manage_master_user_password, master_password, master_password_wo on aws_docdb_cluster: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DocdbClusterMasterPasswordChoice: The DocdbClusterMasterPassword.masterPassword choice: sets master_password.
DocdbClusterMasterPasswordManageMasterUserPassword: The DocdbClusterMasterPassword.manageMasterUserPassword choice: sets manage_master_user_password.
DocdbClusterMasterPasswordWo: The DocdbClusterMasterPassword.masterPasswordWo choice: sets master_password_wo.
DocdbClusterParameterGroupName: At most one of name, name_prefix on aws_docdb_cluster_parameter_group: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DocdbClusterParameterGroupNameChoice: The DocdbClusterParameterGroupName.name choice: sets name.
DocdbClusterParameterGroupNamePrefix: The DocdbClusterParameterGroupName.namePrefix choice: sets name_prefix.
DocdbClusterParameterGroupParameter: Typed helper for the parameter block of aws_docdb_cluster_parameter_group (derived from provider schema).
DocdbClusterRestoreSource: At most one of restore_to_point_in_time, snapshot_identifier on aws_docdb_cluster: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DocdbClusterRestoreSourceRestoreToPointInTime: The DocdbClusterRestoreSource.restoreToPointInTime choice: sets restore_to_point_in_time.
DocdbClusterRestoreSourceSnapshotIdentifier: The DocdbClusterRestoreSource.snapshotIdentifier choice: sets snapshot_identifier.
DocdbClusterRestoreToPointInTime: Typed helper for the restore_to_point_in_time block of aws_docdb_cluster (derived from provider schema).
DocdbClusterServerlessV2ScalingConfiguration: Typed helper for the serverless_v2_scaling_configuration block of aws_docdb_cluster (derived from provider schema).
DocdbClusterTarget: At most one of restore_to_time, use_latest_restorable_time on the restore_to_point_in_time block of aws_docdb_cluster: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DocdbClusterTargetRestoreToTime: The DocdbClusterTarget.restoreToTime choice: sets restore_to_time.
DocdbClusterTargetUseLatestRestorableTime: The DocdbClusterTarget.useLatestRestorableTime choice: sets use_latest_restorable_time.
DocdbEventSubscriptionName: At most one of name, name_prefix on aws_docdb_event_subscription: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DocdbEventSubscriptionNameChoice: The DocdbEventSubscriptionName.name choice: sets name.
DocdbEventSubscriptionNamePrefix: The DocdbEventSubscriptionName.namePrefix choice: sets name_prefix.
DocdbGlobalClusterSource: Exactly one of engine, source_db_cluster_identifier on aws_docdb_global_cluster: the provider rejects none and more than one, so each variant sets one of them.
DocdbGlobalClusterSourceDbClusterIdentifier: The DocdbGlobalClusterSource.sourceDbClusterIdentifier choice: sets source_db_cluster_identifier.
DocdbGlobalClusterSourceEngine: The DocdbGlobalClusterSource.engine choice: sets engine.
DocdbSubnetGroupName: At most one of name, name_prefix on aws_docdb_subnet_group: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
DocdbSubnetGroupNameChoice: The DocdbSubnetGroupName.name choice: sets name.
DocdbSubnetGroupNamePrefix: The DocdbSubnetGroupName.namePrefix choice: sets name_prefix.
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

DocdbClusterEnabledCloudwatchLogsExports: Docdb Cluster Enabled Cloudwatch Logs enum for enabled_cloudwatch_logs_exports.
DocdbClusterEngine: Docdb Cluster enum for engine.
DocdbClusterInstanceEngine: Docdb Cluster Instance enum for engine.
DocdbClusterNetworkType: Docdb Cluster Network enum for network_type.
DocdbClusterParameterGroupApplyMethod: apply_method — derived from the provider schema description.
DocdbClusterRestoreType: restore_type — derived from the provider schema description.
DocdbClusterStorageType: Docdb Cluster Storage enum for storage_type.
DocdbGlobalClusterEngine: Docdb Global Cluster enum for engine.
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.

Classes

Enums

Extension Types

Extensions

Exceptions / Errors

terradart_aws package

docdb library