msk library

AWS Managed Streaming for Apache Kafka (MSK).

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.
AwsMskChannel
Factory wrapper for aws_msk_channel.
AwsMskCluster
Factory wrapper for aws_msk_cluster.
AwsMskClusterPolicy
Factory wrapper for aws_msk_cluster_policy.
AwsMskConfiguration
Factory wrapper for aws_msk_configuration.
AwsMskReplicator
Factory wrapper for aws_msk_replicator.
AwsMskScramSecretAssociation
Factory wrapper for aws_msk_scram_secret_association.
AwsMskServerlessCluster
Factory wrapper for aws_msk_serverless_cluster.
AwsMskSingleScramSecretAssociation
Factory wrapper for aws_msk_single_scram_secret_association.
AwsMskTopic
Factory wrapper for aws_msk_topic.
AwsMskVpcConnection
Factory wrapper for aws_msk_vpc_connection.
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.
DataAwsMskBootstrapBrokers
Factory wrapper for aws_msk_bootstrap_brokers.
DataAwsMskBrokerNodes
Factory wrapper for aws_msk_broker_nodes.
DataAwsMskCluster
Factory wrapper for aws_msk_cluster.
DataAwsMskConfiguration
Factory wrapper for aws_msk_configuration.
DataAwsMskKafkaVersion
Factory wrapper for aws_msk_kafka_version.
DataAwsMskTopic
Factory wrapper for aws_msk_topic.
DataAwsMskVpcConnection
Factory wrapper for aws_msk_vpc_connection.
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.
MskChannelCatalog
Typed helper for the iceberg_destination.catalog block of aws_msk_channel (derived from provider schema).
MskChannelCloudwatchLogs
Typed helper for the logging_info.cloudwatch_logs block of aws_msk_channel (derived from provider schema).
MskChannelDeadLetterQueueS3
Typed helper for the iceberg_destination.dead_letter_queue_s3 block of aws_msk_channel (derived from provider schema). Shared by every block of this shape in the resource.
MskChannelDestination
Exactly one of iceberg_destination, s3_destination on aws_msk_channel: the provider rejects none and more than one, so each variant sets one of them.
MskChannelDestinationTable
Typed helper for the iceberg_destination.destination_table block of aws_msk_channel (derived from provider schema).
MskChannelEncryptionConfiguration
Typed helper for the encryption_configuration block of aws_msk_channel (derived from provider schema).
MskChannelFirehose
Typed helper for the logging_info.firehose block of aws_msk_channel (derived from provider schema).
MskChannelIcebergDestination
Typed helper for the iceberg_destination block of aws_msk_channel (derived from provider schema).
MskChannelIcebergDestinationChoice
The MskChannelDestination.icebergDestination choice: sets iceberg_destination.
MskChannelLoggingInfo
Typed helper for the logging_info block of aws_msk_channel (derived from provider schema).
MskChannelPartitionSpec
Typed helper for the iceberg_destination.destination_table.partition_spec block of aws_msk_channel (derived from provider schema).
MskChannelRecordConverter
Typed helper for the topic_configuration.record_converter block of aws_msk_channel (derived from provider schema).
MskChannelRecordSchema
Typed helper for the topic_configuration.record_schema block of aws_msk_channel (derived from provider schema).
MskChannelS3
Typed helper for the logging_info.s3 block of aws_msk_channel (derived from provider schema).
MskChannelS3Destination
Typed helper for the s3_destination block of aws_msk_channel (derived from provider schema).
MskChannelS3DestinationChoice
The MskChannelDestination.s3Destination choice: sets s3_destination.
MskChannelSchemaEvolution
Typed helper for the iceberg_destination.schema_evolution block of aws_msk_channel (derived from provider schema).
MskChannelSource
Typed helper for the iceberg_destination.destination_table.partition_spec.source block of aws_msk_channel (derived from provider schema).
MskChannelStorage
Typed helper for the s3_destination.storage block of aws_msk_channel (derived from provider schema).
MskChannelTableCreation
Typed helper for the iceberg_destination.table_creation block of aws_msk_channel (derived from provider schema).
MskChannelTopicConfiguration
Typed helper for the topic_configuration block of aws_msk_channel (derived from provider schema).
MskClusterBrokerLogs
Typed helper for the logging_info.broker_logs block of aws_msk_cluster (derived from provider schema).
MskClusterBrokerNodeGroupInfo
Typed helper for the broker_node_group_info block of aws_msk_cluster (derived from provider schema).
MskClusterClientAuthentication
Typed helper for the client_authentication block of aws_msk_cluster (derived from provider schema).
MskClusterCloudwatchLogs
Typed helper for the logging_info.broker_logs.cloudwatch_logs block of aws_msk_cluster (derived from provider schema).
MskClusterConfigurationInfo
Typed helper for the configuration_info block of aws_msk_cluster (derived from provider schema).
MskClusterConnectivityInfo
Typed helper for the broker_node_group_info.connectivity_info block of aws_msk_cluster (derived from provider schema).
MskClusterEbsStorageInfo
Typed helper for the broker_node_group_info.storage_info.ebs_storage_info block of aws_msk_cluster (derived from provider schema).
MskClusterEncryptionInfo
Typed helper for the encryption_info block of aws_msk_cluster (derived from provider schema).
MskClusterEncryptionInTransit
Typed helper for the encryption_info.encryption_in_transit block of aws_msk_cluster (derived from provider schema).
MskClusterFirehose
Typed helper for the logging_info.broker_logs.firehose block of aws_msk_cluster (derived from provider schema).
MskClusterJmxExporter
Typed helper for the open_monitoring.prometheus.jmx_exporter block of aws_msk_cluster (derived from provider schema).
MskClusterLoggingInfo
Typed helper for the logging_info block of aws_msk_cluster (derived from provider schema).
MskClusterNodeExporter
Typed helper for the open_monitoring.prometheus.node_exporter block of aws_msk_cluster (derived from provider schema).
MskClusterOpenMonitoring
Typed helper for the open_monitoring block of aws_msk_cluster (derived from provider schema).
MskClusterPrometheus
Typed helper for the open_monitoring.prometheus block of aws_msk_cluster (derived from provider schema).
MskClusterProvisionedThroughput
Typed helper for the broker_node_group_info.storage_info.ebs_storage_info.provisioned_throughput block of aws_msk_cluster (derived from provider schema).
MskClusterPublicAccess
Typed helper for the broker_node_group_info.connectivity_info.public_access block of aws_msk_cluster (derived from provider schema).
MskClusterRebalancing
Typed helper for the rebalancing block of aws_msk_cluster (derived from provider schema).
MskClusterS3
Typed helper for the logging_info.broker_logs.s3 block of aws_msk_cluster (derived from provider schema).
MskClusterSasl
Typed helper for the client_authentication.sasl block of aws_msk_cluster (derived from provider schema). Shared by every block of this shape in the resource.
MskClusterStorageInfo
Typed helper for the broker_node_group_info.storage_info block of aws_msk_cluster (derived from provider schema).
MskClusterTls
Typed helper for the client_authentication.tls block of aws_msk_cluster (derived from provider schema).
MskClusterVpcConnectivity
Typed helper for the broker_node_group_info.connectivity_info.vpc_connectivity block of aws_msk_cluster (derived from provider schema).
MskClusterVpcConnectivityClientAuthentication
Typed helper for the broker_node_group_info.connectivity_info.vpc_connectivity.client_authentication block of aws_msk_cluster (derived from provider schema).
MskReplicatorAmazonMskCluster
Typed helper for the kafka_cluster.amazon_msk_cluster block of aws_msk_replicator (derived from provider schema).
MskReplicatorApacheKafkaCluster
Typed helper for the kafka_cluster.apache_kafka_cluster block of aws_msk_replicator (derived from provider schema).
MskReplicatorClientAuthentication
Typed helper for the kafka_cluster.client_authentication block of aws_msk_replicator (derived from provider schema).
MskReplicatorCloudwatchLogs
Typed helper for the log_delivery.replicator_log_delivery.cloudwatch_logs block of aws_msk_replicator (derived from provider schema).
MskReplicatorConsumerGroupReplication
Typed helper for the replication_info_list.consumer_group_replication block of aws_msk_replicator (derived from provider schema).
MskReplicatorEncryptionInTransit
Typed helper for the kafka_cluster.encryption_in_transit block of aws_msk_replicator (derived from provider schema).
MskReplicatorFirehose
Typed helper for the log_delivery.replicator_log_delivery.firehose block of aws_msk_replicator (derived from provider schema).
MskReplicatorKafkaCluster
Typed helper for the kafka_cluster block of aws_msk_replicator (derived from provider schema).
MskReplicatorLogDelivery
Typed helper for the log_delivery block of aws_msk_replicator (derived from provider schema).
MskReplicatorMtls
Typed helper for the kafka_cluster.client_authentication.mtls block of aws_msk_replicator (derived from provider schema).
MskReplicatorReplicationInfoList
Typed helper for the replication_info_list block of aws_msk_replicator (derived from provider schema).
MskReplicatorReplicatorLogDelivery
Typed helper for the log_delivery.replicator_log_delivery block of aws_msk_replicator (derived from provider schema).
MskReplicatorS3
Typed helper for the log_delivery.replicator_log_delivery.s3 block of aws_msk_replicator (derived from provider schema).
MskReplicatorSaslScram
Typed helper for the kafka_cluster.client_authentication.sasl_scram block of aws_msk_replicator (derived from provider schema).
MskReplicatorSourceKafkaCluster
Exactly one of source_kafka_cluster_arn, source_kafka_cluster_id on the replication_info_list block of aws_msk_replicator: the provider rejects none and more than one, so each variant sets one of them.
MskReplicatorSourceKafkaClusterArn
The MskReplicatorSourceKafkaCluster.sourceKafkaClusterArn choice: sets source_kafka_cluster_arn.
MskReplicatorSourceKafkaClusterId
The MskReplicatorSourceKafkaCluster.sourceKafkaClusterId choice: sets source_kafka_cluster_id.
MskReplicatorStartingPosition
Typed helper for the replication_info_list.topic_replication.starting_position block of aws_msk_replicator (derived from provider schema).
MskReplicatorTargetKafkaCluster
Exactly one of target_kafka_cluster_arn, target_kafka_cluster_id on the replication_info_list block of aws_msk_replicator: the provider rejects none and more than one, so each variant sets one of them.
MskReplicatorTargetKafkaClusterArn
The MskReplicatorTargetKafkaCluster.targetKafkaClusterArn choice: sets target_kafka_cluster_arn.
MskReplicatorTargetKafkaClusterId
The MskReplicatorTargetKafkaCluster.targetKafkaClusterId choice: sets target_kafka_cluster_id.
MskReplicatorTopicNameConfiguration
Typed helper for the replication_info_list.topic_replication.topic_name_configuration block of aws_msk_replicator (derived from provider schema).
MskReplicatorTopicReplication
Typed helper for the replication_info_list.topic_replication block of aws_msk_replicator (derived from provider schema).
MskReplicatorVpcConfig
Typed helper for the kafka_cluster.vpc_config block of aws_msk_replicator (derived from provider schema).
MskServerlessClusterClientAuthentication
Typed helper for the client_authentication block of aws_msk_serverless_cluster (derived from provider schema).
MskServerlessClusterIam
Typed helper for the client_authentication.sasl.iam block of aws_msk_serverless_cluster (derived from provider schema).
MskServerlessClusterSasl
Typed helper for the client_authentication.sasl block of aws_msk_serverless_cluster (derived from provider schema).
MskServerlessClusterVpcConfig
Typed helper for the vpc_config block of aws_msk_serverless_cluster (derived from provider schema).
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

MskChannelCompressionType
compression_type — derived from the provider schema description.
MskChannelPartitionStrategy
partition_strategy — derived from the provider schema description.
MskChannelStorageClass
storage_class — derived from the provider schema description.
MskChannelStorageCompressionType
compression_type — derived from the provider schema description.
MskChannelValueConverter
value_converter — derived from the provider schema description.
MskClusterAzDistribution
az_distribution — derived from the provider schema description.
MskClusterClientBroker
client_broker — derived from the provider schema description.
MskClusterEnhancedMonitoring
Msk Cluster Enhanced enum for enhanced_monitoring.
MskClusterNetworkType
network_type — derived from the provider schema description.
MskClusterStatus
status — derived from the provider schema description.
MskClusterStorageMode
Msk Cluster Storage enum for storage_mode.
MskClusterType
type — derived from the provider schema description.
MskReplicatorConsumerGroupOffsetSyncMode
consumer_group_offset_sync_mode — derived from the provider schema description.
MskReplicatorMechanism
mechanism — derived from the provider schema description.
MskReplicatorStartingPositionType
type — derived from the provider schema description.
MskReplicatorTopicNameConfigurationType
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").

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)?}) → 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.