Aws/apigateway

@swamp/aws/apigatewayv2026.10.25.1· AGPL-3.0-or-later· 1d agoBEHAVIORS

01README

AWS APIGATEWAY infrastructure models

02Behaviors22

@swamp/aws/apigateway/accountv2026.10.23.1account.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
CloudWatchRoleArn?	string	no

fn create()

Create a ApiGateway Account

fn get(identifier: string)

Get a ApiGateway Account

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway Account

fn update()

Update a ApiGateway Account

fn delete(identifier: string)

Delete a ApiGateway Account

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway Account

fn sync()

Sync ApiGateway Account state from AWS

Resources

state(infinite)— ApiGateway Account resource state

@swamp/aws/apigateway/api-keyv2026.10.23.1api_key.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
CustomerId?	string	no
Description?	string	no
Enabled?	boolean	no
GenerateDistinctId?	boolean	no
Name?	string	no	A 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	no
Tags?	array	no
Value?	string	no

fn create()

Create a ApiGateway ApiKey

fn get(identifier: string)

Get a ApiGateway ApiKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway ApiKey

fn update()

Update a ApiGateway ApiKey

fn delete(identifier: string)

Delete a ApiGateway ApiKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway ApiKey

fn sync()

Sync ApiGateway ApiKey state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway ApiKey resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway ApiKey resource state

@swamp/aws/apigateway/authorizerv2026.10.23.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
RestApiId	string	yes
AuthType?	string	no
AuthorizerCredentials?	string	no
AuthorizerResultTtlInSeconds?	number	no
AuthorizerUri?	string	no
IdentitySource?	string	no
IdentityValidationExpression?	string	no
Name	string	yes
ProviderARNs?	array	no
Type	string	yes

fn create()

Create a ApiGateway Authorizer

fn get(identifier: string)

Get a ApiGateway Authorizer

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

fn update()

Update a ApiGateway Authorizer

fn delete(identifier: string)

Delete a ApiGateway Authorizer

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

fn sync()

Sync ApiGateway Authorizer state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway Authorizer resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway Authorizer resource state

@swamp/aws/apigateway/base-path-mappingv2026.10.23.1base_path_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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
BasePath?	string	no
DomainName	string	yes
RestApiId?	string	no
Stage?	string	no

fn create()

Create a ApiGateway BasePathMapping

fn get(identifier: string)

Get a ApiGateway BasePathMapping

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway BasePathMapping

fn update()

Update a ApiGateway BasePathMapping

fn delete(identifier: string)

Delete a ApiGateway BasePathMapping

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway BasePathMapping

fn sync()

Sync ApiGateway BasePathMapping state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway BasePathMapping resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway BasePathMapping resource state

@swamp/aws/apigateway/base-path-mapping-v2v2026.10.23.1base_path_mapping_v2.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
BasePath?	string	no	The base path name that callers of the API must provide in the URL after the domain name.
DomainNameArn	string	yes	The Arn of an AWS::ApiGateway::DomainNameV2 resource.
RestApiId	string	yes	The ID of the API.
Stage?	string	no	The name of the API's stage.

fn create()

Create a ApiGateway BasePathMappingV2

fn get(identifier: string)

Get a ApiGateway BasePathMappingV2

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway BasePathMappingV2

fn update()

Update a ApiGateway BasePathMappingV2

fn delete(identifier: string)

Delete a ApiGateway BasePathMappingV2

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway BasePathMappingV2

fn sync()

Sync ApiGateway BasePathMappingV2 state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway BasePathMappingV2 resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway BasePathMappingV2 resource state

@swamp/aws/apigateway/client-certificatev2026.10.23.1client_certificate.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Description?	string	no
Tags?	array	no

fn create()

Create a ApiGateway ClientCertificate

fn get(identifier: string)

Get a ApiGateway ClientCertificate

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway ClientCertificate

fn update()

Update a ApiGateway ClientCertificate

fn delete(identifier: string)

Delete a ApiGateway ClientCertificate

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway ClientCertificate

fn sync()

Sync ApiGateway ClientCertificate state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway ClientCertificate resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway ClientCertificate resource state

@swamp/aws/apigateway/deploymentv2026.10.23.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Description?	string	no
StageDescription?	object	no	The 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	no
RestApiId	string	yes
DeploymentCanarySettings?	object	no

