L1 Construct
CfnApi
https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessapi.
Import
import { CfnApi } from 'aws-cdk-lib/aws-sam';Or use the module namespace:
import * as sam from 'aws-cdk-lib/aws-sam';
// sam.CfnApiProperties
Configuration passed to the constructor as CfnApiProps.
stageNameRequiredstringaccessLogSettingOptionalIResolvable | AccessLogSettingPropertyalwaysDeployOptionalboolean | IResolvableauthOptionalIResolvable | AuthPropertybinaryMediaTypesOptionalstring[]cacheClusterEnabledOptionalboolean | IResolvablecacheClusterSizeOptionalstringcanarySettingOptionalIResolvable | CanarySettingPropertycorsOptionalstring | IResolvable | CorsConfigurationPropertydefinitionBodyOptionalanydefinitionUriOptionalstring | IResolvable | S3LocationPropertydescriptionOptionalstringdisableExecuteApiEndpointOptionalboolean | IResolvabledomainOptionalIResolvable | DomainConfigurationPropertyendpointConfigurationOptionalstring | IResolvable | EndpointConfigurationPropertygatewayResponsesOptionalanymethodSettingsOptionalany[] | IResolvableminimumCompressionSizeOptionalnumbermodelsOptionalanynameOptionalstringopenApiVersionOptionalstringtagsOptional{ [key: string]: string }tracingEnabledOptionalboolean | IResolvablevariablesOptional{ [key: string]: string } | IResolvableLearn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
LevelL1 (CloudFormation)
Module
aws-samProperties24