HttpApiProps Struct
Properties to initialize an instance of HttpApi.
Example
ts
import { HttpAlbIntegration } from 'aws-cdk-lib/aws-apigatewayv2-integrations';
declare const lb: elbv2.ApplicationLoadBalancer;
const listener = lb.addListener('listener', { port: 80 });
listener.addTargets('target', {
port: 80,
});
const httpEndpoint = new apigwv2.HttpApi(this, 'HttpProxyPrivateApi', {
defaultIntegration: new HttpAlbIntegration('DefaultIntegration', listener, {
parameterMapping: new apigwv2.ParameterMapping().custom('myKey', 'myValue'),
}),
});
Properties
apiNameoptionalstringapi_nameoptionalstrapiNameoptionalStringApiNameoptionalstringApiNameoptional*string#Name for the HTTP API resource.
Default: id of the HttpApi construct.
corsPreflightoptionalCorsPreflightOptionscors_preflightoptionalCorsPreflightOptionscorsPreflightoptionalCorsPreflightOptionsCorsPreflightoptionalCorsPreflightOptionsCorsPreflightoptionalCorsPreflightOptions#Specifies a CORS configuration for an API.
Default: CORS disabled.
createDefaultStageoptionalbooleancreate_default_stageoptionalboolcreateDefaultStageoptionalBooleanCreateDefaultStageoptionalboolCreateDefaultStageoptional*bool= true#Whether a default stage and deployment should be automatically created.
defaultAuthorizationScopesoptionalstring[]default_authorization_scopesoptionaltyping.List[str]defaultAuthorizationScopesoptionalList<String>DefaultAuthorizationScopesoptionalstring[]DefaultAuthorizationScopesoptional*[]*string#Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.
Default: no default authorization scopes
The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.
defaultAuthorizeroptionalIHttpRouteAuthorizerdefault_authorizeroptionalIHttpRouteAuthorizerdefaultAuthorizeroptionalIHttpRouteAuthorizerDefaultAuthorizeroptionalIHttpRouteAuthorizerDefaultAuthorizeroptionalIHttpRouteAuthorizer#Default Authorizer applied to all routes in the gateway.
Default: no default authorizer
defaultDomainMappingoptionalDomainMappingOptionsdefault_domain_mappingoptionalDomainMappingOptionsdefaultDomainMappingoptionalDomainMappingOptionsDefaultDomainMappingoptionalDomainMappingOptionsDefaultDomainMappingoptionalDomainMappingOptions#Configure a custom domain with the API mapping resource to the HTTP API.
Default: no default domain mapping configured. meaningless if createDefaultStage is false.
defaultIntegrationoptionalHttpRouteIntegrationdefault_integrationoptionalHttpRouteIntegrationdefaultIntegrationoptionalHttpRouteIntegrationDefaultIntegrationoptionalHttpRouteIntegrationDefaultIntegrationoptionalHttpRouteIntegration= none#An integration that will be configured on the catch-all route ($default).
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= none#The description of the API.
disableExecuteApiEndpointoptionalbooleandisable_execute_api_endpointoptionalbooldisableExecuteApiEndpointoptionalBooleanDisableExecuteApiEndpointoptionalboolDisableExecuteApiEndpointoptional*bool#Specifies whether clients can invoke your API using the default endpoint.
Default: false execute-api endpoint enabled.
By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. Set this to true if you would like clients to use your custom domain name.
ipAddressTypeoptionalIpAddressTypeip_address_typeoptionalIpAddressTypeipAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressTypeIpAddressTypeoptionalIpAddressType#The IP address types that can invoke the API.
Default: undefined - AWS default is IPV4
routeSelectionExpressionoptionalbooleanroute_selection_expressionoptionalboolrouteSelectionExpressionoptionalBooleanRouteSelectionExpressionoptionalboolRouteSelectionExpressionoptional*bool= false#Whether to set the default route selection expression for the API.
When enabled, "${request.method} ${request.path}" is set as the default route selection expression.