eventgrid library

Azure Resource Manager eventgrid 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.
AzurermEventgridDomain
Factory wrapper for azurerm_eventgrid_domain.
AzurermEventgridDomainTopic
Factory wrapper for azurerm_eventgrid_domain_topic.
AzurermEventgridEventSubscription
Factory wrapper for azurerm_eventgrid_event_subscription.
AzurermEventgridNamespace
Factory wrapper for azurerm_eventgrid_namespace.
AzurermEventgridNamespaceTopic
Factory wrapper for azurerm_eventgrid_namespace_topic.
AzurermEventgridPartnerConfiguration
Factory wrapper for azurerm_eventgrid_partner_configuration.
AzurermEventgridPartnerNamespace
Factory wrapper for azurerm_eventgrid_partner_namespace.
AzurermEventgridPartnerRegistration
Factory wrapper for azurerm_eventgrid_partner_registration.
AzurermEventgridSystemTopic
Factory wrapper for azurerm_eventgrid_system_topic.
AzurermEventgridSystemTopicEventSubscription
Factory wrapper for azurerm_eventgrid_system_topic_event_subscription.
AzurermEventgridTopic
Factory wrapper for azurerm_eventgrid_topic.
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.
DataAzurermEventgridDomain
Factory wrapper for azurerm_eventgrid_domain.
DataAzurermEventgridDomainTopic
Factory wrapper for azurerm_eventgrid_domain_topic.
DataAzurermEventgridPartnerNamespace
Factory wrapper for azurerm_eventgrid_partner_namespace.
DataAzurermEventgridPartnerRegistration
Factory wrapper for azurerm_eventgrid_partner_registration.
DataAzurermEventgridSystemTopic
Factory wrapper for azurerm_eventgrid_system_topic.
DataAzurermEventgridTopic
Factory wrapper for azurerm_eventgrid_topic.
DataRef<T>
Public for sealed pattern matching, but constructor is private — only TfRef.data() may construct instances.
EnvironmentConstant
The AppConstant.fromEnvironment choice.
EventgridDomainIdentity
Typed helper for the identity block of azurerm_eventgrid_domain (derived from provider schema).
EventgridDomainInputMappingDefaultValues
Typed helper for the input_mapping_default_values block of azurerm_eventgrid_domain (derived from provider schema).
EventgridDomainInputMappingFields
Typed helper for the input_mapping_fields block of azurerm_eventgrid_domain (derived from provider schema).
EventgridEventSubscriptionAdvancedFilter
Typed helper for the advanced_filter block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionAzureFunctionEndpoint
Typed helper for the azure_function_endpoint block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionBoolEquals
Typed helper for the advanced_filter.bool_equals block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionDeadLetterIdentity
Typed helper for the dead_letter_identity block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionDeliveryIdentity
Typed helper for the delivery_identity block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionDeliveryProperty
Typed helper for the delivery_property block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionIsNotNull
Typed helper for the advanced_filter.is_not_null block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionIsNullOrUndefined
Typed helper for the advanced_filter.is_null_or_undefined block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionNumberGreaterThan
Typed helper for the advanced_filter.number_greater_than block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionNumberGreaterThanOrEquals
Typed helper for the advanced_filter.number_greater_than_or_equals block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionNumberIn
Typed helper for the advanced_filter.number_in block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionNumberInRange
Typed helper for the advanced_filter.number_in_range block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionNumberLessThan
Typed helper for the advanced_filter.number_less_than block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionNumberLessThanOrEquals
Typed helper for the advanced_filter.number_less_than_or_equals block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionNumberNotIn
Typed helper for the advanced_filter.number_not_in block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionNumberNotInRange
Typed helper for the advanced_filter.number_not_in_range block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionRetryPolicy
Typed helper for the retry_policy block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStorageBlobDeadLetterDestination
Typed helper for the storage_blob_dead_letter_destination block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStorageQueueEndpoint
Typed helper for the storage_queue_endpoint block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStringBeginsWith
Typed helper for the advanced_filter.string_begins_with block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStringContains
Typed helper for the advanced_filter.string_contains block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStringEndsWith
Typed helper for the advanced_filter.string_ends_with block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStringIn
Typed helper for the advanced_filter.string_in block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStringNotBeginsWith
Typed helper for the advanced_filter.string_not_begins_with block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStringNotContains
Typed helper for the advanced_filter.string_not_contains block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStringNotEndsWith
Typed helper for the advanced_filter.string_not_ends_with block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionStringNotIn
Typed helper for the advanced_filter.string_not_in block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionSubjectFilter
Typed helper for the subject_filter block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridEventSubscriptionWebhookEndpoint
Typed helper for the webhook_endpoint block of azurerm_eventgrid_event_subscription (derived from provider schema).
EventgridNamespaceDynamicRoutingEnrichment
Typed helper for the topic_spaces_configuration.dynamic_routing_enrichment block of azurerm_eventgrid_namespace (derived from provider schema).
EventgridNamespaceIdentity
Typed helper for the identity block of azurerm_eventgrid_namespace (derived from provider schema).
EventgridNamespaceInboundIpRule
Typed helper for the inbound_ip_rule block of azurerm_eventgrid_namespace (derived from provider schema).
EventgridNamespaceStaticRoutingEnrichment
Typed helper for the topic_spaces_configuration.static_routing_enrichment block of azurerm_eventgrid_namespace (derived from provider schema).
EventgridNamespaceTopicSpacesConfiguration
Typed helper for the topic_spaces_configuration block of azurerm_eventgrid_namespace (derived from provider schema).
EventgridPartnerConfigurationPartnerAuthorization
Typed helper for the partner_authorization block of azurerm_eventgrid_partner_configuration (derived from provider schema).
EventgridPartnerNamespaceInboundIpRule
Typed helper for the inbound_ip_rule block of azurerm_eventgrid_partner_namespace (derived from provider schema).
EventgridSystemTopicEventSubscriptionAdvancedFilter
Typed helper for the advanced_filter block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionAzureFunctionEndpoint
Typed helper for the azure_function_endpoint block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionBoolEquals
Typed helper for the advanced_filter.bool_equals block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionDeadLetterIdentity
Typed helper for the dead_letter_identity block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionDeliveryIdentity
Typed helper for the delivery_identity block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionDeliveryProperty
Typed helper for the delivery_property block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionIsNotNull
Typed helper for the advanced_filter.is_not_null block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionIsNullOrUndefined
Typed helper for the advanced_filter.is_null_or_undefined block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionNumberGreaterThan
Typed helper for the advanced_filter.number_greater_than block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionNumberGreaterThanOrEquals
Typed helper for the advanced_filter.number_greater_than_or_equals block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionNumberIn
Typed helper for the advanced_filter.number_in block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionNumberInRange
Typed helper for the advanced_filter.number_in_range block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionNumberLessThan
Typed helper for the advanced_filter.number_less_than block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionNumberLessThanOrEquals
Typed helper for the advanced_filter.number_less_than_or_equals block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionNumberNotIn
Typed helper for the advanced_filter.number_not_in block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionNumberNotInRange
Typed helper for the advanced_filter.number_not_in_range block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionRetryPolicy
Typed helper for the retry_policy block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStorageBlobDeadLetterDestination
Typed helper for the storage_blob_dead_letter_destination block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStorageQueueEndpoint
Typed helper for the storage_queue_endpoint block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStringBeginsWith
Typed helper for the advanced_filter.string_begins_with block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStringContains
Typed helper for the advanced_filter.string_contains block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStringEndsWith
Typed helper for the advanced_filter.string_ends_with block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStringIn
Typed helper for the advanced_filter.string_in block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStringNotBeginsWith
Typed helper for the advanced_filter.string_not_begins_with block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStringNotContains
Typed helper for the advanced_filter.string_not_contains block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStringNotEndsWith
Typed helper for the advanced_filter.string_not_ends_with block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionStringNotIn
Typed helper for the advanced_filter.string_not_in block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionSubjectFilter
Typed helper for the subject_filter block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicEventSubscriptionWebhookEndpoint
Typed helper for the webhook_endpoint block of azurerm_eventgrid_system_topic_event_subscription (derived from provider schema).
EventgridSystemTopicIdentity
Typed helper for the identity block of azurerm_eventgrid_system_topic (derived from provider schema).
EventgridTopicIdentity
Typed helper for the identity block of azurerm_eventgrid_topic (derived from provider schema).
EventgridTopicInputMappingDefaultValues
Typed helper for the input_mapping_default_values block of azurerm_eventgrid_topic (derived from provider schema).
EventgridTopicInputMappingFields
Typed helper for the input_mapping_fields block of azurerm_eventgrid_topic (derived from provider schema).
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

