Interface GraphQlApiProps

Hierarchy

Properties

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

Additional environment variables of all Lambda functions

Type declaration

  • [key: string]: string
apiHostname?: string

Hostname of the API if a domain name is specified

Default

api
apiName: string

Name of the API

assetCdn?: AssetCdn

Configure a content delivery network for static assets

Default

none

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

Default

none
definitionFileName: string
domainName?: string

Domain name of the API (e.g. example.com)

only one of hostedZone and domainName can be specified

Default

- No custom domain is configured
hostedZone?: IHostedZone

Hosted Zone of the API (e.g. example.com)

only one of hostedZone and domainName can be specified

Default

- No custom domain is configured
lambdaOptions?: LambdaOptions

additional options for the underlying Lambda function construct

lambdaTracing?: LambdaTracingOptions

Tracing config for the generated Lambda functions

monitoring?: boolean

Configure CloudWatch Dashboard for the API and the Lambda functions

Default

true
singleTableDatastore?: SingleTableDatastore

Default

none
stageName: string

Deployment stage (e.g. dev)

Generated using TypeDoc