Skip to main content

@swamp/aws/apigateway

v2026.04.23.3

AWS APIGATEWAY infrastructure models

Repository

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

Labels

awsapigatewaycloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/apigateway

@swamp/aws/apigateway/accountv2026.04.23.2account.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
CloudWatchRoleArn?string
createCreate a ApiGateway Account
getGet a ApiGateway Account
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Account
updateUpdate a ApiGateway Account
deleteDelete a ApiGateway Account
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Account
syncSync ApiGateway Account state from AWS

Resources

state(infinite)— ApiGateway Account resource state
@swamp/aws/apigateway/api-keyv2026.04.23.2api_key.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
CustomerId?string
Description?string
Enabled?boolean
GenerateDistinctId?boolean
Name?stringA name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
StageKeys?array
Tags?array
Value?string
createCreate a ApiGateway ApiKey
getGet a ApiGateway ApiKey
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway ApiKey
updateUpdate a ApiGateway ApiKey
deleteDelete a ApiGateway ApiKey
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway ApiKey
syncSync ApiGateway ApiKey state from AWS

Resources

state(infinite)— ApiGateway ApiKey resource state
@swamp/aws/apigateway/authorizerv2026.04.23.2authorizer.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
RestApiIdstring
AuthType?string
AuthorizerCredentials?string
AuthorizerResultTtlInSeconds?number
AuthorizerUri?string
IdentitySource?string
IdentityValidationExpression?string
Namestring
ProviderARNs?array
Typestring
createCreate a ApiGateway Authorizer
getGet a ApiGateway Authorizer
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Authorizer
updateUpdate a ApiGateway Authorizer
deleteDelete a ApiGateway Authorizer
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Authorizer
syncSync ApiGateway Authorizer state from AWS

Resources

state(infinite)— ApiGateway Authorizer resource state
@swamp/aws/apigateway/base-path-mappingv2026.04.23.2base_path_mapping.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
BasePath?string
DomainNamestring
RestApiId?string
Stage?string
createCreate a ApiGateway BasePathMapping
getGet a ApiGateway BasePathMapping
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway BasePathMapping
updateUpdate a ApiGateway BasePathMapping
deleteDelete a ApiGateway BasePathMapping
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway BasePathMapping
syncSync ApiGateway BasePathMapping state from AWS

Resources

state(infinite)— ApiGateway BasePathMapping resource state
@swamp/aws/apigateway/base-path-mapping-v2v2026.04.23.2base_path_mapping_v2.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
BasePath?stringThe base path name that callers of the API must provide in the URL after the domain name.
DomainNameArnstringThe Arn of an AWS::ApiGateway::DomainNameV2 resource.
RestApiIdstringThe ID of the API.
Stage?stringThe name of the API's stage.
createCreate a ApiGateway BasePathMappingV2
getGet a ApiGateway BasePathMappingV2
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway BasePathMappingV2
updateUpdate a ApiGateway BasePathMappingV2
deleteDelete a ApiGateway BasePathMappingV2
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway BasePathMappingV2
syncSync ApiGateway BasePathMappingV2 state from AWS

Resources

state(infinite)— ApiGateway BasePathMappingV2 resource state
@swamp/aws/apigateway/client-certificatev2026.04.23.2client_certificate.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Description?string
Tags?array
createCreate a ApiGateway ClientCertificate
getGet a ApiGateway ClientCertificate
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway ClientCertificate
updateUpdate a ApiGateway ClientCertificate
deleteDelete a ApiGateway ClientCertificate
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway ClientCertificate
syncSync ApiGateway ClientCertificate state from AWS

Resources

state(infinite)— ApiGateway ClientCertificate resource state
@swamp/aws/apigateway/deploymentv2026.04.23.2deployment.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Description?string
StageDescription?objectThe description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
StageName?string
RestApiIdstring
DeploymentCanarySettings?object
createCreate a ApiGateway Deployment
getGet a ApiGateway Deployment
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Deployment
updateUpdate a ApiGateway Deployment
deleteDelete a ApiGateway Deployment
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Deployment
syncSync ApiGateway Deployment state from AWS

Resources

state(infinite)— ApiGateway Deployment resource state
@swamp/aws/apigateway/documentation-partv2026.04.23.2documentation_part.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Locationobject
Propertiesstring
RestApiIdstring
createCreate a ApiGateway DocumentationPart
getGet a ApiGateway DocumentationPart
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DocumentationPart
updateUpdate a ApiGateway DocumentationPart
deleteDelete a ApiGateway DocumentationPart
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DocumentationPart
syncSync ApiGateway DocumentationPart state from AWS

Resources

