vpn library

Azure Resource Manager vpn 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.
AzurermVpnGateway
Factory wrapper for azurerm_vpn_gateway.
AzurermVpnGatewayConnection
Factory wrapper for azurerm_vpn_gateway_connection.
AzurermVpnGatewayNatRule
Factory wrapper for azurerm_vpn_gateway_nat_rule.
AzurermVpnServerConfiguration
Factory wrapper for azurerm_vpn_server_configuration.
AzurermVpnServerConfigurationPolicyGroup
Factory wrapper for azurerm_vpn_server_configuration_policy_group.
AzurermVpnSite
Factory wrapper for azurerm_vpn_site.
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.
DataAzurermVpnGateway
Factory wrapper for azurerm_vpn_gateway.
DataAzurermVpnServerConfiguration
Factory wrapper for azurerm_vpn_server_configuration.
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.
VpnGatewayBgpSettings
Typed helper for the bgp_settings block of azurerm_vpn_gateway (derived from provider schema).
VpnGatewayConnectionCustomBgpAddress
Typed helper for the vpn_link.custom_bgp_address block of azurerm_vpn_gateway_connection (derived from provider schema).
VpnGatewayConnectionIpsecPolicy
Typed helper for the vpn_link.ipsec_policy block of azurerm_vpn_gateway_connection (derived from provider schema).
VpnGatewayConnectionPropagatedRouteTable
Typed helper for the routing.propagated_route_table block of azurerm_vpn_gateway_connection (derived from provider schema).
VpnGatewayConnectionRouting
Typed helper for the routing block of azurerm_vpn_gateway_connection (derived from provider schema).
VpnGatewayConnectionTrafficSelectorPolicy
Typed helper for the traffic_selector_policy block of azurerm_vpn_gateway_connection (derived from provider schema).
Typed helper for the vpn_link block of azurerm_vpn_gateway_connection (derived from provider schema).
VpnGatewayInstance0BgpPeeringAddress
Typed helper for the bgp_settings.instance_0_bgp_peering_address block of azurerm_vpn_gateway (derived from provider schema).
VpnGatewayInstance1BgpPeeringAddress
Typed helper for the bgp_settings.instance_1_bgp_peering_address block of azurerm_vpn_gateway (derived from provider schema).
VpnGatewayNatRuleExternalMapping
Typed helper for the external_mapping block of azurerm_vpn_gateway_nat_rule (derived from provider schema).
VpnGatewayNatRuleInternalMapping
Typed helper for the internal_mapping block of azurerm_vpn_gateway_nat_rule (derived from provider schema).
VpnServerConfigurationAzureActiveDirectoryAuthentication
Typed helper for the azure_active_directory_authentication block of azurerm_vpn_server_configuration (derived from provider schema).
VpnServerConfigurationClientRevokedCertificate
Typed helper for the client_revoked_certificate block of azurerm_vpn_server_configuration (derived from provider schema).
VpnServerConfigurationClientRootCertificate
Typed helper for the client_root_certificate block of azurerm_vpn_server_configuration (derived from provider schema).
VpnServerConfigurationIpsecPolicy
Typed helper for the ipsec_policy block of azurerm_vpn_server_configuration (derived from provider schema).
VpnServerConfigurationPolicyGroupPolicy
Typed helper for the policy block of azurerm_vpn_server_configuration_policy_group (derived from provider schema).
VpnServerConfigurationRadius
Typed helper for the radius block of azurerm_vpn_server_configuration (derived from provider schema).
VpnServerConfigurationRadiusClientRootCertificate
Typed helper for the radius.client_root_certificate block of azurerm_vpn_server_configuration (derived from provider schema).
VpnServerConfigurationServer
Typed helper for the radius.server block of azurerm_vpn_server_configuration (derived from provider schema).
VpnServerConfigurationServerRootCertificate
Typed helper for the radius.server_root_certificate block of azurerm_vpn_server_configuration (derived from provider schema).
VpnSiteBgp
Typed helper for the link.bgp block of azurerm_vpn_site (derived from provider schema).
Typed helper for the link block of azurerm_vpn_site (derived from provider schema).
VpnSiteO365Policy
Typed helper for the o365_policy block of azurerm_vpn_site (derived from provider schema).
VpnSiteTrafficCategory
Typed helper for the o365_policy.traffic_category block of azurerm_vpn_site (derived from provider schema).

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, ...).
VpnGatewayConnectionDhGroup
dh_group — derived from the provider schema description.
VpnGatewayConnectionEncryptionAlgorithm
encryption_algorithm — derived from the provider schema description.
VpnGatewayConnectionIkeEncryptionAlgorithm
ike_encryption_algorithm — derived from the provider schema description.
VpnGatewayConnectionIkeIntegrityAlgorithm
ike_integrity_algorithm — derived from the provider schema description.
VpnGatewayConnectionIntegrityAlgorithm
integrity_algorithm — derived from the provider schema description.
VpnGatewayConnectionMode
connection_mode — derived from the provider schema description.
VpnGatewayConnectionPfsGroup
pfs_group — derived from the provider schema description.
VpnGatewayConnectionProtocol
protocol — derived from the provider schema description.
VpnGatewayNatRuleIpConfigurationId
Vpn Gateway Nat Rule Ip Configuration enum for ip_configuration_id.
VpnGatewayNatRuleMode
Vpn Gateway Nat Rule enum for mode.
VpnGatewayNatRuleType
Vpn Gateway Nat Rule enum for type.
VpnGatewayRoutingPreference
Vpn Gateway Routing enum for routing_preference.
VpnServerConfigurationDhGroup
dh_group — derived from the provider schema description.
VpnServerConfigurationIkeEncryption
ike_encryption — derived from the provider schema description.
VpnServerConfigurationIkeIntegrity
ike_integrity — derived from the provider schema description.
VpnServerConfigurationIpsecEncryption
ipsec_encryption — derived from the provider schema description.
VpnServerConfigurationIpsecIntegrity
ipsec_integrity — derived from the provider schema description.
VpnServerConfigurationPfsGroup
pfs_group — derived from the provider schema description.
VpnServerConfigurationPolicyGroupType
type — derived from the provider schema description.
VpnServerConfigurationVpnAuthenticationTypes
Vpn Server Configuration Vpn Authentication enum for vpn_authentication_types.
VpnServerConfigurationVpnProtocols
Vpn Server Configuration Vpn enum for vpn_protocols.

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.