Aws/apigatewayv2

@swamp/aws/apigatewayv2v2026.06.12.1· 3d agoMODELS

01README

AWS APIGATEWAYV2 infrastructure models

02Release Notes

Added: stage

03Models13

@swamp/aws/apigatewayv2/apiv2026.06.09.1api.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
RouteSelectionExpression?	string	no	The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
Body?	record	no	The OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
BodyS3Location?	object	no	The S3 location of an OpenAPI definition. Supported only for HTTP APIs. To import an HTTP API, you must specify a Body or BodyS3Location. If you specify a Body or BodyS3Location, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer or AWS::ApiGatewayV2::Route. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
BasePath?	string	no	Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see [Set the OpenAPI basePath Property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.html). Supported only for HTTP APIs.
CredentialsArn?	string	no	This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Suppor
CorsConfiguration?	object	no	A CORS configuration. Supported only for HTTP APIs. See [Configuring CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html) for more information.
RouteKey?	string	no	This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
Target?	string	no	This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
FailOnWarnings?	boolean	no	Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
Description?	string	no	The description of the API.
DisableExecuteApiEndpoint?	boolean	no	Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
DisableSchemaValidation?	boolean	no	Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Name?	string	no	The name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
Version?	string	no	A version identifier for the API.
ProtocolType?	string	no	The API protocol. Valid values are WEBSOCKET or HTTP. Required unless you specify an OpenAPI definition for Body or S3BodyLocation.
Tags?	record	no	The collection of tags. Each tag element is associated with a given resource.
ApiKeySelectionExpression?	string	no	An API key selection expression. Supported only for WebSocket APIs. See [API Key Selection Expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions).
IpAddressType?	string	no	The IP address types that can invoke the API. Use ipv4 to allow only IPv4 addresses to invoke your API, or use dualstack to allow both IPv4 and IPv6 addresses to invoke your API. Don’t use IP address type for an HTTP API based on an OpenAPI specification. Instead, specify the IP address type in the OpenAPI specification.

fn create()

Create a ApiGatewayV2 Api

fn get(identifier: string)

Get a ApiGatewayV2 Api

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Api

fn update()

Update a ApiGatewayV2 Api

fn delete(identifier: string)

Delete a ApiGatewayV2 Api

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Api

fn sync()

Sync ApiGatewayV2 Api state from AWS

Resources

state(infinite)— ApiGatewayV2 Api resource state

@swamp/aws/apigatewayv2/api-mappingv2026.06.09.1api_mapping.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
DomainName	string	yes	The domain name.
Stage	string	yes	The API stage.
ApiMappingKey?	string	no	The API mapping key.
ApiId	string	yes	The API identifier.

fn create()

Create a ApiGatewayV2 ApiMapping

fn get(identifier: string)

Get a ApiGatewayV2 ApiMapping

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 ApiMapping

fn update()

Update a ApiGatewayV2 ApiMapping

fn delete(identifier: string)

Delete a ApiGatewayV2 ApiMapping

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 ApiMapping

fn sync()

Sync ApiGatewayV2 ApiMapping state from AWS

Resources

state(infinite)— ApiGatewayV2 ApiMapping resource state

@swamp/aws/apigatewayv2/authorizerv2026.06.08.1authorizer.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
IdentityValidationExpression?	string	no	This parameter is not used.
AuthorizerUri?	string	no	The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI
AuthorizerCredentialsArn?	string	no	Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
AuthorizerType	string	yes	The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
IdentitySource?	array	no	The identity source for which authorization is requested. For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs,
JwtConfiguration?	object	no	The JWTConfiguration property specifies the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
AuthorizerResultTtlInSeconds?	number	no	The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
AuthorizerPayloadFormatVersion?	string	no	Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
EnableSimpleResponses?	boolean	no	Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see [Working with Lambda authorizers for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html).
ApiId	string	yes	The API identifier.
Name	string	yes	The name of the authorizer.

fn create()

Create a ApiGatewayV2 Authorizer

fn get(identifier: string)

Get a ApiGatewayV2 Authorizer

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Authorizer

fn update()

Update a ApiGatewayV2 Authorizer

fn delete(identifier: string)

Delete a ApiGatewayV2 Authorizer

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Authorizer