fn create()

Create a ApiGateway Deployment

fn get(identifier: string)

Get a ApiGateway Deployment

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

fn update()

Update a ApiGateway Deployment

fn delete(identifier: string)

Delete a ApiGateway Deployment

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

fn sync()

Sync ApiGateway Deployment state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway Deployment resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway Deployment resource state

@swamp/aws/apigateway/documentation-partv2026.10.23.1documentation_part.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Location	object	yes
Properties	string	yes
RestApiId	string	yes

fn create()

Create a ApiGateway DocumentationPart

fn get(identifier: string)

Get a ApiGateway DocumentationPart

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway DocumentationPart

fn update()

Update a ApiGateway DocumentationPart

fn delete(identifier: string)

Delete a ApiGateway DocumentationPart

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway DocumentationPart

fn sync()

Sync ApiGateway DocumentationPart state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway DocumentationPart resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway DocumentationPart resource state

@swamp/aws/apigateway/documentation-versionv2026.10.23.1documentation_version.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Description?	string	no
DocumentationVersion	string	yes
RestApiId	string	yes

fn create()

Create a ApiGateway DocumentationVersion

fn get(identifier: string)

Get a ApiGateway DocumentationVersion

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway DocumentationVersion

fn update()

Update a ApiGateway DocumentationVersion

fn delete(identifier: string)

Delete a ApiGateway DocumentationVersion

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway DocumentationVersion

fn sync()

Sync ApiGateway DocumentationVersion state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway DocumentationVersion resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway DocumentationVersion resource state

@swamp/aws/apigateway/domain-namev2026.10.23.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
DomainName?	string	no
EndpointConfiguration?	object	no	The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
MutualTlsAuthentication?	object	no
CertificateArn?	string	no
RegionalCertificateArn?	string	no
OwnershipVerificationCertificateArn?	string	no	The 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	no
EndpointAccessMode?	string	no
RoutingMode?	enum	no
Tags?	array	no

fn create()

Create a ApiGateway DomainName

fn get(identifier: string)

Get a ApiGateway DomainName

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

fn update()

Update a ApiGateway DomainName

fn delete(identifier: string)

Delete a ApiGateway DomainName

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

fn sync()

Sync ApiGateway DomainName state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway DomainName resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway DomainName resource state

@swamp/aws/apigateway/domain-name-access-associationv2026.10.23.1domain_name_access_association.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
DomainNameArn	string	yes	The amazon resource name (ARN) of the domain name resource.
AccessAssociationSource	string	yes	The source of the domain name access association resource.
AccessAssociationSourceType	enum	yes	The source type of the domain name access association resource.
Tags?	array	no	An array of arbitrary tags (key-value pairs) to associate with the domainname access association.

fn create()

Create a ApiGateway DomainNameAccessAssociation

fn get(identifier: string)

Get a ApiGateway DomainNameAccessAssociation

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway DomainNameAccessAssociation

fn delete(identifier: string)

Delete a ApiGateway DomainNameAccessAssociation

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway DomainNameAccessAssociation

fn sync()

Sync ApiGateway DomainNameAccessAssociation state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway DomainNameAccessAssociation resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway DomainNameAccessAssociation resource state

@swamp/aws/apigateway/domain-name-v2v2026.10.23.1domain_name_v2.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
CertificateArn?	string	no
DomainName?	string	no
EndpointConfiguration?	object	no
SecurityPolicy?	string	no
EndpointAccessMode?	string	no
Policy?	record	no
RoutingMode?	enum	no	The 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	no

fn create()

Create a ApiGateway DomainNameV2

fn get(identifier: string)

Get a ApiGateway DomainNameV2

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway DomainNameV2

fn update()

Update a ApiGateway DomainNameV2

fn delete(identifier: string)

Delete a ApiGateway DomainNameV2

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway DomainNameV2

fn sync()

Sync ApiGateway DomainNameV2 state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway DomainNameV2 resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway DomainNameV2 resource state

@swamp/aws/apigateway/gateway-responsev2026.10.23.1gateway_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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
RestApiId	string	yes
ResponseType	string	yes
StatusCode?	string	no
ResponseParameters?	record	no
ResponseTemplates?	record	no

fn create()

Create a ApiGateway GatewayResponse

fn get(identifier: string)

Get a ApiGateway GatewayResponse

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway GatewayResponse