state(infinite)— ApiGateway DocumentationPart resource state
@swamp/aws/apigateway/documentation-versionv2026.04.23.2documentation_version.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Description?string
DocumentationVersionstring
RestApiIdstring
createCreate a ApiGateway DocumentationVersion
getGet a ApiGateway DocumentationVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DocumentationVersion
updateUpdate a ApiGateway DocumentationVersion
deleteDelete a ApiGateway DocumentationVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DocumentationVersion
syncSync ApiGateway DocumentationVersion state from AWS

Resources

state(infinite)— ApiGateway DocumentationVersion resource state
@swamp/aws/apigateway/domain-namev2026.04.23.2domain_name.ts

Global Arguments

ArgumentTypeDescription
DomainName?string
EndpointConfiguration?objectThe endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
MutualTlsAuthentication?object
CertificateArn?string
RegionalCertificateArn?string
OwnershipVerificationCertificateArn?stringThe ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
SecurityPolicy?string
EndpointAccessMode?string
RoutingMode?enum
Tags?array
createCreate a ApiGateway DomainName
getGet a ApiGateway DomainName
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DomainName
updateUpdate a ApiGateway DomainName
deleteDelete a ApiGateway DomainName
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DomainName
syncSync ApiGateway DomainName state from AWS

Resources

state(infinite)— ApiGateway DomainName resource state
@swamp/aws/apigateway/domain-name-access-associationv2026.04.23.2domain_name_access_association.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
DomainNameArnstringThe amazon resource name (ARN) of the domain name resource.
AccessAssociationSourcestringThe source of the domain name access association resource.
AccessAssociationSourceTypeenumThe source type of the domain name access association resource.
Tags?arrayAn array of arbitrary tags (key-value pairs) to associate with the domainname access association.
createCreate a ApiGateway DomainNameAccessAssociation
getGet a ApiGateway DomainNameAccessAssociation
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DomainNameAccessAssociation
deleteDelete a ApiGateway DomainNameAccessAssociation
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DomainNameAccessAssociation
syncSync ApiGateway DomainNameAccessAssociation state from AWS

Resources

state(infinite)— ApiGateway DomainNameAccessAssociation resource state
@swamp/aws/apigateway/domain-name-v2v2026.04.23.2domain_name_v2.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
CertificateArn?string
DomainName?string
EndpointConfiguration?object
SecurityPolicy?string
EndpointAccessMode?string
Policy?string
RoutingMode?enumThe valid routing modes are [BASE_PATH_MAPPING_ONLY], [ROUTING_RULE_THEN_BASE_PATH_MAPPING] and [ROUTING_RULE_ONLY]. All other inputs are invalid.
Tags?array
createCreate a ApiGateway DomainNameV2
getGet a ApiGateway DomainNameV2
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DomainNameV2
updateUpdate a ApiGateway DomainNameV2
deleteDelete a ApiGateway DomainNameV2
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway DomainNameV2
syncSync ApiGateway DomainNameV2 state from AWS

Resources

state(infinite)— ApiGateway DomainNameV2 resource state
@swamp/aws/apigateway/gateway-responsev2026.04.23.2gateway_response.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
RestApiIdstring
ResponseTypestring
StatusCode?string
ResponseParameters?record
ResponseTemplates?record
createCreate a ApiGateway GatewayResponse
getGet a ApiGateway GatewayResponse
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway GatewayResponse
updateUpdate a ApiGateway GatewayResponse
deleteDelete a ApiGateway GatewayResponse
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway GatewayResponse
syncSync ApiGateway GatewayResponse state from AWS

Resources

state(infinite)— ApiGateway GatewayResponse resource state
@swamp/aws/apigateway/methodv2026.04.23.2method.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Integration?object
OperationName?string
RequestModels?record
RestApiIdstring
AuthorizationScopes?array
RequestValidatorId?string
RequestParameters?record
MethodResponses?array
AuthorizerId?string
ResourceIdstring
ApiKeyRequired?boolean
AuthorizationType?stringThe method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference*. If you specify the AuthorizerId property, specify CUSTOM or COGNITO_USER_POOLS for this property.
HttpMethodstring
createCreate a ApiGateway Method
getGet a ApiGateway Method
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Method
updateUpdate a ApiGateway Method
deleteDelete a ApiGateway Method
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Method
syncSync ApiGateway Method state from AWS

Resources

state(infinite)— ApiGateway Method resource state
@swamp/aws/apigateway/modelv2026.04.23.2model.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ContentType?string
Description?string
Name?stringA name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
RestApiIdstring
Schema?string
createCreate a ApiGateway Model
getGet a ApiGateway Model
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Model
updateUpdate a ApiGateway Model
deleteDelete a ApiGateway Model
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Model
syncSync ApiGateway Model state from AWS

