api_management library

Azure Resource Manager api management resources.

Classes

ApiManagement
Typed helper for the hostname_configuration.management block of azurerm_api_management (derived from provider schema).
ApiManagementAdditionalLocation
Typed helper for the additional_location block of azurerm_api_management (derived from provider schema).
ApiManagementApiAuth
At most one of oauth2_authorization, openid_authentication on azurerm_api_management_api: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementApiAuthOauth2Authorization
The ApiManagementApiAuth.oauth2Authorization choice: sets oauth2_authorization.
ApiManagementApiAuthOpenidAuthentication
The ApiManagementApiAuth.openidAuthentication choice: sets openid_authentication.
ApiManagementApiContact
Typed helper for the contact block of azurerm_api_management_api (derived from provider schema).
ApiManagementApiDiagnosticBackendRequest
Typed helper for the backend_request block of azurerm_api_management_api_diagnostic (derived from provider schema).
ApiManagementApiDiagnosticBackendResponse
Typed helper for the backend_response block of azurerm_api_management_api_diagnostic (derived from provider schema).
ApiManagementApiDiagnosticDataMasking
Typed helper for the backend_request.data_masking block of azurerm_api_management_api_diagnostic (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementApiDiagnosticFrontendRequest
Typed helper for the frontend_request block of azurerm_api_management_api_diagnostic (derived from provider schema).
ApiManagementApiDiagnosticFrontendResponse
Typed helper for the frontend_response block of azurerm_api_management_api_diagnostic (derived from provider schema).
ApiManagementApiDiagnosticHeaders
Typed helper for the backend_request.data_masking.headers block of azurerm_api_management_api_diagnostic (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementApiDiagnosticQueryParams
Typed helper for the backend_request.data_masking.query_params block of azurerm_api_management_api_diagnostic (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementApiImport
Typed helper for the import block of azurerm_api_management_api (derived from provider schema).
ApiManagementApiLicense
Typed helper for the license block of azurerm_api_management_api (derived from provider schema).
ApiManagementApiOauth2Authorization
Typed helper for the oauth2_authorization block of azurerm_api_management_api (derived from provider schema).
ApiManagementApiOpenidAuthentication
Typed helper for the openid_authentication block of azurerm_api_management_api (derived from provider schema).
ApiManagementApiOperationExample
Typed helper for the template_parameter.example block of azurerm_api_management_api_operation (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementApiOperationFormParameter
Typed helper for the request.representation.form_parameter block of azurerm_api_management_api_operation (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementApiOperationHeader
Typed helper for the request.header block of azurerm_api_management_api_operation (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementApiOperationPolicyXml
At most one of xml_content, xml_link on azurerm_api_management_api_operation_policy: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementApiOperationPolicyXmlContent
The ApiManagementApiOperationPolicyXml.xmlContent choice: sets xml_content.
The ApiManagementApiOperationPolicyXml.xmlLink choice: sets xml_link.
ApiManagementApiOperationQueryParameter
Typed helper for the request.query_parameter block of azurerm_api_management_api_operation (derived from provider schema).
ApiManagementApiOperationRepresentation
Typed helper for the request.representation block of azurerm_api_management_api_operation (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementApiOperationRequest
Typed helper for the request block of azurerm_api_management_api_operation (derived from provider schema).
ApiManagementApiOperationResponse
Typed helper for the response block of azurerm_api_management_api_operation (derived from provider schema).
ApiManagementApiOperationTemplateParameter
Typed helper for the template_parameter block of azurerm_api_management_api_operation (derived from provider schema).
ApiManagementApiPolicyXml
At most one of xml_content, xml_link on azurerm_api_management_api_policy: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementApiPolicyXmlContent
The ApiManagementApiPolicyXml.xmlContent choice: sets xml_content.
The ApiManagementApiPolicyXml.xmlLink choice: sets xml_link.
ApiManagementApiSchemaDocument
Exactly one of components, definitions, value on azurerm_api_management_api_schema: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementApiSchemaDocumentComponents
The ApiManagementApiSchemaDocument.components choice: sets components.
ApiManagementApiSchemaDocumentDefinitions
The ApiManagementApiSchemaDocument.definitions choice: sets definitions.
ApiManagementApiSchemaDocumentValue
The ApiManagementApiSchemaDocument.value choice: sets value.
ApiManagementApiSubscriptionKeyParameterNames
Typed helper for the subscription_key_parameter_names block of azurerm_api_management_api (derived from provider schema).
ApiManagementApiVersionSetVersion
At most one of version_header_name, version_query_name on azurerm_api_management_api_version_set: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementApiVersionSetVersionHeaderName
The ApiManagementApiVersionSetVersion.versionHeaderName choice: sets version_header_name.
ApiManagementApiVersionSetVersionQueryName
The ApiManagementApiVersionSetVersion.versionQueryName choice: sets version_query_name.
ApiManagementApiWsdlSelector
Typed helper for the import.wsdl_selector block of azurerm_api_management_api (derived from provider schema).
ApiManagementAuthorizationServerTokenBodyParameter
Typed helper for the token_body_parameter block of azurerm_api_management_authorization_server (derived from provider schema).
ApiManagementBackendAuthorization
Typed helper for the credentials.authorization block of azurerm_api_management_backend (derived from provider schema).
ApiManagementBackendCircuitBreakerRule
Typed helper for the circuit_breaker_rule block of azurerm_api_management_backend (derived from provider schema).
ApiManagementBackendCredentials
Typed helper for the credentials block of azurerm_api_management_backend (derived from provider schema).
ApiManagementBackendFailureCondition
Typed helper for the circuit_breaker_rule.failure_condition block of azurerm_api_management_backend (derived from provider schema).
ApiManagementBackendProxy
Typed helper for the proxy block of azurerm_api_management_backend (derived from provider schema).
ApiManagementBackendServer
At most one of server_certificate_thumbprints, server_x509_name on the service_fabric_cluster block of azurerm_api_management_backend: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementBackendServerCertificateThumbprints
The ApiManagementBackendServer.serverCertificateThumbprints choice: sets server_certificate_thumbprints.
ApiManagementBackendServerX509Name
Typed helper for the service_fabric_cluster.server_x509_name block of azurerm_api_management_backend (derived from provider schema).
ApiManagementBackendServerX509NameChoice
The ApiManagementBackendServer.serverX509Name choice: sets server_x509_name.
ApiManagementBackendServiceFabricCluster
Typed helper for the service_fabric_cluster block of azurerm_api_management_backend (derived from provider schema).
ApiManagementBackendStatusCodeRange
Typed helper for the circuit_breaker_rule.failure_condition.status_code_range block of azurerm_api_management_backend (derived from provider schema).
ApiManagementBackendThreshold
Exactly one of count, percentage on the circuit_breaker_rule.failure_condition block of azurerm_api_management_backend: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementBackendThresholdCount
The ApiManagementBackendThreshold.count choice: sets count.
ApiManagementBackendThresholdPercentage
The ApiManagementBackendThreshold.percentage choice: sets percentage.
ApiManagementBackendTls
Typed helper for the tls block of azurerm_api_management_backend (derived from provider schema).
ApiManagementCertificate
Typed helper for the certificate block of azurerm_api_management (derived from provider schema).
ApiManagementCertificateSource
Exactly one of data, key_vault_secret_id on azurerm_api_management_certificate: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementCertificateSourceData
The ApiManagementCertificateSource.data choice: sets data.
ApiManagementCertificateSourceKeyVaultSecretId
The ApiManagementCertificateSource.keyVaultSecretId choice: sets key_vault_secret_id.
ApiManagementCustomDomainDeveloperPortal
Typed helper for the developer_portal block of azurerm_api_management_custom_domain (derived from provider schema).
ApiManagementCustomDomainGateway
Typed helper for the gateway block of azurerm_api_management_custom_domain (derived from provider schema).
ApiManagementCustomDomainManagement
Typed helper for the management block of azurerm_api_management_custom_domain (derived from provider schema).
ApiManagementCustomDomainPortal
Typed helper for the portal block of azurerm_api_management_custom_domain (derived from provider schema).
ApiManagementCustomDomainScm
Typed helper for the scm block of azurerm_api_management_custom_domain (derived from provider schema).
ApiManagementDelegation
Typed helper for the delegation block of azurerm_api_management (derived from provider schema).
ApiManagementDeveloperPortal
Typed helper for the hostname_configuration.developer_portal block of azurerm_api_management (derived from provider schema).
ApiManagementDiagnosticBackendRequest
Typed helper for the backend_request block of azurerm_api_management_diagnostic (derived from provider schema).
ApiManagementDiagnosticBackendResponse
Typed helper for the backend_response block of azurerm_api_management_diagnostic (derived from provider schema).
ApiManagementDiagnosticDataMasking
Typed helper for the backend_request.data_masking block of azurerm_api_management_diagnostic (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementDiagnosticFrontendRequest
Typed helper for the frontend_request block of azurerm_api_management_diagnostic (derived from provider schema).
ApiManagementDiagnosticFrontendResponse
Typed helper for the frontend_response block of azurerm_api_management_diagnostic (derived from provider schema).
ApiManagementDiagnosticHeaders
Typed helper for the backend_request.data_masking.headers block of azurerm_api_management_diagnostic (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementDiagnosticQueryParams
Typed helper for the backend_request.data_masking.query_params block of azurerm_api_management_diagnostic (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementGatewayLocationData
Typed helper for the location_data block of azurerm_api_management_gateway (derived from provider schema).
ApiManagementHostnameConfiguration
Typed helper for the hostname_configuration block of azurerm_api_management (derived from provider schema).
ApiManagementIdentity
Typed helper for the identity block of azurerm_api_management (derived from provider schema).
ApiManagementLoggerApplicationInsights
Typed helper for the application_insights block of azurerm_api_management_logger (derived from provider schema).
ApiManagementLoggerConnection
Exactly one of connection_string, endpoint_uri on the eventhub block of azurerm_api_management_logger: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementLoggerConnectionEndpointUri
The ApiManagementLoggerConnection.endpointUri choice: sets endpoint_uri.
ApiManagementLoggerConnectionString
The ApiManagementLoggerConnection.connectionString choice: sets connection_string.
ApiManagementLoggerCredentials
Exactly one of connection_string, instrumentation_key on the application_insights block of azurerm_api_management_logger: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementLoggerCredentialsConnectionString
The ApiManagementLoggerCredentials.connectionString choice: sets connection_string.
ApiManagementLoggerCredentialsInstrumentationKey
The ApiManagementLoggerCredentials.instrumentationKey choice: sets instrumentation_key.
ApiManagementLoggerEventhub
Typed helper for the eventhub block of azurerm_api_management_logger (derived from provider schema).
ApiManagementLoggerTarget
At most one of application_insights, eventhub on azurerm_api_management_logger: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementLoggerTargetApplicationInsights
The ApiManagementLoggerTarget.applicationInsights choice: sets application_insights.
ApiManagementLoggerTargetEventhub
The ApiManagementLoggerTarget.eventhub choice: sets eventhub.
ApiManagementNamedValueFromKeyVault
Typed helper for the value_from_key_vault block of azurerm_api_management_named_value (derived from provider schema).
ApiManagementNamedValueSource
Exactly one of value, value_from_key_vault on azurerm_api_management_named_value: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementNamedValueSourceValue
The ApiManagementNamedValueSource.value choice: sets value.
ApiManagementNamedValueSourceValueFromKeyVault
The ApiManagementNamedValueSource.valueFromKeyVault choice: sets value_from_key_vault.
ApiManagementPolicyXml
Exactly one of xml_content, xml_link on azurerm_api_management_policy: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementPolicyXmlContent
The ApiManagementPolicyXml.xmlContent choice: sets xml_content.
The ApiManagementPolicyXml.xmlLink choice: sets xml_link.
ApiManagementPortal
Typed helper for the hostname_configuration.portal block of azurerm_api_management (derived from provider schema).
ApiManagementProductPolicyXml
At most one of xml_content, xml_link on azurerm_api_management_product_policy: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementProductPolicyXmlContent
The ApiManagementProductPolicyXml.xmlContent choice: sets xml_content.
The ApiManagementProductPolicyXml.xmlLink choice: sets xml_link.
ApiManagementProtocols
Typed helper for the protocols block of azurerm_api_management (derived from provider schema).
ApiManagementProxy
Typed helper for the hostname_configuration.proxy block of azurerm_api_management (derived from provider schema).
ApiManagementScm
Typed helper for the hostname_configuration.scm block of azurerm_api_management (derived from provider schema).
ApiManagementSecurity
Typed helper for the security block of azurerm_api_management (derived from provider schema).
ApiManagementSignIn
Typed helper for the sign_in block of azurerm_api_management (derived from provider schema).
ApiManagementSignUp
Typed helper for the sign_up block of azurerm_api_management (derived from provider schema).
ApiManagementStandaloneGatewaySku
Typed helper for the sku block of azurerm_api_management_standalone_gateway (derived from provider schema).
ApiManagementSubscriptionScope
At most one of api_id, product_id on azurerm_api_management_subscription: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementSubscriptionScopeApiId
The ApiManagementSubscriptionScope.apiId choice: sets api_id.
ApiManagementSubscriptionScopeProductId
The ApiManagementSubscriptionScope.productId choice: sets product_id.
ApiManagementTenantAccess
Typed helper for the tenant_access block of azurerm_api_management (derived from provider schema).
ApiManagementTermsOfService
Typed helper for the sign_up.terms_of_service block of azurerm_api_management (derived from provider schema).
ApiManagementVirtualNetworkConfiguration
Typed helper for the virtual_network_configuration block of azurerm_api_management (derived from provider schema). Shared by every block of this shape in the resource.
ApiManagementWorkspaceApiVersionSetVersion
At most one of version_header_name, version_query_name on azurerm_api_management_workspace_api_version_set: the provider rejects more than one, so each variant sets one of them and a null choice sets none.
ApiManagementWorkspaceApiVersionSetVersionHeaderName
The ApiManagementWorkspaceApiVersionSetVersion.versionHeaderName choice: sets version_header_name.
ApiManagementWorkspaceApiVersionSetVersionQueryName
The ApiManagementWorkspaceApiVersionSetVersion.versionQueryName choice: sets version_query_name.
ApiManagementWorkspaceCertificateSource
Exactly one of certificate_data_base64, key_vault_secret_id on azurerm_api_management_workspace_certificate: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementWorkspaceCertificateSourceCertificateDataBase64
The ApiManagementWorkspaceCertificateSource.certificateDataBase64 choice: sets certificate_data_base64.
ApiManagementWorkspaceCertificateSourceKeyVaultSecretId
The ApiManagementWorkspaceCertificateSource.keyVaultSecretId choice: sets key_vault_secret_id.
ApiManagementWorkspaceNamedValueFromKeyVault
Typed helper for the value_from_key_vault block of azurerm_api_management_workspace_named_value (derived from provider schema).
ApiManagementWorkspaceNamedValueSource
Exactly one of value, value_from_key_vault on azurerm_api_management_workspace_named_value: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementWorkspaceNamedValueSourceValue
The ApiManagementWorkspaceNamedValueSource.value choice: sets value.
ApiManagementWorkspaceNamedValueSourceValueFromKeyVault
The ApiManagementWorkspaceNamedValueSource.valueFromKeyVault choice: sets value_from_key_vault.
ApiManagementWorkspacePolicyXml
Exactly one of xml_content, xml_link on azurerm_api_management_workspace_policy: the provider rejects none and more than one, so each variant sets one of them.
ApiManagementWorkspacePolicyXmlContent
The ApiManagementWorkspacePolicyXml.xmlContent choice: sets xml_content.
The ApiManagementWorkspacePolicyXml.xmlLink choice: sets xml_link.
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.
AzurermApiManagement
Factory wrapper for azurerm_api_management.
AzurermApiManagementApi
Factory wrapper for azurerm_api_management_api.
AzurermApiManagementApiDiagnostic
Factory wrapper for azurerm_api_management_api_diagnostic.
AzurermApiManagementApiOperation
Factory wrapper for azurerm_api_management_api_operation.
AzurermApiManagementApiOperationPolicy
Factory wrapper for azurerm_api_management_api_operation_policy.
AzurermApiManagementApiOperationTag
Factory wrapper for azurerm_api_management_api_operation_tag.
AzurermApiManagementApiPolicy
Factory wrapper for azurerm_api_management_api_policy.
AzurermApiManagementApiRelease
Factory wrapper for azurerm_api_management_api_release.
AzurermApiManagementApiSchema
Factory wrapper for azurerm_api_management_api_schema.
AzurermApiManagementApiTag
Factory wrapper for azurerm_api_management_api_tag.
AzurermApiManagementApiTagDescription
Factory wrapper for azurerm_api_management_api_tag_description.
AzurermApiManagementApiVersionSet
Factory wrapper for azurerm_api_management_api_version_set.
AzurermApiManagementAuthorizationServer
Factory wrapper for azurerm_api_management_authorization_server.
AzurermApiManagementBackend
Factory wrapper for azurerm_api_management_backend.
AzurermApiManagementCertificate
Factory wrapper for azurerm_api_management_certificate.
AzurermApiManagementCustomDomain
Factory wrapper for azurerm_api_management_custom_domain.
AzurermApiManagementDiagnostic
Factory wrapper for azurerm_api_management_diagnostic.
AzurermApiManagementEmailTemplate
Factory wrapper for azurerm_api_management_email_template.
AzurermApiManagementGateway
Factory wrapper for azurerm_api_management_gateway.
AzurermApiManagementGatewayApi
Factory wrapper for azurerm_api_management_gateway_api.
AzurermApiManagementGatewayCertificateAuthority
Factory wrapper for azurerm_api_management_gateway_certificate_authority.
AzurermApiManagementGatewayHostNameConfiguration
Factory wrapper for azurerm_api_management_gateway_host_name_configuration.
AzurermApiManagementGlobalSchema
Factory wrapper for azurerm_api_management_global_schema.
AzurermApiManagementGroup
Factory wrapper for azurerm_api_management_group.
AzurermApiManagementGroupUser
Factory wrapper for azurerm_api_management_group_user.
AzurermApiManagementIdentityProviderAad
Factory wrapper for azurerm_api_management_identity_provider_aad.
AzurermApiManagementIdentityProviderAadb2c
Factory wrapper for azurerm_api_management_identity_provider_aadb2c.
AzurermApiManagementIdentityProviderFacebook
Factory wrapper for azurerm_api_management_identity_provider_facebook.
AzurermApiManagementIdentityProviderGoogle
Factory wrapper for azurerm_api_management_identity_provider_google.
AzurermApiManagementIdentityProviderMicrosoft
Factory wrapper for azurerm_api_management_identity_provider_microsoft.
AzurermApiManagementIdentityProviderTwitter
Factory wrapper for azurerm_api_management_identity_provider_twitter.
AzurermApiManagementLogger
Factory wrapper for azurerm_api_management_logger.
AzurermApiManagementNamedValue
Factory wrapper for azurerm_api_management_named_value.
AzurermApiManagementNotificationRecipientEmail
Factory wrapper for azurerm_api_management_notification_recipient_email.
AzurermApiManagementNotificationRecipientUser
Factory wrapper for azurerm_api_management_notification_recipient_user.
AzurermApiManagementOpenidConnectProvider
Factory wrapper for azurerm_api_management_openid_connect_provider.
AzurermApiManagementPolicy
Factory wrapper for azurerm_api_management_policy.
AzurermApiManagementPolicyFragment
Factory wrapper for azurerm_api_management_policy_fragment.
AzurermApiManagementProduct
Factory wrapper for azurerm_api_management_product.
AzurermApiManagementProductApi
Factory wrapper for azurerm_api_management_product_api.
AzurermApiManagementProductGroup
Factory wrapper for azurerm_api_management_product_group.
AzurermApiManagementProductPolicy
Factory wrapper for azurerm_api_management_product_policy.
AzurermApiManagementProductTag
Factory wrapper for azurerm_api_management_product_tag.
AzurermApiManagementRedisCache
Factory wrapper for azurerm_api_management_redis_cache.
AzurermApiManagementStandaloneGateway
Factory wrapper for azurerm_api_management_standalone_gateway.
AzurermApiManagementSubscription
Factory wrapper for azurerm_api_management_subscription.
AzurermApiManagementTag
Factory wrapper for azurerm_api_management_tag.
AzurermApiManagementUser
Factory wrapper for azurerm_api_management_user.
AzurermApiManagementWorkspace
Factory wrapper for azurerm_api_management_workspace.
AzurermApiManagementWorkspaceApiVersionSet
Factory wrapper for azurerm_api_management_workspace_api_version_set.
AzurermApiManagementWorkspaceCertificate
Factory wrapper for azurerm_api_management_workspace_certificate.
AzurermApiManagementWorkspaceNamedValue
Factory wrapper for azurerm_api_management_workspace_named_value.
AzurermApiManagementWorkspacePolicy
Factory wrapper for azurerm_api_management_workspace_policy.
AzurermApiManagementWorkspacePolicyFragment
Factory wrapper for azurerm_api_management_workspace_policy_fragment.
AzurermBackend
terraform { backend "azurerm" { ... } } configuration.
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.
DataAzurermApiManagement
Factory wrapper for azurerm_api_management.
DataAzurermApiManagementApi
Factory wrapper for azurerm_api_management_api.
DataAzurermApiManagementApiVersionSet
Factory wrapper for azurerm_api_management_api_version_set.
DataAzurermApiManagementGateway
Factory wrapper for azurerm_api_management_gateway.
DataAzurermApiManagementGatewayHostNameConfiguration
Factory wrapper for azurerm_api_management_gateway_host_name_configuration.
DataAzurermApiManagementGroup
Factory wrapper for azurerm_api_management_group.
DataAzurermApiManagementProduct
Factory wrapper for azurerm_api_management_product.
DataAzurermApiManagementSubscription
Factory wrapper for azurerm_api_management_subscription.
DataAzurermApiManagementUser
Factory wrapper for azurerm_api_management_user.
DataAzurermApiManagementWorkspace
Factory wrapper for azurerm_api_management_workspace.
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

ApiManagementApiBearerTokenSendingMethods
bearer_token_sending_methods — derived from the provider schema description.
ApiManagementApiContentFormat
content_format — derived from the provider schema description.
ApiManagementApiDiagnosticHttpCorrelationProtocol
Api Management Api Diagnostic Http Correlation enum for http_correlation_protocol.
ApiManagementApiDiagnosticIdentifier
Api Management Api Diagnostic enum for identifier.
ApiManagementApiDiagnosticMode
mode — derived from the provider schema description.
ApiManagementApiDiagnosticOperationNameFormat
Api Management Api Diagnostic Operation Name enum for operation_name_format.
ApiManagementApiDiagnosticVerbosity
Api Management Api Diagnostic enum for verbosity.
ApiManagementApiProtocols
Api Management Api enum for protocols.
ApiManagementApiType
Api Management Api enum for api_type.
ApiManagementApiVersionSetVersioningScheme
Api Management Api Version Set Versioning enum for versioning_scheme.
ApiManagementAuthorizationServerAuthorizationMethods
Api Management Authorization Server Authorization enum for authorization_methods.
ApiManagementAuthorizationServerBearerTokenSendingMethods
Api Management Authorization Server Bearer Token Sending enum for bearer_token_sending_methods.
ApiManagementAuthorizationServerClientAuthenticationMethod
Api Management Authorization Server Client Authentication enum for client_authentication_method.
ApiManagementAuthorizationServerGrantTypes
Api Management Authorization Server Grant enum for grant_types.
ApiManagementBackendProtocol
Api Management Backend enum for protocol.
ApiManagementDiagnosticHttpCorrelationProtocol
Api Management Diagnostic Http Correlation enum for http_correlation_protocol.
ApiManagementDiagnosticIdentifier
Api Management Diagnostic enum for identifier.
ApiManagementDiagnosticMode
mode — derived from the provider schema description.
ApiManagementDiagnosticOperationNameFormat
Api Management Diagnostic Operation Name enum for operation_name_format.
ApiManagementDiagnosticVerbosity
Api Management Diagnostic enum for verbosity.
ApiManagementEmailTemplateName
Api Management Email Template enum for template_name.
ApiManagementGlobalSchemaType
Api Management Global Schema enum for type.
ApiManagementGroupType
Api Management Group enum for type.
ApiManagementNotificationRecipientEmailNotificationType
Api Management Notification Recipient Email Notification enum for notification_type.
ApiManagementNotificationRecipientUserNotificationType
Api Management Notification Recipient User Notification enum for notification_type.
ApiManagementPolicyFragmentFormat
Api Management Policy Fragment enum for format.
ApiManagementStandaloneGatewaySkuName
name — derived from the provider schema description.
ApiManagementStandaloneGatewayVirtualNetworkType
Api Management Standalone Gateway Virtual Network enum for virtual_network_type.
ApiManagementStoreName
store_name — derived from the provider schema description.
ApiManagementSubscriptionState
Api Management Subscription enum for state.
ApiManagementUserConfirmation
Api Management User enum for confirmation.
ApiManagementUserState
Api Management User enum for state.
ApiManagementVirtualNetworkType
Api Management Virtual Network enum for virtual_network_type.
ApiManagementWorkspaceApiVersionSetVersioningScheme
Api Management Workspace Api Version Set Versioning enum for versioning_scheme.
ApiManagementWorkspacePolicyFragmentXmlFormat
Api Management Workspace Policy Fragment Xml enum for xml_format.
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.