Optional
additionalOptional
apiHostname of the API if a domain name is specified
api
Name of the API
Optional
assetConfigure a content delivery network for static assets
none
Optional
authenticationUse a Cognito user pool for authorization. Alternatively supply a JWT issuer and audience to use any other JWT-based authorization service.
none
Optional
autoGenerate routes for all endpoints configured in the openapi.yaml file
true
Optional
domainDomain name of the API (e.g. example.com)
only one of hostedZone and domainName can be specified
- No custom domain is configured
Optional
hostedHosted Zone of the API (e.g. example.com)
only one of hostedZone and domainName can be specified
- No custom domain is configured
Optional
lambdaadditional options for the underlying Lambda function construct
Optional
lambdaadditional options for the underlying Lambda function construct per operationId
-
Optional
lambdaTracing config for the generated Lambda functions
Optional
monitoringConfigure CloudWatch Dashboard for the API and the Lambda functions
true
Optional
restcustom options for the created HttpApi
-
Optional
singlenone
Deployment stage (e.g. dev)
Generated using TypeDoc
Additional environment variables of all Lambda functions