container_app library

Azure Resource Manager container app 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.
AzurermContainerApp
Factory wrapper for azurerm_container_app.
AzurermContainerAppCustomDomain
Factory wrapper for azurerm_container_app_custom_domain.
AzurermContainerAppEnvironment
Factory wrapper for azurerm_container_app_environment.
AzurermContainerAppEnvironmentCertificate
Factory wrapper for azurerm_container_app_environment_certificate.
AzurermContainerAppEnvironmentCustomDomain
Factory wrapper for azurerm_container_app_environment_custom_domain.
AzurermContainerAppEnvironmentDaprComponent
Factory wrapper for azurerm_container_app_environment_dapr_component.
AzurermContainerAppEnvironmentManagedCertificate
Factory wrapper for azurerm_container_app_environment_managed_certificate.
AzurermContainerAppEnvironmentStorage
Factory wrapper for azurerm_container_app_environment_storage.
AzurermContainerAppJob
Factory wrapper for azurerm_container_app_job.
ContainerAppAzureQueueScaleRule
Typed helper for the template.azure_queue_scale_rule block of azurerm_container_app (derived from provider schema).
ContainerAppAzureQueueScaleRuleAuthentication
Typed helper for the template.azure_queue_scale_rule.authentication block of azurerm_container_app (derived from provider schema). Shared by every block of this shape in the resource.
ContainerAppContainer
Typed helper for the template.container block of azurerm_container_app (derived from provider schema).
ContainerAppCors
Typed helper for the ingress.cors block of azurerm_container_app (derived from provider schema).
ContainerAppCustomScaleRule
Typed helper for the template.custom_scale_rule block of azurerm_container_app (derived from provider schema).
ContainerAppDapr
Typed helper for the dapr block of azurerm_container_app (derived from provider schema).
ContainerAppEnv
Typed helper for the template.container.env block of azurerm_container_app (derived from provider schema). Shared by every block of this shape in the resource.
ContainerAppEnvironmentCertificateKeyVault
Typed helper for the certificate_key_vault block of azurerm_container_app_environment_certificate (derived from provider schema).
ContainerAppEnvironmentCertificateSource
Exactly one of certificate_blob_base64, certificate_key_vault on azurerm_container_app_environment_certificate: the provider rejects none and more than one, so each variant sets one of them.
ContainerAppEnvironmentCertificateSourceCertificateBlobBase64
The ContainerAppEnvironmentCertificateSource.certificateBlobBase64 choice: sets certificate_blob_base64.
ContainerAppEnvironmentCertificateSourceCertificateKeyVault
The ContainerAppEnvironmentCertificateSource.certificateKeyVault choice: sets certificate_key_vault.
ContainerAppEnvironmentDaprComponentMetadata
Typed helper for the metadata block of azurerm_container_app_environment_dapr_component (derived from provider schema).
ContainerAppEnvironmentDaprComponentSecret
Typed helper for the secret block of azurerm_container_app_environment_dapr_component (derived from provider schema).
ContainerAppEnvironmentIdentity
Typed helper for the identity block of azurerm_container_app_environment (derived from provider schema).
ContainerAppEnvironmentStorageBackend
At most one of account_name, nfs_server_url on azurerm_container_app_environment_storage: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ContainerAppEnvironmentStorageBackendAccountName
The ContainerAppEnvironmentStorageBackend.accountName choice: sets account_name.
ContainerAppEnvironmentStorageBackendNfsServerUrl
The ContainerAppEnvironmentStorageBackend.nfsServerUrl choice: sets nfs_server_url.
ContainerAppEnvironmentWorkloadProfile
Typed helper for the workload_profile block of azurerm_container_app_environment (derived from provider schema).
ContainerAppHeader
Typed helper for the template.container.liveness_probe.header block of azurerm_container_app (derived from provider schema). Shared by every block of this shape in the resource.
ContainerAppHttpScaleRule
Typed helper for the template.http_scale_rule block of azurerm_container_app (derived from provider schema).
ContainerAppHttpScaleRuleAuthentication
Typed helper for the template.http_scale_rule.authentication block of azurerm_container_app (derived from provider schema). Shared by every block of this shape in the resource.
ContainerAppIdentity
Typed helper for the identity block of azurerm_container_app (derived from provider schema).
ContainerAppIngress
Typed helper for the ingress block of azurerm_container_app (derived from provider schema).
ContainerAppInitContainer
Typed helper for the template.init_container block of azurerm_container_app (derived from provider schema).
ContainerAppIpSecurityRestriction
Typed helper for the ingress.ip_security_restriction block of azurerm_container_app (derived from provider schema).
ContainerAppJobAuthentication
Typed helper for the event_trigger_config.scale.rules.authentication block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobContainer
Typed helper for the template.container block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobEnv
Typed helper for the template.container.env block of azurerm_container_app_job (derived from provider schema). Shared by every block of this shape in the resource.
ContainerAppJobEventTriggerConfig
Typed helper for the event_trigger_config block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobEventTriggerConfigChoice
The ContainerAppJobTriggerConfig.eventTriggerConfig choice: sets event_trigger_config.
ContainerAppJobHeader
Typed helper for the template.container.liveness_probe.header block of azurerm_container_app_job (derived from provider schema). Shared by every block of this shape in the resource.
ContainerAppJobIdentity
Typed helper for the identity block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobInitContainer
Typed helper for the template.init_container block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobLivenessProbe
Typed helper for the template.container.liveness_probe block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobManualTriggerConfig
Typed helper for the manual_trigger_config block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobManualTriggerConfigChoice
The ContainerAppJobTriggerConfig.manualTriggerConfig choice: sets manual_trigger_config.
ContainerAppJobReadinessProbe
Typed helper for the template.container.readiness_probe block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobRegistry
Typed helper for the registry block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobRules
Typed helper for the event_trigger_config.scale.rules block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobScale
Typed helper for the event_trigger_config.scale block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobScheduleTriggerConfig
Typed helper for the schedule_trigger_config block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobScheduleTriggerConfigChoice
The ContainerAppJobTriggerConfig.scheduleTriggerConfig choice: sets schedule_trigger_config.
ContainerAppJobSecret
Typed helper for the secret block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobStartupProbe
Typed helper for the template.container.startup_probe block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobTemplate
Typed helper for the template block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobTriggerConfig
Exactly one of event_trigger_config, manual_trigger_config, schedule_trigger_config on azurerm_container_app_job: the provider rejects none and more than one, so each variant sets one of them.
ContainerAppJobVolume
Typed helper for the template.volume block of azurerm_container_app_job (derived from provider schema).
ContainerAppJobVolumeMounts
Typed helper for the template.container.volume_mounts block of azurerm_container_app_job (derived from provider schema). Shared by every block of this shape in the resource.
ContainerAppLivenessProbe
Typed helper for the template.container.liveness_probe block of azurerm_container_app (derived from provider schema).
ContainerAppReadinessProbe
Typed helper for the template.container.readiness_probe block of azurerm_container_app (derived from provider schema).
ContainerAppRegistry
Typed helper for the registry block of azurerm_container_app (derived from provider schema).
ContainerAppSecret
Typed helper for the secret block of azurerm_container_app (derived from provider schema).
ContainerAppStartupProbe
Typed helper for the template.container.startup_probe block of azurerm_container_app (derived from provider schema).
ContainerAppTcpScaleRule
Typed helper for the template.tcp_scale_rule block of azurerm_container_app (derived from provider schema).
ContainerAppTemplate
Typed helper for the template block of azurerm_container_app (derived from provider schema).
ContainerAppTrafficWeight
Typed helper for the ingress.traffic_weight block of azurerm_container_app (derived from provider schema).
ContainerAppVolume
Typed helper for the template.volume block of azurerm_container_app (derived from provider schema).
ContainerAppVolumeMounts
Typed helper for the template.container.volume_mounts block of azurerm_container_app (derived from provider schema). Shared by every block of this shape in the resource.
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.
DataAzurermContainerApp
Factory wrapper for azurerm_container_app.
DataAzurermContainerAppEnvironment
Factory wrapper for azurerm_container_app_environment.
DataAzurermContainerAppEnvironmentCertificate
Factory wrapper for azurerm_container_app_environment_certificate.
DataAzurermContainerAppEnvironmentStorage
Factory wrapper for azurerm_container_app_environment_storage.
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