fn sync()

Sync ApiGatewayV2 Authorizer state from AWS

Resources

state(infinite)— ApiGatewayV2 Authorizer resource state

@swamp/aws/apigatewayv2/deploymentv2026.06.08.1deployment.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Description?	string	no	The description for the deployment resource.
StageName?	string	no	The name of an existing stage to associate with the deployment.
ApiId	string	yes	The API identifier.

fn create()

Create a ApiGatewayV2 Deployment

fn get(identifier: string)

Get a ApiGatewayV2 Deployment

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Deployment

fn update()

Update a ApiGatewayV2 Deployment

fn delete(identifier: string)

Delete a ApiGatewayV2 Deployment

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Deployment

fn sync()

Sync ApiGatewayV2 Deployment state from AWS

Resources

state(infinite)— ApiGatewayV2 Deployment resource state

@swamp/aws/apigatewayv2/domain-namev2026.06.09.1domain_name.ts

Global Arguments

Argument	Type	Required	Description
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
MutualTlsAuthentication?	object	no	The mutual TLS authentication configuration for a custom domain name.
DomainName	string	yes	The custom domain name for your API in Amazon API Gateway. Uppercase letters and the underscore ( _) character are not supported.
DomainNameConfigurations?	array	no	The domain name configurations.
RoutingMode?	enum	no	The routing mode API Gateway uses to route traffic to your APIs.
Tags?	record	no	The collection of tags associated with a domain name.

fn create()

Create a ApiGatewayV2 DomainName

fn get(identifier: string)

Get a ApiGatewayV2 DomainName

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 DomainName

fn update()

Update a ApiGatewayV2 DomainName

fn delete(identifier: string)

Delete a ApiGatewayV2 DomainName

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 DomainName

fn sync()

Sync ApiGatewayV2 DomainName state from AWS

Resources

state(infinite)— ApiGatewayV2 DomainName resource state

@swamp/aws/apigatewayv2/integrationv2026.06.08.1integration.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
ApiId	string	yes	The API identifier.
ConnectionId?	string	no	The ID of the VPC link for a private integration. Supported only for HTTP APIs.
ConnectionType?	string	no	The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
ContentHandlingStrategy?	string	no	Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT.
CredentialsArn?	string	no	Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam:::user/. To use resource-based permissions on supported AWS services, don't specify this parameter.
Description?	string	no	The description of the integration.
IntegrationMethod?	string	no	Specifies the integration's HTTP method type.
IntegrationSubtype?	string	no	Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke.
IntegrationType	string	yes	The integration type of an integration.
IntegrationUri?	string	no	For a Lambda integration, specify the URI of a Lambda function. For an HTTP integration, specify a fully-qualified URL. For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service.
PassthroughBehavior?	string	no	Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
PayloadFormatVersion?	string	no	Specifies the format of the payload sent to an integration. Required for HTTP APIs. For HTTP APIs, supported values for Lambda proxy integrations are 1.0 and 2.0 For all other integrations, 1.0 is the only supported value.
RequestParameters?	record	no	A key-value map specifying parameters.
RequestTemplates?	record	no	A map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client.
ResponseParameters?	record	no	Parameters that transform the HTTP response from a backend integration before returning the response to clients. Supported only for HTTP APIs.
TemplateSelectionExpression?	string	no	The template selection expression for the integration. Supported only for WebSocket APIs.
TimeoutInMillis?	number	no	Custom timeout between 50 and 29000 milliseconds for WebSocket APIs and between 50 and 30000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
TlsConfig?	object	no	The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.

fn create()

Create a ApiGatewayV2 Integration

fn get(identifier: string)

Get a ApiGatewayV2 Integration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Integration

fn update()

Update a ApiGatewayV2 Integration

fn delete(identifier: string)

Delete a ApiGatewayV2 Integration

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Integration

fn sync()

Sync ApiGatewayV2 Integration state from AWS

Resources

state(infinite)— ApiGatewayV2 Integration resource state

@swamp/aws/apigatewayv2/integration-responsev2026.06.08.1integration_response.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
ResponseTemplates?	record	no	The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
TemplateSelectionExpression?	string	no	The template selection expression for the integration response. Supported only for WebSocket APIs.
ResponseParameters?	record	no	A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern
ContentHandlingStrategy?	string	no	Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors: CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response
IntegrationId	string	yes	The integration ID.
IntegrationResponseKey	string	yes	The integration response key.
ApiId	string	yes	The API identifier.

