apigatewayv2 library

AWS API Gateway V2 (HTTP and WebSocket APIs).

Classes

Apigatewayv2ApiCorsConfiguration
Typed helper for the cors_configuration block of aws_apigatewayv2_api (derived from provider schema).
Apigatewayv2AuthorizerJwtConfiguration
Typed helper for the jwt_configuration block of aws_apigatewayv2_authorizer (derived from provider schema).
Apigatewayv2DomainNameConfiguration
Typed helper for the domain_name_configuration block of aws_apigatewayv2_domain_name (derived from provider schema).
Apigatewayv2DomainNameMutualTlsAuthentication
Typed helper for the mutual_tls_authentication block of aws_apigatewayv2_domain_name (derived from provider schema).
Apigatewayv2IntegrationResponseParameters
Typed helper for the response_parameters block of aws_apigatewayv2_integration (derived from provider schema).
Apigatewayv2IntegrationTlsConfig
Typed helper for the tls_config block of aws_apigatewayv2_integration (derived from provider schema).
Apigatewayv2RouteRequestParameter
Typed helper for the request_parameter block of aws_apigatewayv2_route (derived from provider schema).
Apigatewayv2RoutingRuleAction
Typed helper for the action block of aws_apigatewayv2_routing_rule (derived from provider schema).
Apigatewayv2RoutingRuleAnyOf
Typed helper for the condition.match_headers.any_of block of aws_apigatewayv2_routing_rule (derived from provider schema).
Apigatewayv2RoutingRuleCondition
Typed helper for the condition block of aws_apigatewayv2_routing_rule (derived from provider schema).
Apigatewayv2RoutingRuleInvokeApi
Typed helper for the action.invoke_api block of aws_apigatewayv2_routing_rule (derived from provider schema).
Apigatewayv2RoutingRuleMatchBasePaths
Typed helper for the condition.match_base_paths block of aws_apigatewayv2_routing_rule (derived from provider schema).
Apigatewayv2RoutingRuleMatchHeaders
Typed helper for the condition.match_headers block of aws_apigatewayv2_routing_rule (derived from provider schema).
Apigatewayv2StageAccessLogSettings
Typed helper for the access_log_settings block of aws_apigatewayv2_stage (derived from provider schema).
Apigatewayv2StageDefaultRouteSettings
Typed helper for the default_route_settings block of aws_apigatewayv2_stage (derived from provider schema).
Apigatewayv2StageRouteSettings
Typed helper for the route_settings block of aws_apigatewayv2_stage (derived from provider schema).
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.
AwsApigatewayv2Api
Factory wrapper for aws_apigatewayv2_api.
AwsApigatewayv2ApiMapping
Factory wrapper for aws_apigatewayv2_api_mapping.
AwsApigatewayv2Authorizer
Factory wrapper for aws_apigatewayv2_authorizer.
AwsApigatewayv2Deployment
Factory wrapper for aws_apigatewayv2_deployment.
AwsApigatewayv2DomainName
Factory wrapper for aws_apigatewayv2_domain_name.
AwsApigatewayv2Integration
Factory wrapper for aws_apigatewayv2_integration.
AwsApigatewayv2IntegrationResponse
Factory wrapper for aws_apigatewayv2_integration_response.
AwsApigatewayv2Model
Factory wrapper for aws_apigatewayv2_model.
AwsApigatewayv2Route
Factory wrapper for aws_apigatewayv2_route.
AwsApigatewayv2RouteResponse
Factory wrapper for aws_apigatewayv2_route_response.
AwsApigatewayv2RoutingRule
Factory wrapper for aws_apigatewayv2_routing_rule.
AwsApigatewayv2Stage
Factory wrapper for aws_apigatewayv2_stage.
Factory wrapper for aws_apigatewayv2_vpc_link.
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.
DataAwsApigatewayv2Api
Factory wrapper for aws_apigatewayv2_api.
DataAwsApigatewayv2Apis
Factory wrapper for aws_apigatewayv2_apis.
DataAwsApigatewayv2Export
Factory wrapper for aws_apigatewayv2_export.
Factory wrapper for aws_apigatewayv2_vpc_link.
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, 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 StackSynth.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

Apigatewayv2ApiIpAddressType
Apigatewayv2 Api Ip Address enum for ip_address_type.
Apigatewayv2ApiKeySelectionExpression
Apigatewayv2 Api Key Selection enum for api_key_selection_expression.
Apigatewayv2ApiProtocolType
Apigatewayv2 Api Protocol enum for protocol_type.
Apigatewayv2AuthorizerPayloadFormatVersion
Apigatewayv2 Authorizer Payload Format enum for authorizer_payload_format_version.
Apigatewayv2AuthorizerType
Apigatewayv2 Authorizer enum for authorizer_type.
Apigatewayv2DomainNameEndpointType
endpoint_type — derived from the provider schema description.
Apigatewayv2DomainNameIpAddressType
ip_address_type — derived from the provider schema description.
Apigatewayv2DomainNameRoutingMode
Apigatewayv2 Domain Name Routing enum for routing_mode.
Apigatewayv2DomainNameSecurityPolicy
security_policy — derived from the provider schema description.
Apigatewayv2IntegrationConnectionType
Apigatewayv2 Integration Connection enum for connection_type.
Apigatewayv2IntegrationContentHandlingStrategy
Apigatewayv2 Integration Content Handling enum for content_handling_strategy.
Apigatewayv2IntegrationPassthroughBehavior
Apigatewayv2 Integration Passthrough enum for passthrough_behavior.
Apigatewayv2IntegrationPayloadFormatVersion
Apigatewayv2 Integration Payload Format enum for payload_format_version.
Apigatewayv2IntegrationResponseContentHandlingStrategy
Apigatewayv2 Integration Response Content Handling enum for content_handling_strategy.
Apigatewayv2IntegrationType
Apigatewayv2 Integration enum for integration_type.
Apigatewayv2RouteAuthorizationType
Apigatewayv2 Route Authorization enum for authorization_type.
Apigatewayv2StageLoggingLevel
logging_level — 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").

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.