ContainerAppAction
action — derived from the provider schema description.
ContainerAppClientCertificateMode
client_certificate_mode — derived from the provider schema description.
ContainerAppCustomDomainCertificateBindingType
Container App Custom Domain Certificate Binding enum for certificate_binding_type.
ContainerAppCustomRuleType
custom_rule_type — derived from the provider schema description.
ContainerAppEnvironmentLogsDestination
Container App Environment Logs enum for logs_destination.
ContainerAppEnvironmentManagedCertificateDomainControlValidation
Container App Environment Managed Certificate Domain Control enum for domain_control_validation.
ContainerAppEnvironmentPublicNetworkAccess
Container App Environment Public Network enum for public_network_access.
ContainerAppEnvironmentStorageAccessMode
Container App Environment Storage Access enum for access_mode.
ContainerAppEnvironmentWorkloadProfileType
workload_profile_type — derived from the provider schema description.
ContainerAppJobCustomRuleType
custom_rule_type — derived from the provider schema description.
ContainerAppJobStorageType
storage_type — derived from the provider schema description.
ContainerAppJobTransport
transport — derived from the provider schema description.
ContainerAppLivenessProbeTransport
transport — derived from the provider schema description.
ContainerAppProtocol
app_protocol — derived from the provider schema description.
ContainerAppRevisionMode
Container App Revision enum for revision_mode.
ContainerAppStorageType
storage_type — derived from the provider schema description.
ContainerAppTransport
transport — 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)?, 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.