JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 470
  • Score
    100M100P100Q114702F
  • License Apache-2.0

Official `aws-lite` plugin for API Gateway V2

Package Exports

  • @aws-lite/apigatewayv2
  • @aws-lite/apigatewayv2/src/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-lite/apigatewayv2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@aws-lite/apigatewayv2

Official aws-lite plugin for API Gateway V2

Maintained 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

CreateApiMapping

Canonical AWS API doc

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

Canonical AWS API doc

Properties:

  • ApiId (string) [required]
    • API ID
  • Description (string)
    • Deployment description
  • StageName (string)
    • Stage name

CreateDomainName

Canonical AWS API doc

Properties:

  • DomainName (string) [required]
    • The domain name
  • DomainNameConfigurations (array)
  • MutualTlsAuthentication (object)
  • Tags (object)
    • Record containing tags associated with the domain name

DeleteApiMapping

Canonical AWS API doc

Properties:

  • ApiMappingId (string) [required]
    • ID of the API mapping
  • DomainName (string) [required]
    • The domain name

DeleteDomainName

Canonical AWS API doc

Properties:

  • DomainName (string) [required]
    • The domain name

GetApiMappings

Canonical AWS API doc

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 NextToken was returned in a previous response
  • paginate (boolean, string)
    • Enable automatic result pagination; use this instead of making your own individual pagination requests

GetDeployment

Canonical AWS API doc

Properties:

  • ApiId (string) [required]
    • API ID
  • NextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • MaxResults (number)
    • Maximum number of items to evaluate and return

GetDeployments

Canonical AWS API doc

Properties:

  • ApiId (string) [required]
    • API ID
  • NextToken (string)
    • Pagination cursor token to be used if NextToken was returned in a previous response
  • 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

Canonical AWS API doc

Properties:

  • ApiId (string) [required]
    • API ID
  • StageName (string) [required]
    • Stage name
  • AccessLogSettings (object)
  • AutoDeploy (boolean)
    • Enable automatic deployments upon API updates: true or false (default)
  • ClientCertificateId (string)
    • Client certificate ID for the stage
  • DefaultRouteSettings (object)
  • DeploymentId (string)
    • Deployment ID for the API stage; cannot be updated if autoDeploy is enabled
  • Description (string)
    • Deployment description
  • RouteSettings (object)
  • StageVariables (object)
    • Stage variables; names can have alphanumeric and underscore characters, values must match: [A-Za-z0-9-._~:/?#&=,]+.
    • More details (AWS)

Methods yet to be implemented

Please help out by opening a PR!

Learn more