fn create()

Create a ApiGatewayV2 IntegrationResponse

fn get(identifier: string)

Get a ApiGatewayV2 IntegrationResponse

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 IntegrationResponse

fn update()

Update a ApiGatewayV2 IntegrationResponse

fn delete(identifier: string)

Delete a ApiGatewayV2 IntegrationResponse

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 IntegrationResponse

fn sync()

Sync ApiGatewayV2 IntegrationResponse state from AWS

Resources

state(infinite)— ApiGatewayV2 IntegrationResponse resource state

@swamp/aws/apigatewayv2/modelv2026.06.08.1model.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Description?	string	no	The description of the model.
ContentType?	string	no	The content-type for the model, for example, "application/json".
Schema	record	yes	The schema for the model. For application/json models, this should be JSON schema draft 4 model.
ApiId	string	yes	The API identifier.
Name	string	yes	The name of the model.

fn create()

Create a ApiGatewayV2 Model

fn get(identifier: string)

Get a ApiGatewayV2 Model

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Model

fn update()

Update a ApiGatewayV2 Model

fn delete(identifier: string)

Delete a ApiGatewayV2 Model

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Model

fn sync()

Sync ApiGatewayV2 Model state from AWS

Resources

state(infinite)— ApiGatewayV2 Model resource state

@swamp/aws/apigatewayv2/routev2026.06.08.1route.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
RouteResponseSelectionExpression?	string	no	The route response selection expression for the route. Supported only for WebSocket APIs.
RequestModels?	record	no	The request models for the route. Supported only for WebSocket APIs.
OperationName?	string	no	The operation name for the route.
AuthorizationScopes?	array	no	The authorization scopes supported by this route.
ApiKeyRequired?	boolean	no	Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
RouteKey	string	yes	The route key for the route. For HTTP APIs, the route key can be either $default, or a combination of an HTTP method and resource path, for example, GET /pets.
AuthorizationType?	string	no	The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
ModelSelectionExpression?	string	no	The model selection expression for the route. Supported only for WebSocket APIs.
ApiId	string	yes	The API identifier.
RequestParameters?	record	no	The request parameters for the route. Supported only for WebSocket APIs.
Target?	string	no	The target for the route.
AuthorizerId?	string	no	The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

fn create()

Create a ApiGatewayV2 Route

fn get(identifier: string)

Get a ApiGatewayV2 Route

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Route

fn update()

Update a ApiGatewayV2 Route

fn delete(identifier: string)

Delete a ApiGatewayV2 Route

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Route

fn sync()

Sync ApiGatewayV2 Route state from AWS

Resources

state(infinite)— ApiGatewayV2 Route resource state

@swamp/aws/apigatewayv2/route-responsev2026.06.08.1route_response.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
RouteResponseKey	string	yes	The route response key.
RouteId	string	yes	The route ID.
ModelSelectionExpression?	string	no	The model selection expression for the route response. Supported only for WebSocket APIs.
ApiId	string	yes	The API identifier.
ResponseModels?	record	no	The response models for the route response.

fn create()

Create a ApiGatewayV2 RouteResponse

fn get(identifier: string)

Get a ApiGatewayV2 RouteResponse

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 RouteResponse

fn update()

Update a ApiGatewayV2 RouteResponse

fn delete(identifier: string)

Delete a ApiGatewayV2 RouteResponse

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 RouteResponse

fn sync()

Sync ApiGatewayV2 RouteResponse state from AWS

Resources

state(infinite)— ApiGatewayV2 RouteResponse resource state

@swamp/aws/apigatewayv2/routing-rulev2026.06.09.1routing_rule.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
DomainNameArn	string	yes	The ARN of the domain name.
Priority	number	yes	The order in which API Gateway evaluates a rule. Priority is evaluated from the lowest value to the highest value. Rules can't have the same priority. Priority values 1-1,000,000 are supported.
Conditions	array	yes	The conditions of the routing rule.
Actions	array	yes	The resulting action based on matching a routing rules condition. Only InvokeApi is supported.