fn update()

Update a ApiGateway GatewayResponse

fn delete(identifier: string)

Delete a ApiGateway GatewayResponse

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway GatewayResponse

fn sync()

Sync ApiGateway GatewayResponse state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway GatewayResponse resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway GatewayResponse resource state

@swamp/aws/apigateway/methodv2026.10.23.1method.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Integration?	object	no
OperationName?	string	no
RequestModels?	record	no
RestApiId	string	yes
AuthorizationScopes?	array	no
RequestValidatorId?	string	no
RequestParameters?	record	no
MethodResponses?	array	no
AuthorizerId?	string	no
ResourceId	string	yes
ApiKeyRequired?	boolean	no
AuthorizationType?	string	no	The 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.
HttpMethod	string	yes

fn create()

Create a ApiGateway Method

fn get(identifier: string)

Get a ApiGateway Method

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway Method

fn update()

Update a ApiGateway Method

fn delete(identifier: string)

Delete a ApiGateway Method

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway Method

fn sync()

Sync ApiGateway Method state from AWS

Resources

state(infinite)— ApiGateway Method resource state

@swamp/aws/apigateway/modelv2026.10.23.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ContentType?	string	no
Description?	string	no
Name?	string	no	A 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.
RestApiId	string	yes
Schema?	record	no

fn create()

Create a ApiGateway Model

fn get(identifier: string)

Get a ApiGateway Model

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

fn update()

Update a ApiGateway Model

fn delete(identifier: string)

Delete a ApiGateway Model

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

fn sync()

Sync ApiGateway Model state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway Model resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway Model resource state

@swamp/aws/apigateway/request-validatorv2026.10.23.1request_validator.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name?	string	no
RestApiId	string	yes
ValidateRequestBody?	boolean	no
ValidateRequestParameters?	boolean	no

fn create()

Create a ApiGateway RequestValidator

fn get(identifier: string)

Get a ApiGateway RequestValidator

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway RequestValidator

fn update()

Update a ApiGateway RequestValidator

fn delete(identifier: string)

Delete a ApiGateway RequestValidator

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway RequestValidator

fn sync()

Sync ApiGateway RequestValidator state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway RequestValidator resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway RequestValidator resource state

@swamp/aws/apigateway/resourcev2026.10.23.1resource.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ParentId	string	yes
PathPart	string	yes
RestApiId	string	yes

fn create()

Create a ApiGateway Resource

fn get(identifier: string)

Get a ApiGateway Resource

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway Resource

fn update()

Update a ApiGateway Resource

fn delete(identifier: string)

Delete a ApiGateway Resource

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway Resource

fn sync()

Sync ApiGateway Resource state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway Resource resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway Resource resource state

@swamp/aws/apigateway/rest-apiv2026.10.23.1rest_api.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Policy?	record	no	A 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?	object	no	The 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	no
MinimumCompressionSize?	number	no
Parameters?	record	no
CloneFrom?	string	no
Mode?	string	no	This 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	no
FailOnWarnings?	boolean	no
BinaryMediaTypes?	array	no
Name?	string	no	The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
Version?	string	no
SecurityPolicy?	string	no
ApiKeySourceType?	string	no
EndpointConfiguration?	object	no	A 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?	record	no	An 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	no
EndpointAccessMode?	string	no

fn create()

Create a ApiGateway RestApi

fn get(identifier: string)

Get a ApiGateway RestApi

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway RestApi

fn update()

Update a ApiGateway RestApi

fn delete(identifier: string)

Delete a ApiGateway RestApi

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway RestApi

fn sync()

Sync ApiGateway RestApi state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway RestApi resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway RestApi resource state

@swamp/aws/apigateway/stagev2026.10.23.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
AccessLogSetting?	object	no
CacheClusterEnabled?	boolean	no
CacheClusterSize?	string	no
CanarySetting?	object	no
ClientCertificateId?	string	no
DeploymentId?	string	no
Description?	string	no
DocumentationVersion?	string	no
MethodSettings?	array	no
RestApiId	string	yes
StageName?	string	no
Tags?	array	no
TracingEnabled?	boolean	no
Variables?	record	no	A 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-._~:/?#&=,]+.

fn create()

Create a ApiGateway Stage

fn get(identifier: string)

Get a ApiGateway Stage

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

