Interface BaseApiProps

Hierarchy

Properties

additionalEnv? apiName assetCdn? authentication? lambdaOptions? lambdaTracing? monitoring? singleTableDatastore? stageName

Properties

Optional additionalEnv

additionalEnv?: {
    [key: string]: string;
}

Additional environment variables of all Lambda functions

Type declaration

  • [key: string]: string

apiName

apiName: string

Name of the API

Optional assetCdn

assetCdn?: AssetCdn

Configure a content delivery network for static assets

Default

none

Optional authentication

authentication?: IJwtAuthentication | ICognitoAuthentication

Use a Cognito user pool for authorization. Alternatively supply a JWT issuer and audience to use any other JWT-based authorization service.

Default

none

Optional lambdaOptions

lambdaOptions?: LambdaOptions

additional options for the underlying Lambda function construct

Optional lambdaTracing

lambdaTracing?: LambdaTracingOptions

Tracing config for the generated Lambda functions

Optional monitoring

monitoring?: boolean

Configure CloudWatch Dashboard for the API and the Lambda functions

Default

true

Optional singleTableDatastore

singleTableDatastore?: SingleTableDatastore

Default

none

stageName

stageName: string

Deployment stage (e.g. dev)

Settings

Member Visibility

Theme

Generated using TypeDoc