RestApiConfig (FsCDK)

RestApiConfig Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj
All Interfaces: IEquatable<RestApiConfig> , IStructuralEquatable

High-level API Gateway REST API builder following AWS best practices. **Default Security Settings:** - Endpoint type = REGIONAL (recommended for most use cases) - Deploy = true (automatically creates deployment) - CloudWatch role = automatically configured **Rationale:** REST APIs provide full control over API Gateway features including: - Request/response transformation - API keys and usage plans - Request validators - VPC Link integration - Custom authorizers **Escape Hatch:** Access the underlying CDK RestApi via the `RestApi` property on RestApiSpec for advanced scenarios not covered by this builder.

Record fields

Record Field	Description
`ApiKeySourceType` Full Usage: `ApiKeySourceType` Field type: `ApiKeySourceType option`	Field type: `ApiKeySourceType option`
`ApiName` Full Usage: `ApiName` Field type: `string`	Field type: `string`
`BinaryMediaTypes` Full Usage: `BinaryMediaTypes` Field type: `string list`	Field type: `string list`
`CloudWatchRole` Full Usage: `CloudWatchRole` Field type: `bool option`	Field type: `bool option`
`ConstructId` Full Usage: `ConstructId` Field type: `string option`	Field type: `string option`
`DefaultCorsPreflightOptions` Full Usage: `DefaultCorsPreflightOptions` Field type: `CorsOptions option`	Field type: `CorsOptions option`
`DefaultIntegration` Full Usage: `DefaultIntegration` Field type: `Integration option`	Field type: `Integration option`
`DefaultMethodOptions` Full Usage: `DefaultMethodOptions` Field type: `MethodOptions option`	Field type: `MethodOptions option`
`Deploy` Full Usage: `Deploy` Field type: `bool option`	Field type: `bool option`
`DeployOptions` Full Usage: `DeployOptions` Field type: `StageOptions option`	Field type: `StageOptions option`
`Description` Full Usage: `Description` Field type: `string option`	Field type: `string option`
`DisableExecuteApiEndpoint` Full Usage: `DisableExecuteApiEndpoint` Field type: `bool option`	Field type: `bool option`
`EndpointTypes` Full Usage: `EndpointTypes` Field type: `EndpointType list`	Field type: `EndpointType list`
`MinimumCompressionSize` Full Usage: `MinimumCompressionSize` Field type: `Size option`	Field type: `Size option`
`Policy` Full Usage: `Policy` Field type: `PolicyDocument option`	Field type: `PolicyDocument option`