Interface X8RestApiProps

Rest Api Properties

Hierarchy

  • X8RestApiProps

Properties

x8AccessLogsBucket?: WaBucket

Access Logs Bucket to override defaults

Default

No access logs are written

x8ApiGatewayCachePolicy?: CachePolicy

API Gateway Cache Policy to override defaults

Default

A new cache policy is generated

x8ApiGatewayOriginRequestPolicy?: OriginRequestPolicy

API Gateway Origin Request Policy to override defaults

Default

A new request policy is generated

x8ApiGatewayWafProps?: WaApiGatewayWafProps

Api Gateway WAF properties to override defaults

Default

A new WAF is created that checks X-Origin-Verify header

x8ApiProps?: WaRestApiProps

Rest API properties to override defaults

x8CloudFrontSecret?: Secret

CLoudFront secret to use with X-Origin-Verify header

Default

Secret is generated and stored in SSM

x8CloudfrontAllowedMethods?: AllowedMethods

CloudFront allowed methods to override defaults

Default

AllowedMethods.ALLOW_ALL

x8CloudfrontWafProps?: WaCloudfrontWafProps

CloudFront WAF properties to override defaults

x8DistributionProps?: WaDistributionProps

CloudFront Distribution properties to override defaults

x8DomainName: string

Domain name e.g. example.com there must be a hosted zone existing for this domain name

x8SubDomain?: string

Sub domain e.g. api.

Default

api

Generated using TypeDoc