@aws-lite/apigatewayv2
Maintained by: @architect
Install
npm i @aws-lite/apigatewayv2
Optionally install types:
npm i -D @aws-lite/apigatewayv2-types
Methods
CreateApiMapping
Properties
ApiId(string) [required]-
API ID
DomainName(string) [required]-
The domain name
Stage(string) [required]-
The API stage
ApiMappingKey(string)-
The API mapping key
Example
await aws.APIGatewayV2.CreateApiMapping({
ApiId: String, // required
DomainName: String, // required
Stage: String, // required
ApiMappingKey: String,
})
CreateDeployment
Properties
ApiId(string) [required]-
API ID
Description(string)-
Deployment description
StageName(string)-
Stage name
Example
await aws.APIGatewayV2.CreateDeployment({
ApiId: String, // required
Description: String,
StageName: String,
})
CreateDomainName
Properties
DomainName(string) [required]-
The domain name
DomainNameConfigurations(array)-
Array of
DomainNameConfigurationobjects - More details (AWS)
Tags(object)-
Record containing tags associated with the domain name
Example
await aws.APIGatewayV2.CreateDomainName({
DomainName: String, // required
DomainNameConfigurations: Array,
MutualTlsAuthentication: Object,
Tags: Object,
})
DeleteApiMapping
Properties
ApiMappingId(string) [required]-
ID of the API mapping
DomainName(string) [required]-
The domain name
Example
await aws.APIGatewayV2.DeleteApiMapping({
ApiMappingId: String, // required
DomainName: String, // required
})
DeleteDomainName
Properties
DomainName(string) [required]-
The domain name
Example
await aws.APIGatewayV2.DeleteDomainName({
DomainName: String, // required
})
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 paginate(boolean, string)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.APIGatewayV2.GetApiMappings({
DomainName: String, // required
MaxResults: Number,
NextToken: String,
paginate: Boolean || String,
})
GetDeployment
Properties
ApiId(string) [required]-
API ID
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
Example
await aws.APIGatewayV2.GetDeployment({
ApiId: String, // required
MaxResults: Number,
NextToken: String,
})
GetDeployments
Properties
ApiId(string) [required]-
API ID
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 paginate(boolean, string)-
Enable automatic result pagination; use this instead of making your own individual pagination requests
Example
await aws.APIGatewayV2.GetDeployments({
ApiId: String, // required
MaxResults: Number,
NextToken: String,
paginate: Boolean || String,
})
UpdateStage
Properties
ApiId(string) [required]-
API ID
StageName(string) [required]-
Stage name
AccessLogSettings(object)-
Access log settings for the stage
- More details (AWS)
DeploymentId(string)-
Deployment ID for the API stage; cannot be updated if
autoDeployis enabled Description(string)-
Deployment description
RouteSettings(object)-
Route settings for the stage
- More details (AWS)
Example
await aws.APIGatewayV2.UpdateStage({
ApiId: String, // required
StageName: String, // required
AccessLogSettings: Object,
AutoDeploy: Boolean,
ClientCertificateId: String,
DefaultRouteSettings: Object,
DeploymentId: String,
Description: String,
RouteSettings: Object,
StageVariables: Object,
})
Methods yet to be implemented
Please help out by opening a PR!
CreateApiCreateAuthorizerCreateIntegrationCreateIntegrationResponseCreateModelCreateRouteCreateRouteResponseCreateStageCreateVpcLinkDeleteAccessLogSettingsDeleteApiDeleteAuthorizerDeleteCorsConfigurationDeleteDeploymentDeleteIntegrationDeleteIntegrationResponseDeleteModelDeleteRouteDeleteRouteRequestParameterDeleteRouteResponseDeleteRouteSettingsDeleteStageDeleteVpcLinkExportApiGetApiGetApiMappingGetApisGetAuthorizerGetAuthorizersGetDomainNameGetDomainNamesGetIntegrationGetIntegrationResponseGetIntegrationResponsesGetIntegrationsGetModelGetModelsGetModelTemplateGetRouteGetRouteResponseGetRouteResponsesGetRoutesGetStageGetStagesGetTagsGetVpcLinkGetVpcLinksImportApiReimportApiResetAuthorizersCacheTagResourceUntagResourceUpdateApiUpdateApiMappingUpdateAuthorizerUpdateDeploymentUpdateDomainNameUpdateIntegrationUpdateIntegrationResponseUpdateModelUpdateRouteUpdateRouteResponseUpdateVpcLink