fn update()

Update a ApiGateway Stage

fn delete(identifier: string)

Delete a ApiGateway Stage

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

fn sync()

Sync ApiGateway Stage state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway Stage resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway Stage resource state

@swamp/aws/apigateway/usage-planv2026.10.23.1usage_plan.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
ApiStages?	array	no
Description?	string	no
Quota?	object	no
Tags?	array	no
Throttle?	object	no
UsagePlanName?	string	no

fn create()

Create a ApiGateway UsagePlan

fn get(identifier: string)

Get a ApiGateway UsagePlan

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway UsagePlan

fn update()

Update a ApiGateway UsagePlan

fn delete(identifier: string)

Delete a ApiGateway UsagePlan

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway UsagePlan

fn sync()

Sync ApiGateway UsagePlan state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway UsagePlan resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway UsagePlan resource state

@swamp/aws/apigateway/usage-plan-keyv2026.10.23.1usage_plan_key.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
KeyId	string	yes	The Id of the UsagePlanKey resource.
KeyType	enum	yes
UsagePlanId	string	yes	The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.

fn create()

Create a ApiGateway UsagePlanKey

fn get(identifier: string)

Get a ApiGateway UsagePlanKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway UsagePlanKey

fn delete(identifier: string)

Delete a ApiGateway UsagePlanKey

Argument	Type	Required	Description
identifier	string	yes	The primary identifier of the ApiGateway UsagePlanKey

fn sync()

Sync ApiGateway UsagePlanKey state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway UsagePlanKey resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway UsagePlanKey resource state

@swamp/aws/apigateway/vpc-linkv2026.10.23.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 / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1.
Name	string	yes
Description?	string	no
Tags?	array	no	An array of arbitrary tags (key-value pairs) to associate with the VPC link.
TargetArns	array	yes

fn create()

Create a ApiGateway VpcLink

fn get(identifier: string)

Get a ApiGateway VpcLink

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

fn update()

Update a ApiGateway VpcLink

fn delete(identifier: string)

Delete a ApiGateway VpcLink

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

fn sync()

Sync ApiGateway VpcLink state from AWS

fn list(maxPages?: number, resourceModel?: string)

List ApiGateway VpcLink resources

Argument	Type	Required	Description
maxPages?	number	no	Maximum number of pages to fetch (default: 10)
resourceModel?	string	no	JSON resource model for parent-scoped listing (e.g. parent identifier)

Resources

state(infinite)— ApiGateway VpcLink resource state

03Previous Versions19

2026.10.24.1AGPL-3.0-or-laterOct 24, 2026

2026.10.23.1AGPL-3.0-or-later(was none)Oct 24, 2026

Updated: account, api_key, authorizer, base_path_mapping, base_path_mapping_v2, client_certificate, deployment, documentation_part, documentation_version, domain_name, domain_name_access_association, domain_name_v2, gateway_response, method, model, request_validator, resource, rest_api, stage, usage_plan, usage_plan_key, vpc_link

2026.10.13.1Oct 13, 2026

Updated: account, api_key, authorizer, base_path_mapping, base_path_mapping_v2, client_certificate, deployment, documentation_part, documentation_version, domain_name, domain_name_access_association, domain_name_v2, gateway_response, method, model, request_validator, resource, rest_api, stage, usage_plan, usage_plan_key, vpc_link

2026.10.08.1Oct 8, 2026

2026.10.06.1Oct 6, 2026

2026.10.04.1Oct 4, 2026

2026.10.03.1Oct 3, 2026

2026.10.02.1Oct 2, 2026

2026.10.01.1Oct 1, 2026

2026.09.30.1Sep 30, 2026

2026.09.29.1Sep 29, 2026

2026.09.28.1Sep 28, 2026

2026.09.27.1Sep 27, 2026

2026.09.26.1Sep 26, 2026

2026.09.24.1Sep 24, 2026

2026.09.23.1Sep 23, 2026

2026.09.22.1Sep 22, 2026

2026.09.21.1Sep 21, 2026

2026.09.20.1Sep 20, 2026

04Stats

100 / 100

Downloads

Archive size

4.4 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 audit2/2earned
Docs keep secrets in a vault1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License2/2earned
Verified public repository2/2earned

Repository

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

05Platforms

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

06Labels

#aws #apigateway #cloud #infrastructure