0.0.9 • Published 11 months ago
@aws-lite/apigatewayv2 v0.0.9
@aws-lite/apigatewayv2
Official
aws-liteplugin for API Gateway V2Maintained by: @architect
Install
npm i @aws-lite/apigatewayv2Optionally install types:
npm i -D @aws-lite/apigatewayv2-typesReference
Reference documentation with examples at aws-lite.org
Reference
Reference documentation with examples at aws-lite.org
Methods
CreateApiMapping
Properties:
DomainName(string) required- The domain name
ApiId(string) required- API ID
ApiMappingKey(string)- The API mapping key
Stage(string) required- The API stage
CreateDeployment
Properties:
ApiId(string) required- API ID
Description(string)- Deployment description
StageName(string)- Stage name
CreateDomainName
Properties:
DomainName(string) required- The domain name
DomainNameConfigurations(array)- Array of
DomainNameConfigurationobjects - More details (AWS)
- Array of
MutualTlsAuthentication(object)MutualTlsAuthenticationInputobject- More details (AWS)
Tags(object)- Record containing tags associated with the domain name
DeleteApiMapping
Properties:
DeleteDomainName
Properties:
DomainName(string) required- The domain name
GetApiMappings
Properties:
DomainName(string) required- The domain name
MaxResults(number)- Maximum number of items to evaluate and return
NextToken(string)- Pagination cursor token to be used if
NextTokenwas returned in a previous response
- Pagination cursor token to be used if
paginate(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
GetDeployment
Properties:
ApiId(string) required- API ID
NextToken(string)- Pagination cursor token to be used if
NextTokenwas 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
NextTokenwas returned in a previous response
- Pagination cursor token to be used if
MaxResults(number)- Maximum number of items to evaluate and return
paginate(boolean, string)- 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:
trueorfalse(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
autoDeployis 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!
CreateApiCreateAuthorizerCreateIntegrationCreateIntegrationResponseCreateModelCreateRouteCreateRouteResponseCreateStageCreateVpcLinkDeleteAccessLogSettingsDeleteApiDeleteAuthorizerDeleteCorsConfigurationDeleteDeploymentDeleteIntegrationDeleteIntegrationResponseDeleteModelDeleteRouteDeleteRouteRequestParameterDeleteRouteResponseDeleteRouteSettingsDeleteStageDeleteVpcLinkExportApiGetApiGetApiMappingGetApisGetAuthorizerGetAuthorizersGetDomainNameGetDomainNamesGetIntegrationGetIntegrationResponseGetIntegrationResponsesGetIntegrationsGetModelGetModelsGetModelTemplateGetRouteGetRouteResponseGetRouteResponsesGetRoutesGetStageGetStagesGetTagsGetVpcLinkGetVpcLinksImportApiReimportApiResetAuthorizersCacheTagResourceUntagResourceUpdateApiUpdateApiMappingUpdateAuthorizerUpdateDeploymentUpdateDomainNameUpdateIntegrationUpdateIntegrationResponseUpdateModelUpdateRouteUpdateRouteResponseUpdateVpcLink