spring_cloud library

Azure Resource Manager spring cloud 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.
AzurermSpringCloudAccelerator
Factory wrapper for azurerm_spring_cloud_accelerator.
AzurermSpringCloudActiveDeployment
Factory wrapper for azurerm_spring_cloud_active_deployment.
AzurermSpringCloudApiPortal
Factory wrapper for azurerm_spring_cloud_api_portal.
AzurermSpringCloudApiPortalCustomDomain
Factory wrapper for azurerm_spring_cloud_api_portal_custom_domain.
AzurermSpringCloudApp
Factory wrapper for azurerm_spring_cloud_app.
AzurermSpringCloudAppCosmosdbAssociation
Factory wrapper for azurerm_spring_cloud_app_cosmosdb_association.
AzurermSpringCloudAppDynamicsApplicationPerformanceMonitoring
Factory wrapper for azurerm_spring_cloud_app_dynamics_application_performance_monitoring.
AzurermSpringCloudApplicationInsightsApplicationPerformanceMonitoring
Factory wrapper for azurerm_spring_cloud_application_insights_application_performance_monitoring.
AzurermSpringCloudApplicationLiveView
Factory wrapper for azurerm_spring_cloud_application_live_view.
AzurermSpringCloudAppMysqlAssociation
Factory wrapper for azurerm_spring_cloud_app_mysql_association.
AzurermSpringCloudAppRedisAssociation
Factory wrapper for azurerm_spring_cloud_app_redis_association.
AzurermSpringCloudBuildDeployment
Factory wrapper for azurerm_spring_cloud_build_deployment.
AzurermSpringCloudBuilder
Factory wrapper for azurerm_spring_cloud_builder.
AzurermSpringCloudBuildPackBinding
Factory wrapper for azurerm_spring_cloud_build_pack_binding.
AzurermSpringCloudCertificate
Factory wrapper for azurerm_spring_cloud_certificate.
AzurermSpringCloudConfigurationService
Factory wrapper for azurerm_spring_cloud_configuration_service.
AzurermSpringCloudConnection
Factory wrapper for azurerm_spring_cloud_connection.
AzurermSpringCloudContainerDeployment
Factory wrapper for azurerm_spring_cloud_container_deployment.
AzurermSpringCloudCustomDomain
Factory wrapper for azurerm_spring_cloud_custom_domain.
AzurermSpringCloudCustomizedAccelerator
Factory wrapper for azurerm_spring_cloud_customized_accelerator.
AzurermSpringCloudDevToolPortal
Factory wrapper for azurerm_spring_cloud_dev_tool_portal.
AzurermSpringCloudDynatraceApplicationPerformanceMonitoring
Factory wrapper for azurerm_spring_cloud_dynatrace_application_performance_monitoring.
AzurermSpringCloudElasticApplicationPerformanceMonitoring
Factory wrapper for azurerm_spring_cloud_elastic_application_performance_monitoring.
AzurermSpringCloudGateway
Factory wrapper for azurerm_spring_cloud_gateway.
AzurermSpringCloudGatewayCustomDomain
Factory wrapper for azurerm_spring_cloud_gateway_custom_domain.
AzurermSpringCloudGatewayRouteConfig
Factory wrapper for azurerm_spring_cloud_gateway_route_config.
AzurermSpringCloudJavaDeployment
Factory wrapper for azurerm_spring_cloud_java_deployment.
AzurermSpringCloudNewRelicApplicationPerformanceMonitoring
Factory wrapper for azurerm_spring_cloud_new_relic_application_performance_monitoring.
AzurermSpringCloudService
Factory wrapper for azurerm_spring_cloud_service.
AzurermSpringCloudStorage
Factory wrapper for azurerm_spring_cloud_storage.
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.
DataAzurermSpringCloudApp
Factory wrapper for azurerm_spring_cloud_app.
DataAzurermSpringCloudService
Factory wrapper for azurerm_spring_cloud_service.
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.
SpringCloudApiPortalSso
Typed helper for the sso block of azurerm_spring_cloud_api_portal (derived from provider schema).
SpringCloudAppCustomPersistentDisk
Typed helper for the custom_persistent_disk block of azurerm_spring_cloud_app (derived from provider schema).
SpringCloudAppIdentity
Typed helper for the identity block of azurerm_spring_cloud_app (derived from provider schema).
SpringCloudAppIngressSettings
Typed helper for the ingress_settings block of azurerm_spring_cloud_app (derived from provider schema).
SpringCloudAppPersistentDisk
Typed helper for the persistent_disk block of azurerm_spring_cloud_app (derived from provider schema).
SpringCloudBuildDeploymentQuota
Typed helper for the quota block of azurerm_spring_cloud_build_deployment (derived from provider schema).
SpringCloudBuilderBuildPackGroup
Typed helper for the build_pack_group block of azurerm_spring_cloud_builder (derived from provider schema).
SpringCloudBuilderStack
Typed helper for the stack block of azurerm_spring_cloud_builder (derived from provider schema).
SpringCloudBuildPackBindingLaunch
Typed helper for the launch block of azurerm_spring_cloud_build_pack_binding (derived from provider schema).
SpringCloudConfigurationServiceRepository
Typed helper for the repository block of azurerm_spring_cloud_configuration_service (derived from provider schema).
SpringCloudConnectionAuthentication
Typed helper for the authentication block of azurerm_spring_cloud_connection (derived from provider schema).
SpringCloudConnectionSecretStore
Typed helper for the secret_store block of azurerm_spring_cloud_connection (derived from provider schema).
SpringCloudContainerDeploymentQuota
Typed helper for the quota block of azurerm_spring_cloud_container_deployment (derived from provider schema).
SpringCloudCustomizedAcceleratorAuth
At most one of basic_auth, ssh_auth on the git_repository block of azurerm_spring_cloud_customized_accelerator: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
SpringCloudCustomizedAcceleratorBasicAuth
Typed helper for the git_repository.basic_auth block of azurerm_spring_cloud_customized_accelerator (derived from provider schema).
SpringCloudCustomizedAcceleratorBasicAuthChoice
The SpringCloudCustomizedAcceleratorAuth.basicAuth choice: sets basic_auth.
SpringCloudCustomizedAcceleratorGitRepository
Typed helper for the git_repository block of azurerm_spring_cloud_customized_accelerator (derived from provider schema).
SpringCloudCustomizedAcceleratorReference
Exactly one of branch, commit, git_tag on the git_repository block of azurerm_spring_cloud_customized_accelerator: the provider rejects none and more than one, so each variant sets one of them.
SpringCloudCustomizedAcceleratorReferenceBranch
The SpringCloudCustomizedAcceleratorReference.branch choice: sets branch.
SpringCloudCustomizedAcceleratorReferenceCommit
The SpringCloudCustomizedAcceleratorReference.commit choice: sets commit.
SpringCloudCustomizedAcceleratorReferenceGitTag
The SpringCloudCustomizedAcceleratorReference.gitTag choice: sets git_tag.
SpringCloudCustomizedAcceleratorSshAuth
Typed helper for the git_repository.ssh_auth block of azurerm_spring_cloud_customized_accelerator (derived from provider schema).
SpringCloudCustomizedAcceleratorSshAuthChoice
The SpringCloudCustomizedAcceleratorAuth.sshAuth choice: sets ssh_auth.
SpringCloudDevToolPortalSso
Typed helper for the sso block of azurerm_spring_cloud_dev_tool_portal (derived from provider schema).
SpringCloudGatewayApiMetadata
Typed helper for the api_metadata block of azurerm_spring_cloud_gateway (derived from provider schema).
SpringCloudGatewayClientAuthorization
Typed helper for the client_authorization block of azurerm_spring_cloud_gateway (derived from provider schema).
SpringCloudGatewayCors
Typed helper for the cors block of azurerm_spring_cloud_gateway (derived from provider schema).
SpringCloudGatewayLocalResponseCache
At most one of local_response_cache_per_instance, local_response_cache_per_route on azurerm_spring_cloud_gateway: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
SpringCloudGatewayLocalResponseCachePerInstance
Typed helper for the local_response_cache_per_instance block of azurerm_spring_cloud_gateway (derived from provider schema).
SpringCloudGatewayLocalResponseCachePerInstanceChoice
The SpringCloudGatewayLocalResponseCache.localResponseCachePerInstance choice: sets local_response_cache_per_instance.
SpringCloudGatewayLocalResponseCachePerRoute
Typed helper for the local_response_cache_per_route block of azurerm_spring_cloud_gateway (derived from provider schema).
SpringCloudGatewayLocalResponseCachePerRouteChoice
The SpringCloudGatewayLocalResponseCache.localResponseCachePerRoute choice: sets local_response_cache_per_route.
SpringCloudGatewayQuota
Typed helper for the quota block of azurerm_spring_cloud_gateway (derived from provider schema).
SpringCloudGatewayRouteConfigOpenApi
Typed helper for the open_api block of azurerm_spring_cloud_gateway_route_config (derived from provider schema).
SpringCloudGatewayRouteConfigRoute
Typed helper for the route block of azurerm_spring_cloud_gateway_route_config (derived from provider schema).
SpringCloudGatewaySso
Typed helper for the sso block of azurerm_spring_cloud_gateway (derived from provider schema).
SpringCloudJavaDeploymentQuota
Typed helper for the quota block of azurerm_spring_cloud_java_deployment (derived from provider schema).
SpringCloudServiceConfigServerGitSetting
Typed helper for the config_server_git_setting block of azurerm_spring_cloud_service (derived from provider schema).
SpringCloudServiceContainerRegistry
Typed helper for the container_registry block of azurerm_spring_cloud_service (derived from provider schema).
SpringCloudServiceDefaultBuildService
Typed helper for the default_build_service block of azurerm_spring_cloud_service (derived from provider schema).
SpringCloudServiceHttpBasicAuth
Typed helper for the config_server_git_setting.http_basic_auth block of azurerm_spring_cloud_service (derived from provider schema). Shared by every block of this shape in the resource.
SpringCloudServiceMarketplace
Typed helper for the marketplace block of azurerm_spring_cloud_service (derived from provider schema).
SpringCloudServiceNetwork
Typed helper for the network block of azurerm_spring_cloud_service (derived from provider schema).
SpringCloudServiceRepository
Typed helper for the config_server_git_setting.repository block of azurerm_spring_cloud_service (derived from provider schema).
SpringCloudServiceSshAuth
Typed helper for the config_server_git_setting.ssh_auth block of azurerm_spring_cloud_service (derived from provider schema). Shared by every block of this shape in the resource.
SpringCloudServiceTrace
Typed helper for the trace block of azurerm_spring_cloud_service (derived from provider schema).
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

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, ...).
SpringCloudAcceleratorName
Spring Cloud Accelerator enum for name.
SpringCloudApiPortalName
Spring Cloud Api Portal enum for name.
SpringCloudAppCosmosdbAssociationApiType
Spring Cloud App Cosmosdb Association Api enum for api_type.
SpringCloudApplicationLiveViewName
Spring Cloud Application Live View enum for name.
SpringCloudBuildPackBindingType
Spring Cloud Build Pack Binding enum for binding_type.
SpringCloudConfigurationServiceGeneration
Spring Cloud Configuration Service enum for generation.
SpringCloudConfigurationServiceName
Spring Cloud Configuration Service enum for name.
SpringCloudConnectionClientType
Spring Cloud Connection Client enum for client_type.
SpringCloudConnectionType
type — derived from the provider schema description.
SpringCloudConnectionVnetSolution
Spring Cloud Connection Vnet enum for vnet_solution.
SpringCloudContainerDeploymentLanguageFramework
Spring Cloud Container Deployment Language enum for language_framework.
SpringCloudCustomizedAcceleratorType
Spring Cloud Customized Accelerator enum for accelerator_type.
SpringCloudDevToolPortalName
Spring Cloud Dev Tool Portal enum for name.
SpringCloudGatewayAllowedMethods
allowed_methods — derived from the provider schema description.
SpringCloudGatewayApplicationPerformanceMonitoringTypes
Spring Cloud Gateway Application Performance Monitoring enum for application_performance_monitoring_types.
SpringCloudGatewayName
Spring Cloud Gateway enum for name.
SpringCloudJavaDeploymentRuntimeVersion
Spring Cloud Java Deployment Runtime enum for runtime_version.
SpringCloudServiceBuildAgentPoolSize
Spring Cloud Service Build Agent Pool enum for build_agent_pool_size.
SpringCloudServiceHostKeyAlgorithm
host_key_algorithm — derived from the provider schema description.
SpringCloudServiceOutboundType
outbound_type — derived from the provider schema description.
SpringCloudServiceSkuName
Spring Cloud Service Sku enum for sku_name.
SpringCloudServiceSkuTier
Spring Cloud Service Sku enum for sku_tier.

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.