Resources

state(infinite)— ApiGateway Model resource state
@swamp/aws/apigateway/request-validatorv2026.04.23.2request_validator.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Name?string
RestApiIdstring
ValidateRequestBody?boolean
ValidateRequestParameters?boolean
createCreate a ApiGateway RequestValidator
getGet a ApiGateway RequestValidator
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway RequestValidator
updateUpdate a ApiGateway RequestValidator
deleteDelete a ApiGateway RequestValidator
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway RequestValidator
syncSync ApiGateway RequestValidator state from AWS

Resources

state(infinite)— ApiGateway RequestValidator resource state
@swamp/aws/apigateway/resourcev2026.04.23.2resource.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ParentIdstring
PathPartstring
RestApiIdstring
createCreate a ApiGateway Resource
getGet a ApiGateway Resource
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Resource
updateUpdate a ApiGateway Resource
deleteDelete a ApiGateway Resource
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Resource
syncSync ApiGateway Resource state from AWS

Resources

state(infinite)— ApiGateway Resource resource state
@swamp/aws/apigateway/rest-apiv2026.04.23.2rest_api.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Policy?stringA policy document that contains the permissions for the RestApi resource. To set the ARN for the policy, use the!Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*".
BodyS3Location?objectThe Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
Description?string
MinimumCompressionSize?number
Parameters?string
CloneFrom?string
Mode?stringThis property applies only when you use OpenAPI to define your REST API. The Mode determines how API Gateway handles resource updates. Valid values are overwrite or merge. For overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged. For merge, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite. For REST APIs c
DisableExecuteApiEndpoint?boolean
FailOnWarnings?boolean
BinaryMediaTypes?array
Name?stringThe name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
SecurityPolicy?string
ApiKeySourceType?string
EndpointConfiguration?objectA list of the endpoint types and IP address types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.
Body?stringAn OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
Tags?array
EndpointAccessMode?string
createCreate a ApiGateway RestApi
getGet a ApiGateway RestApi
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway RestApi
updateUpdate a ApiGateway RestApi
deleteDelete a ApiGateway RestApi
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway RestApi
syncSync ApiGateway RestApi state from AWS

Resources

state(infinite)— ApiGateway RestApi resource state
@swamp/aws/apigateway/stagev2026.04.23.2stage.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AccessLogSetting?object
CacheClusterEnabled?boolean
CacheClusterSize?string
CanarySetting?object
ClientCertificateId?string
DeploymentId?string
Description?string
DocumentationVersion?string
MethodSettings?array
RestApiIdstring
StageName?string
Tags?array
TracingEnabled?boolean
Variables?recordA map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
createCreate a ApiGateway Stage
getGet a ApiGateway Stage
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Stage
updateUpdate a ApiGateway Stage
deleteDelete a ApiGateway Stage
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway Stage
syncSync ApiGateway Stage state from AWS

Resources

state(infinite)— ApiGateway Stage resource state
@swamp/aws/apigateway/usage-planv2026.04.23.2usage_plan.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ApiStages?array
Description?string
Quota?object
Tags?array
Throttle?object
UsagePlanName?string
createCreate a ApiGateway UsagePlan
getGet a ApiGateway UsagePlan
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway UsagePlan
updateUpdate a ApiGateway UsagePlan
deleteDelete a ApiGateway UsagePlan
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway UsagePlan
syncSync ApiGateway UsagePlan state from AWS

Resources

state(infinite)— ApiGateway UsagePlan resource state
@swamp/aws/apigateway/usage-plan-keyv2026.04.23.2usage_plan_key.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
KeyIdstringThe Id of the UsagePlanKey resource.
KeyTypeenum
UsagePlanIdstringThe Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
createCreate a ApiGateway UsagePlanKey
getGet a ApiGateway UsagePlanKey
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway UsagePlanKey
deleteDelete a ApiGateway UsagePlanKey
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway UsagePlanKey
syncSync ApiGateway UsagePlanKey state from AWS

Resources

state(infinite)— ApiGateway UsagePlanKey resource state
@swamp/aws/apigateway/vpc-linkv2026.04.23.2vpc_link.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Namestring
Description?string
Tags?arrayAn array of arbitrary tags (key-value pairs) to associate with the VPC link.
TargetArnsarray
createCreate a ApiGateway VpcLink
getGet a ApiGateway VpcLink
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway VpcLink
updateUpdate a ApiGateway VpcLink
deleteDelete a ApiGateway VpcLink
ArgumentTypeDescription
identifierstringThe primary identifier of the ApiGateway VpcLink
syncSync ApiGateway VpcLink state from AWS

Resources

state(infinite)— ApiGateway VpcLink resource state