api_gateway library

Classes

ApiGatewayDocumentationPartLocation: Typed helper for the location block of aws_api_gateway_documentation_part (derived from provider schema).
ApiGatewayDomainNameEndpointConfiguration: Typed helper for the endpoint_configuration block of aws_api_gateway_domain_name (derived from provider schema).
ApiGatewayDomainNameMutualTlsAuthentication: Typed helper for the mutual_tls_authentication block of aws_api_gateway_domain_name (derived from provider schema).
ApiGatewayIntegrationTlsConfig: Typed helper for the tls_config block of aws_api_gateway_integration (derived from provider schema).
ApiGatewayMethodSettings: Typed helper for the settings block of aws_api_gateway_method_settings (derived from provider schema).
ApiGatewayRestApiEndpointConfiguration: Typed helper for the endpoint_configuration block of aws_api_gateway_rest_api (derived from provider schema).
ApiGatewayStageAccessLogSettings: Typed helper for the access_log_settings block of aws_api_gateway_stage (derived from provider schema).
ApiGatewayStageCanarySettings: Typed helper for the canary_settings block of aws_api_gateway_stage (derived from provider schema).
ApiGatewayUsagePlanApiStages: Typed helper for the api_stages block of aws_api_gateway_usage_plan (derived from provider schema).
ApiGatewayUsagePlanQuotaSettings: Typed helper for the quota_settings block of aws_api_gateway_usage_plan (derived from provider schema).
ApiGatewayUsagePlanThrottle: Typed helper for the api_stages.throttle block of aws_api_gateway_usage_plan (derived from provider schema).
ApiGatewayUsagePlanThrottleSettings: Typed helper for the throttle_settings block of aws_api_gateway_usage_plan (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.
AwsApiGatewayAccount: Factory wrapper for aws_api_gateway_account.
AwsApiGatewayApiKey: Factory wrapper for aws_api_gateway_api_key.
AwsApiGatewayAuthorizer: Factory wrapper for aws_api_gateway_authorizer.
AwsApiGatewayBasePathMapping: Factory wrapper for aws_api_gateway_base_path_mapping.
AwsApiGatewayClientCertificate: Factory wrapper for aws_api_gateway_client_certificate.
AwsApiGatewayDeployment: Factory wrapper for aws_api_gateway_deployment.
AwsApiGatewayDocumentationPart: Factory wrapper for aws_api_gateway_documentation_part.
AwsApiGatewayDocumentationVersion: Factory wrapper for aws_api_gateway_documentation_version.
AwsApiGatewayDomainName: Factory wrapper for aws_api_gateway_domain_name.
AwsApiGatewayDomainNameAccessAssociation: Factory wrapper for aws_api_gateway_domain_name_access_association.
AwsApiGatewayGatewayResponse: Factory wrapper for aws_api_gateway_gateway_response.
AwsApiGatewayIntegration: Factory wrapper for aws_api_gateway_integration.
AwsApiGatewayIntegrationResponse: Factory wrapper for aws_api_gateway_integration_response.
AwsApiGatewayMethod: Factory wrapper for aws_api_gateway_method.
AwsApiGatewayMethodResponse: Factory wrapper for aws_api_gateway_method_response.
AwsApiGatewayMethodSettings: Factory wrapper for aws_api_gateway_method_settings.
AwsApiGatewayModel: Factory wrapper for aws_api_gateway_model.
AwsApiGatewayRequestValidator: Factory wrapper for aws_api_gateway_request_validator.
AwsApiGatewayResource: Factory wrapper for aws_api_gateway_resource.
AwsApiGatewayRestApi: Factory wrapper for aws_api_gateway_rest_api.
AwsApiGatewayRestApiPolicy: Factory wrapper for aws_api_gateway_rest_api_policy.
AwsApiGatewayRestApiPut: Factory wrapper for aws_api_gateway_rest_api_put.
AwsApiGatewayStage: Factory wrapper for aws_api_gateway_stage.
AwsApiGatewayUsagePlan: Factory wrapper for aws_api_gateway_usage_plan.
AwsApiGatewayUsagePlanKey: Factory wrapper for aws_api_gateway_usage_plan_key.
AwsApiGatewayVpcLink: Factory wrapper for aws_api_gateway_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.
DataAwsApiGatewayApiKey: Factory wrapper for aws_api_gateway_api_key.
DataAwsApiGatewayApiKeys: Factory wrapper for aws_api_gateway_api_keys.
DataAwsApiGatewayAuthorizer: Factory wrapper for aws_api_gateway_authorizer.
DataAwsApiGatewayAuthorizers: Factory wrapper for aws_api_gateway_authorizers.
DataAwsApiGatewayDomainName: Factory wrapper for aws_api_gateway_domain_name.
DataAwsApiGatewayExport: Factory wrapper for aws_api_gateway_export.
DataAwsApiGatewayResource: Factory wrapper for aws_api_gateway_resource.
DataAwsApiGatewayRestApi: Factory wrapper for aws_api_gateway_rest_api.
DataAwsApiGatewaySdk: Factory wrapper for aws_api_gateway_sdk.
DataAwsApiGatewayVpcLink: Factory wrapper for aws_api_gateway_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

ApiGatewayAuthorizerType: Api Gateway Authorizer enum for type.
ApiGatewayDomainNameAccessAssociationSourceType: Api Gateway Domain Name Access Association Source enum for access_association_source_type.
ApiGatewayDomainNameEndpointAccessMode: Api Gateway Domain Name Endpoint Access enum for endpoint_access_mode.
ApiGatewayDomainNameIpAddressType: ip_address_type — derived from the provider schema description.
ApiGatewayDomainNameRoutingMode: Api Gateway Domain Name Routing enum for routing_mode.
ApiGatewayDomainNameSecurityPolicy: Api Gateway Domain Name Security enum for security_policy.
ApiGatewayDomainNameTypes: types — derived from the provider schema description.
ApiGatewayIntegrationConnectionType: Api Gateway Integration Connection enum for connection_type.
ApiGatewayIntegrationPassthroughBehavior: Api Gateway Integration Passthrough enum for passthrough_behavior.
ApiGatewayIntegrationResponseTransferMode: Api Gateway Integration Response Transfer enum for response_transfer_mode.
ApiGatewayIntegrationType: Api Gateway Integration enum for type.
ApiGatewayMethodSettingsLoggingLevel: logging_level — derived from the provider schema description.
ApiGatewayMethodSettingsUnauthorizedCacheControlHeaderStrategy: unauthorized_cache_control_header_strategy — derived from the provider schema description.
ApiGatewayRestApiEndpointAccessMode: Api Gateway Rest Api Endpoint Access enum for endpoint_access_mode.
ApiGatewayRestApiIpAddressType: ip_address_type — derived from the provider schema description.
ApiGatewayRestApiKeySource: Api Gateway Rest Api Key enum for api_key_source.
ApiGatewayRestApiPutRestApiMode: Api Gateway Rest Api Put Rest Api enum for put_rest_api_mode.
ApiGatewayRestApiSecurityPolicy: Api Gateway Rest Api Security enum for security_policy.
ApiGatewayRestApiTypes: types — derived from the provider schema description.
ApiGatewayStageCacheClusterSize: Api Gateway Stage Cache Cluster enum for cache_cluster_size.
ApiGatewayUsagePlanPeriod: period — 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)?}) → 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.

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.

api_gateway library

Classes

Enums

Extension Types

Extensions

Constants

Functions

Exceptions / Errors

terradart_aws package

api_gateway library