EventgridDomainDataResidencyBoundary
Eventgrid Domain Data Residency enum for data_residency_boundary.
EventgridDomainInputSchema
Eventgrid Domain Input enum for input_schema.
EventgridDomainMinimumTlsVersion
Eventgrid Domain Minimum Tls enum for minimum_tls_version.
EventgridEventSubscriptionDeadLetterIdentityType
type — derived from the provider schema description.
EventgridEventSubscriptionDeliveryPropertyType
type — derived from the provider schema description.
EventgridEventSubscriptionEventDeliverySchema
Eventgrid Event Subscription Event Delivery enum for event_delivery_schema.
EventgridNamespaceAction
action — derived from the provider schema description.
EventgridNamespaceAlternativeAuthenticationNameSource
alternative_authentication_name_source — derived from the provider schema description.
EventgridNamespacePublicNetworkAccess
Eventgrid Namespace Public Network enum for public_network_access.
EventgridNamespaceSku
Eventgrid Namespace enum for sku.
EventgridPartnerNamespaceAction
action — derived from the provider schema description.
EventgridPartnerNamespacePartnerTopicRoutingMode
Eventgrid Partner Namespace Partner Topic Routing enum for partner_topic_routing_mode.
EventgridPartnerNamespacePublicNetworkAccess
Eventgrid Partner Namespace Public Network enum for public_network_access.
EventgridSystemTopicEventSubscriptionDeadLetterIdentityType
type — derived from the provider schema description.
EventgridSystemTopicEventSubscriptionDeliveryPropertyType
type — derived from the provider schema description.
EventgridSystemTopicEventSubscriptionEventDeliverySchema
Eventgrid System Topic Event Subscription Event Delivery enum for event_delivery_schema.
EventgridTopicDataResidencyBoundary
Eventgrid Topic Data Residency enum for data_residency_boundary.
EventgridTopicInputSchema
Eventgrid Topic Input enum for input_schema.
EventgridTopicMinimumTlsVersion
Eventgrid Topic Minimum Tls enum for minimum_tls_version.
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.