0.0.4 • Published 3 months ago
@aws-lite/apigatewayv2 v0.0.4
@aws-lite/apigatewayv2
Official
aws-lite
plugin for API Gateway V2Maintained by: @architect
Install
npm i @aws-lite/apigatewayv2
Optionally install types:
npm i -D @aws-lite/apigatewayv2-types
Reference
Reference documentation with examples at aws-lite.org
Reference
Reference documentation with examples at aws-lite.org
Methods
CreateDeployment
Properties:
ApiId
(string) required- API ID
Description
(string)- Deployment description
StageName
(string)- Stage name
GetDeployment
Properties:
ApiId
(string) required- API ID
NextToken
(string)- Pagination cursor token to be used if
NextToken
was returned in a previous response
- Pagination cursor token to be used if
MaxResults
(number)- Maximum number of items to evaluate and return
GetDeployments
Properties:
ApiId
(string) required- API ID
NextToken
(string)- Pagination cursor token to be used if
NextToken
was returned in a previous response
- Pagination cursor token to be used if
MaxResults
(number)- Maximum number of items to evaluate and return
paginate
(boolean)- Enable automatic result pagination; use this instead of making your own individual pagination requests
UpdateStage
Properties:
ApiId
(string) required- API ID
StageName
(string) required- Stage name
AccessLogSettings
(object)- Access log settings for the stage
- More details (AWS)
AutoDeploy
(boolean)- Enable automatic deployments upon API updates:
true
orfalse
(default)
- Enable automatic deployments upon API updates:
ClientCertificateId
(string)- Client certificate ID for the stage
DefaultRouteSettings
(object)- Default route settings for the stage
- More details (AWS)
DeploymentId
(string)- Deployment ID for the API stage; cannot be updated if
autoDeploy
is enabled
- Deployment ID for the API stage; cannot be updated if
Description
(string)- Deployment description
RouteSettings
(object)- Route settings for the stage
- More details (AWS)
StageVariables
(object)- Stage variables; names can have alphanumeric and underscore characters, values must match:
[A-Za-z0-9-._~:/?#&=,]+
. - More details (AWS)
- Stage variables; names can have alphanumeric and underscore characters, values must match:
Methods yet to be implemented
Please help out by opening a PR!
CreateApi
CreateApiMapping
CreateAuthorizer
CreateDomainName
CreateIntegration
CreateIntegrationResponse
CreateModel
CreateRoute
CreateRouteResponse
CreateStage
CreateVpcLink
DeleteAccessLogSettings
DeleteApi
DeleteApiMapping
DeleteAuthorizer
DeleteCorsConfiguration
DeleteDeployment
DeleteDomainName
DeleteIntegration
DeleteIntegrationResponse
DeleteModel
DeleteRoute
DeleteRouteRequestParameter
DeleteRouteResponse
DeleteRouteSettings
DeleteStage
DeleteVpcLink
ExportApi
GetApi
GetApiMapping
GetApiMappings
GetApis
GetAuthorizer
GetAuthorizers
GetDomainName
GetDomainNames
GetIntegration
GetIntegrationResponse
GetIntegrationResponses
GetIntegrations
GetModel
GetModels
GetModelTemplate
GetRoute
GetRouteResponse
GetRouteResponses
GetRoutes
GetStage
GetStages
GetTags
GetVpcLink
GetVpcLinks
ImportApi
ReimportApi
ResetAuthorizersCache
TagResource
UntagResource
UpdateApi
UpdateApiMapping
UpdateAuthorizer
UpdateDeployment
UpdateDomainName
UpdateIntegration
UpdateIntegrationResponse
UpdateModel
UpdateRoute
UpdateRouteResponse
UpdateVpcLink