fn create()

Create a ApiGatewayV2 RoutingRule

fn get(identifier: string)

Get a ApiGatewayV2 RoutingRule

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 RoutingRule

fn update()

Update a ApiGatewayV2 RoutingRule

fn delete(identifier: string)

Delete a ApiGatewayV2 RoutingRule

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 RoutingRule

fn sync()

Sync ApiGatewayV2 RoutingRule state from AWS

Resources

state(infinite)— ApiGatewayV2 RoutingRule resource state

@swamp/aws/apigatewayv2/stagev2026.06.12.1stage.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
ClientCertificateId?	string	no	The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
DeploymentId?	string	no	The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
Description?	string	no	The description for the API stage.
AutoDeploy?	boolean	no	Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
AccessLogSettings?	object	no	Settings for logging access in this stage.
RouteSettings?	record	no	Route settings for the stage.
StageName	string	yes	The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
StageVariables?	record	no	A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
ApiId	string	yes	The API identifier.
DefaultRouteSettings?	object	no	The default route settings for the stage.
Tags?	record	no	The collection of tags. Each tag element is associated with a given resource.

fn create()

Create a ApiGatewayV2 Stage

fn get(identifier: string)

Get a ApiGatewayV2 Stage

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Stage

fn update()

Update a ApiGatewayV2 Stage

fn delete(identifier: string)

Delete a ApiGatewayV2 Stage

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 Stage

fn sync()

Sync ApiGatewayV2 Stage state from AWS

Resources

state(infinite)— ApiGatewayV2 Stage resource state

@swamp/aws/apigatewayv2/vpc-linkv2026.06.08.1vpc_link.ts

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?	string	no	AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?	string	no	AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?	string	no	AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?	string	no	AWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
SubnetIds	array	yes	A list of subnet IDs to include in the VPC link.
SecurityGroupIds?	array	no	A list of security group IDs for the VPC link.
Tags?	record	no	The collection of tags. Each tag element is associated with a given resource.
Name	string	yes	The name of the VPC link.

fn create()

Create a ApiGatewayV2 VpcLink

fn get(identifier: string)

Get a ApiGatewayV2 VpcLink

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 VpcLink

fn update()

Update a ApiGatewayV2 VpcLink

fn delete(identifier: string)

Delete a ApiGatewayV2 VpcLink

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGatewayV2 VpcLink

fn sync()

Sync ApiGatewayV2 VpcLink state from AWS

Resources

state(infinite)— ApiGatewayV2 VpcLink resource state

04Previous Versions11

2026.06.09.1Jun 9, 2026

Updated: api, api_mapping, domain_name, routing_rule

2026.06.08.2Jun 8, 2026

Updated: api, api_mapping, authorizer, deployment, domain_name, integration, integration_response, model, route, route_response, routing_rule, vpc_link

2026.06.06.1Jun 6, 2026

Updated: api, api_mapping, authorizer, deployment, domain_name, integration, integration_response, model, route, route_response, routing_rule, vpc_link

2026.05.27.1May 27, 2026

Updated: api, integration_response, model, route, route_response

2026.04.23.3Apr 23, 2026

2026.04.23.2Apr 23, 2026

Updated: api, api_mapping, authorizer, deployment, domain_name, integration, integration_response, model, route, route_response, routing_rule, vpc_link

Removed 1 models

2026.04.03.3Apr 3, 2026

Updated: api, api_mapping, authorizer, deployment, domain_name, integration, integration_response, model, route, route_response, routing_rule, stage, vpc_link

2026.04.03.1Apr 3, 2026

Added: stage

2026.03.19.1Mar 19, 2026

Updated: api, api_mapping, authorizer, deployment, domain_name, integration, integration_response, model, route, route_response, routing_rule, vpc_link

2026.03.16.1Mar 16, 2026

Updated: api, api_mapping, authorizer, deployment, domain_name, integration, integration_response, model, route, route_response, routing_rule, vpc_link

2026.03.10.5Mar 10, 2026

05Stats

85 / 100

Downloads

Archive size

3.0 MB

Verified by Swamp

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types (deprecated)1/1earned
Dependencies pass trust audit0/2missing
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#aws #apigatewayv2 #cloud #infrastructure