AWS Fundamentals Logo
AWS Fundamentals
L1 Construct

CfnHttpApi

https://github.com/aws/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlesshttpapi.

Import

import { CfnHttpApi } from 'aws-cdk-lib/aws-sam';

Or use the module namespace:

import * as sam from 'aws-cdk-lib/aws-sam';
// sam.CfnHttpApi

Properties

Configuration passed to the constructor as CfnHttpApiProps.

accessLogSettingOptional
IResolvable | AccessLogSettingProperty
authOptional
IResolvable | HttpApiAuthProperty
corsConfigurationOptional
boolean | IResolvable | CorsConfigurationObjectProperty
defaultRouteSettingsOptional
IResolvable | RouteSettingsProperty
definitionBodyOptional
any
definitionUriOptional
string | IResolvable | S3LocationProperty
descriptionOptional
string
disableExecuteApiEndpointOptional
boolean | IResolvable
domainOptional
IResolvable | HttpApiDomainConfigurationProperty
failOnWarningsOptional
boolean | IResolvable
routeSettingsOptional
IResolvable | RouteSettingsProperty
stageNameOptional
string
stageVariablesOptional
{ [key: string]: string } | IResolvable
tagsOptional
{ [key: string]: string }

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-sam
Properties14

External Links