cosmosdb library

Azure Resource Manager cosmosdb resources.

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.
AzurermBackend
terraform { backend "azurerm" { ... } } configuration.
AzurermCosmosdbAccount
Factory wrapper for azurerm_cosmosdb_account.
AzurermCosmosdbCassandraCluster
Factory wrapper for azurerm_cosmosdb_cassandra_cluster.
AzurermCosmosdbCassandraDatacenter
Factory wrapper for azurerm_cosmosdb_cassandra_datacenter.
AzurermCosmosdbCassandraKeyspace
Factory wrapper for azurerm_cosmosdb_cassandra_keyspace.
AzurermCosmosdbCassandraTable
Factory wrapper for azurerm_cosmosdb_cassandra_table.
AzurermCosmosdbGremlinDatabase
Factory wrapper for azurerm_cosmosdb_gremlin_database.
AzurermCosmosdbGremlinGraph
Factory wrapper for azurerm_cosmosdb_gremlin_graph.
AzurermCosmosdbMongoCollection
Factory wrapper for azurerm_cosmosdb_mongo_collection.
AzurermCosmosdbMongoDatabase
Factory wrapper for azurerm_cosmosdb_mongo_database.
AzurermCosmosdbMongoRoleDefinition
Factory wrapper for azurerm_cosmosdb_mongo_role_definition.
AzurermCosmosdbMongoUserDefinition
Factory wrapper for azurerm_cosmosdb_mongo_user_definition.
AzurermCosmosdbPostgresqlCluster
Factory wrapper for azurerm_cosmosdb_postgresql_cluster.
AzurermCosmosdbPostgresqlCoordinatorConfiguration
Factory wrapper for azurerm_cosmosdb_postgresql_coordinator_configuration.
AzurermCosmosdbPostgresqlFirewallRule
Factory wrapper for azurerm_cosmosdb_postgresql_firewall_rule.
AzurermCosmosdbPostgresqlNodeConfiguration
Factory wrapper for azurerm_cosmosdb_postgresql_node_configuration.
AzurermCosmosdbPostgresqlRole
Factory wrapper for azurerm_cosmosdb_postgresql_role.
AzurermCosmosdbSqlContainer
Factory wrapper for azurerm_cosmosdb_sql_container.
AzurermCosmosdbSqlDatabase
Factory wrapper for azurerm_cosmosdb_sql_database.
AzurermCosmosdbSqlDedicatedGateway
Factory wrapper for azurerm_cosmosdb_sql_dedicated_gateway.
AzurermCosmosdbSqlFunction
Factory wrapper for azurerm_cosmosdb_sql_function.
AzurermCosmosdbSqlRoleAssignment
Factory wrapper for azurerm_cosmosdb_sql_role_assignment.
AzurermCosmosdbSqlRoleDefinition
Factory wrapper for azurerm_cosmosdb_sql_role_definition.
AzurermCosmosdbSqlStoredProcedure
Factory wrapper for azurerm_cosmosdb_sql_stored_procedure.
AzurermCosmosdbSqlTrigger
Factory wrapper for azurerm_cosmosdb_sql_trigger.
AzurermCosmosdbTable
Factory wrapper for azurerm_cosmosdb_table.
CosmosdbAccountAnalyticalStorage
Typed helper for the analytical_storage block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountBackup
Typed helper for the backup block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountCapabilities
Typed helper for the capabilities block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountCapacity
Typed helper for the capacity block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountConsistencyPolicy
Typed helper for the consistency_policy block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountCorsRule
Typed helper for the cors_rule block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountDatabase
Typed helper for the restore.database block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountGeoLocation
Typed helper for the geo_location block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountGremlinDatabase
Typed helper for the restore.gremlin_database block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountIdentity
Typed helper for the identity block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountRestore
Typed helper for the restore block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbAccountVirtualNetworkRule
Typed helper for the virtual_network_rule block of azurerm_cosmosdb_account (derived from provider schema).
CosmosdbCassandraClusterIdentity
Typed helper for the identity block of azurerm_cosmosdb_cassandra_cluster (derived from provider schema).
CosmosdbCassandraKeyspaceAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_cassandra_keyspace (derived from provider schema).
CosmosdbCassandraTableAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_cassandra_table (derived from provider schema).
CosmosdbCassandraTableClusterKey
Typed helper for the schema.cluster_key block of azurerm_cosmosdb_cassandra_table (derived from provider schema).
CosmosdbCassandraTableColumn
Typed helper for the schema.column block of azurerm_cosmosdb_cassandra_table (derived from provider schema).
CosmosdbCassandraTablePartitionKey
Typed helper for the schema.partition_key block of azurerm_cosmosdb_cassandra_table (derived from provider schema).
CosmosdbCassandraTableSchema
Typed helper for the schema block of azurerm_cosmosdb_cassandra_table (derived from provider schema).
CosmosdbGremlinDatabaseAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_gremlin_database (derived from provider schema).
CosmosdbGremlinGraphAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_gremlin_graph (derived from provider schema).
CosmosdbGremlinGraphCompositeIndex
Typed helper for the index_policy.composite_index block of azurerm_cosmosdb_gremlin_graph (derived from provider schema).
CosmosdbGremlinGraphConflictResolutionPolicy
Typed helper for the conflict_resolution_policy block of azurerm_cosmosdb_gremlin_graph (derived from provider schema).
CosmosdbGremlinGraphIndex
Typed helper for the index_policy.composite_index.index block of azurerm_cosmosdb_gremlin_graph (derived from provider schema).
CosmosdbGremlinGraphIndexPolicy
Typed helper for the index_policy block of azurerm_cosmosdb_gremlin_graph (derived from provider schema).
CosmosdbGremlinGraphSpatialIndex
Typed helper for the index_policy.spatial_index block of azurerm_cosmosdb_gremlin_graph (derived from provider schema).
CosmosdbGremlinGraphUniqueKey
Typed helper for the unique_key block of azurerm_cosmosdb_gremlin_graph (derived from provider schema).
CosmosdbMongoCollectionAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_mongo_collection (derived from provider schema).
CosmosdbMongoCollectionIndex
Typed helper for the index block of azurerm_cosmosdb_mongo_collection (derived from provider schema).
CosmosdbMongoDatabaseAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_mongo_database (derived from provider schema).
CosmosdbMongoRoleDefinitionPrivilege
Typed helper for the privilege block of azurerm_cosmosdb_mongo_role_definition (derived from provider schema).
CosmosdbMongoRoleDefinitionResource
Typed helper for the privilege.resource block of azurerm_cosmosdb_mongo_role_definition (derived from provider schema).
CosmosdbPostgresqlClusterMaintenanceWindow
Typed helper for the maintenance_window block of azurerm_cosmosdb_postgresql_cluster (derived from provider schema).
CosmosdbSqlContainerAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlContainerCompositeIndex
Typed helper for the indexing_policy.composite_index block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlContainerConflictResolutionPolicy
Typed helper for the conflict_resolution_policy block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlContainerExcludedPath
Typed helper for the indexing_policy.excluded_path block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlContainerIncludedPath
Typed helper for the indexing_policy.included_path block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlContainerIndex
Typed helper for the indexing_policy.composite_index.index block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlContainerIndexingPolicy
Typed helper for the indexing_policy block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlContainerSpatialIndex
Typed helper for the indexing_policy.spatial_index block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlContainerUniqueKey
Typed helper for the unique_key block of azurerm_cosmosdb_sql_container (derived from provider schema).
CosmosdbSqlDatabaseAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_sql_database (derived from provider schema).
CosmosdbSqlRoleDefinitionPermissions
Typed helper for the permissions block of azurerm_cosmosdb_sql_role_definition (derived from provider schema).
CosmosdbTableAutoscaleSettings
Typed helper for the autoscale_settings block of azurerm_cosmosdb_table (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.
DataAzurermCosmosdbAccount
Factory wrapper for azurerm_cosmosdb_account.
DataAzurermCosmosdbMongoDatabase
Factory wrapper for azurerm_cosmosdb_mongo_database.
DataAzurermCosmosdbRestorableDatabaseAccounts
Factory wrapper for azurerm_cosmosdb_restorable_database_accounts.
DataAzurermCosmosdbSqlDatabase
Factory wrapper for azurerm_cosmosdb_sql_database.
DataAzurermCosmosdbSqlRoleDefinition
Factory wrapper for azurerm_cosmosdb_sql_role_definition.
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_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, AzurermBackend, 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 Stack.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

CosmosdbAccountAllowedMethods
allowed_methods — derived from the provider schema description.
CosmosdbAccountCapabilitiesName
name — derived from the provider schema description.
CosmosdbAccountConsistencyLevel
consistency_level — derived from the provider schema description.
CosmosdbAccountCreateMode
Cosmosdb Account Create enum for create_mode.
CosmosdbAccountKind
Cosmosdb Account enum for kind.
CosmosdbAccountMinimalTlsVersion
Cosmosdb Account Minimal Tls enum for minimal_tls_version.
CosmosdbAccountMongoServerVersion
Cosmosdb Account Mongo Server enum for mongo_server_version.
CosmosdbAccountOfferType
Cosmosdb Account Offer enum for offer_type.
CosmosdbAccountSchemaType
schema_type — derived from the provider schema description.
CosmosdbAccountStorageRedundancy
storage_redundancy — derived from the provider schema description.
CosmosdbAccountTier
tier — derived from the provider schema description.
CosmosdbAccountType
type — derived from the provider schema description.
CosmosdbCassandraClusterAuthenticationMethod
Cosmosdb Cassandra Cluster Authentication enum for authentication_method.
CosmosdbCassandraClusterVersion
Cosmosdb Cassandra Cluster enum for version.
CosmosdbCassandraTableOrderBy
order_by — derived from the provider schema description.
CosmosdbGremlinGraphIndexingMode
indexing_mode — derived from the provider schema description.
CosmosdbGremlinGraphMode
mode — derived from the provider schema description.
CosmosdbGremlinGraphOrder
order — derived from the provider schema description.
CosmosdbPostgresqlClusterCitusVersion
Cosmosdb Postgresql Cluster Citus enum for citus_version.
CosmosdbPostgresqlClusterCoordinatorServerEdition
Cosmosdb Postgresql Cluster Coordinator Server enum for coordinator_server_edition.
CosmosdbPostgresqlClusterNodeServerEdition
Cosmosdb Postgresql Cluster Node Server enum for node_server_edition.
CosmosdbPostgresqlClusterSqlVersion
Cosmosdb Postgresql Cluster Sql enum for sql_version.
CosmosdbSqlContainerIndexingMode
indexing_mode — derived from the provider schema description.
CosmosdbSqlContainerMode
mode — derived from the provider schema description.
CosmosdbSqlContainerOrder
order — derived from the provider schema description.
CosmosdbSqlContainerPartitionKeyKind
Cosmosdb Sql Container Partition Key enum for partition_key_kind.
CosmosdbSqlDedicatedGatewayInstanceSize
Cosmosdb Sql Dedicated Gateway Instance enum for instance_size.
CosmosdbSqlRoleDefinitionType
Cosmosdb Sql Role Definition enum for type.
CosmosdbSqlTriggerOperation
Cosmosdb Sql Trigger enum for operation.
CosmosdbSqlTriggerType
Cosmosdb Sql Trigger enum for type.
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.

Typedefs

EnumList<E extends TfArg<String>> = TfArg<List<E>>
A list-valued enum argument (allowed_grant_types, retry_conditions): a literal list of members of E, or one value Terraform resolves to the whole list.

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.