Header menu logo FsCDK

HttpApiConfig Type

High-level API Gateway V2 HTTP API builder following AWS best practices. **Default Security Settings:** - CORS = disabled (opt-in for specific origins) - Auto-deploy = true **Rationale:** These defaults follow AWS Well-Architected Framework: - CORS disabled by default prevents unauthorized cross-origin access - HTTP API provides low-latency, cost-effective API Gateway - Auto-deploy simplifies deployment workflow **Escape Hatch:** Access the underlying CDK HttpApi via the `Api` property for advanced scenarios not covered by this builder.

Record fields

Record Field Description

ApiName

Full Usage: ApiName

Field type: string
Field type: string

ConstructId

Full Usage: ConstructId

Field type: string option
Field type: string option

CorsPreflightOptions

Full Usage: CorsPreflightOptions

Field type: CorsPreflightOptions option
Field type: CorsPreflightOptions option

CreateDefaultStage

Full Usage: CreateDefaultStage

Field type: bool voption
Field type: bool voption

Description

Full Usage: Description

Field type: string option
Field type: string option

Type something to start searching.