Namespace Amazon.CDK.AWS.Apigatewayv2

Classes

AccessLogDestinationConfig	Options when binding a log destination to a HttpApi Stage.
AddApiKeyOptions	Options to the UsagePlan.addApiKey() method.
AddRoutesOptions	Options for the Route with Integration resource.
ApiKey	An API Gateway ApiKey.
ApiKeyOptions	The options for creating an API Key.
ApiKeyProps	ApiKey Properties.
ApiMapping	Create a new API mapping for API Gateway API endpoint.
ApiMappingAttributes	The attributes used to import existing ApiMapping.
ApiMappingProps	Properties used to create the ApiMapping resource.
BatchHttpRouteOptions	Options used when configuring multiple routes, at once.
CfnApi	The AWS::ApiGatewayV2::Api resource creates an API.
CfnApi.BodyS3LocationProperty	The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition.
CfnApi.CorsProperty	The Cors property specifies a CORS configuration for an API.
CfnApiGatewayManagedOverrides	The AWS::ApiGatewayV2::ApiGatewayManagedOverrides resource overrides the default properties of API Gateway-managed resources that are implicitly configured for you when you use quick create.
CfnApiGatewayManagedOverrides.AccessLogSettingsProperty	The AccessLogSettings property overrides the access log settings for an API Gateway-managed stage.
CfnApiGatewayManagedOverrides.IntegrationOverridesProperty	The IntegrationOverrides property overrides the integration settings for an API Gateway-managed integration.
CfnApiGatewayManagedOverrides.RouteOverridesProperty	The RouteOverrides property overrides the route configuration for an API Gateway-managed route.
CfnApiGatewayManagedOverrides.RouteSettingsProperty	The RouteSettings property overrides the route settings for an API Gateway-managed route.
CfnApiGatewayManagedOverrides.StageOverridesProperty	The StageOverrides property overrides the stage configuration for an API Gateway-managed stage.
CfnApiGatewayManagedOverridesProps	Properties for defining a CfnApiGatewayManagedOverrides.
CfnApiMapping	The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping.
CfnApiMappingProps	Properties for defining a CfnApiMapping.
CfnApiProps	Properties for defining a CfnApi.
CfnAuthorizer	The AWS::ApiGatewayV2::Authorizer resource creates an authorizer for a WebSocket API or an HTTP API.
CfnAuthorizer.JWTConfigurationProperty	The JWTConfiguration property specifies the configuration of a JWT authorizer.
CfnAuthorizerProps	Properties for defining a CfnAuthorizer.
CfnDeployment	The AWS::ApiGatewayV2::Deployment resource creates a deployment for an API.
CfnDeploymentProps	Properties for defining a CfnDeployment.
CfnDomainName	The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).
CfnDomainName.DomainNameConfigurationProperty	The DomainNameConfiguration property type specifies the configuration for an API's domain name.
CfnDomainName.MutualTlsAuthenticationProperty	If specified, API Gateway performs two-way authentication between the client and the server.
CfnDomainNameProps	Properties for defining a CfnDomainName.
CfnIntegration	The AWS::ApiGatewayV2::Integration resource creates an integration for an API.
CfnIntegration.ResponseParameterListProperty
CfnIntegration.ResponseParameterMapProperty	map of response parameter lists.
CfnIntegration.ResponseParameterProperty	Supported only for HTTP APIs.
CfnIntegration.TlsConfigProperty	The TlsConfig property specifies the TLS configuration for a private integration.
CfnIntegrationProps	Properties for defining a CfnIntegration.
CfnIntegrationResponse	The AWS::ApiGatewayV2::IntegrationResponse resource updates an integration response for an WebSocket API.
CfnIntegrationResponseProps	Properties for defining a CfnIntegrationResponse.
CfnModel	The AWS::ApiGatewayV2::Model resource updates data model for a WebSocket API.
CfnModelProps	Properties for defining a CfnModel.
CfnRoute	The AWS::ApiGatewayV2::Route resource creates a route for an API.
CfnRoute.ParameterConstraintsProperty
CfnRouteProps	Properties for defining a CfnRoute.
CfnRouteResponse	The AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API.
CfnRouteResponse.ParameterConstraintsProperty	Specifies whether the parameter is required.
CfnRouteResponseProps	Properties for defining a CfnRouteResponse.
CfnRoutingRule	Represents a routing rule.
CfnRoutingRule.ActionInvokeApiProperty	Represents an InvokeApi action.
CfnRoutingRule.ActionProperty	Represents a routing rule action.
CfnRoutingRule.ConditionProperty	Represents a condition.
CfnRoutingRule.MatchBasePathsProperty	Represents a MatchBasePaths condition.
CfnRoutingRule.MatchHeaderValueProperty	Represents a MatchHeaderValue .
CfnRoutingRule.MatchHeadersProperty	Represents a MatchHeaders condition.
CfnRoutingRuleProps	Properties for defining a CfnRoutingRule.
CfnStage	The AWS::ApiGatewayV2::Stage resource specifies a stage for an API.
CfnStage.AccessLogSettingsProperty	Settings for logging access in a stage.
CfnStage.RouteSettingsProperty	Represents a collection of route settings.
CfnStageProps	Properties for defining a CfnStage.
CfnVpcLink	The AWS::ApiGatewayV2::VpcLink resource creates a VPC link.
CfnVpcLinkProps	Properties for defining a CfnVpcLink.
CorsPreflightOptions	Options for the CORS Configuration.
DomainMappingOptions	Options for DomainMapping.
DomainName	Custom domain resource for the API.
DomainNameAttributes	custom domain name attributes.
DomainNameProps	properties used for creating the DomainName.
EndpointOptions	properties for creating a domain name endpoint.
GrantInvokeOptions	Options for granting invoke access.
HttpApi	Create a new API Gateway HTTP API endpoint.
HttpApiAttributes	Attributes for importing an HttpApi into the CDK.
HttpApiHelper	Calculations and operations for HTTP APIs.
HttpApiProps	Properties to initialize an instance of HttpApi.
HttpAuthorizer	An authorizer for Http Apis.
HttpAuthorizerAttributes	Reference to an http authorizer.
HttpAuthorizerProps	Properties to initialize an instance of HttpAuthorizer.
HttpIntegration	The integration for an API route.
HttpIntegrationProps	The integration properties.
HttpNoneAuthorizer	Explicitly configure no authorizers on specific HTTP API routes.
HttpRoute	Route class that creates the Route for API Gateway HTTP API.
HttpRouteAuthorizerBindOptions	Input to the bind() operation, that binds an authorizer to a route.
HttpRouteAuthorizerConfig	Results of binding an authorizer to an http route.
HttpRouteIntegration	The interface that various route integration classes will inherit.
HttpRouteIntegrationBindOptions	Options to the HttpRouteIntegration during its bind operation.
HttpRouteIntegrationConfig	Config returned back as a result of the bind.
HttpRouteKey	HTTP route in APIGateway is a combination of the HTTP method and the path component.
HttpRouteProps	Properties to initialize a new Route.
HttpStage	Represents a stage where an instance of the API is deployed.
HttpStageAttributes	The attributes used to import existing HttpStage.
HttpStageOptions	The options to create a new Stage for an HTTP API.
HttpStageProps	Properties to initialize an instance of HttpStage.
IntegrationCredentials	Credentials used for AWS Service integrations.
LogGroupLogDestination	Use CloudWatch Logs as a custom access log destination for API Gateway.
MTLSConfig	The mTLS authentication configuration for a custom domain name.
MappingValue	Represents a Mapping Value.
ParameterMapping	Represents a Parameter Mapping.
PayloadFormatVersion	Payload format version for lambda proxy integration.
QuotaSettings	Specifies the maximum number of requests that clients can make to API Gateway APIs.
RateLimitedApiKey	An API Gateway ApiKey, for which a rate limiting configuration can be specified.
RateLimitedApiKeyProps	RateLimitedApiKey properties.
StageAttributes	The attributes used to import existing Stage.
StageOptions	Options required to create a new stage.
ThrottleSettings	Container for defining throttling parameters to API stages.
UsagePlan	A UsagePlan.
UsagePlanPerApiStage	Represents the API stages that a usage plan applies to.
UsagePlanProps	Properties for defining an API Gateway Usage Plan for WebSocket APIs.
VpcLink	Define a new VPC Link Specifies an API Gateway VPC link for a HTTP API to access resources in an Amazon Virtual Private Cloud (VPC).
VpcLinkAttributes	Attributes when importing a new VpcLink.
VpcLinkProps	Properties for a VpcLink.
WebSocketApi	Create a new API Gateway WebSocket API endpoint.
WebSocketApiAttributes	Attributes for importing a WebSocketApi into the CDK.
WebSocketApiKeySelectionExpression	Represents the currently available API Key Selection Expressions.
WebSocketApiProps	Props for WebSocket API.
WebSocketAuthorizer	An authorizer for WebSocket Apis.
WebSocketAuthorizerAttributes	Reference to an WebSocket authorizer.
WebSocketAuthorizerProps	Properties to initialize an instance of WebSocketAuthorizer.
WebSocketIntegration	The integration for an API route.
WebSocketIntegrationProps	The integration properties.
WebSocketNoneAuthorizer	Explicitly configure no authorizers on specific WebSocket API routes.
WebSocketRoute	Route class that creates the Route for API Gateway WebSocket API.
WebSocketRouteAuthorizerBindOptions	Input to the bind() operation, that binds an authorizer to a route.
WebSocketRouteAuthorizerConfig	Results of binding an authorizer to an WebSocket route.
WebSocketRouteIntegration	The interface that various route integration classes will inherit.
WebSocketRouteIntegrationBindOptions	Options to the WebSocketRouteIntegration during its bind operation.
WebSocketRouteIntegrationConfig	Config returned back as a result of the bind.
WebSocketRouteOptions	Options used to add route to the API.
WebSocketRouteProps	Properties to initialize a new Route.
WebSocketStage	Represents a stage where an instance of the API is deployed.
WebSocketStageAttributes	The attributes used to import existing WebSocketStage.
WebSocketStageProps	Properties to initialize an instance of WebSocketStage.

Interfaces

CfnApi.IBodyS3LocationProperty	The BodyS3Location property specifies an S3 location from which to import an OpenAPI definition.
CfnApi.ICorsProperty	The Cors property specifies a CORS configuration for an API.
CfnApiGatewayManagedOverrides.IAccessLogSettingsProperty	The AccessLogSettings property overrides the access log settings for an API Gateway-managed stage.
CfnApiGatewayManagedOverrides.IIntegrationOverridesProperty	The IntegrationOverrides property overrides the integration settings for an API Gateway-managed integration.
CfnApiGatewayManagedOverrides.IRouteOverridesProperty	The RouteOverrides property overrides the route configuration for an API Gateway-managed route.
CfnApiGatewayManagedOverrides.IRouteSettingsProperty	The RouteSettings property overrides the route settings for an API Gateway-managed route.
CfnApiGatewayManagedOverrides.IStageOverridesProperty	The StageOverrides property overrides the stage configuration for an API Gateway-managed stage.
CfnAuthorizer.IJWTConfigurationProperty	The JWTConfiguration property specifies the configuration of a JWT authorizer.
CfnDomainName.IDomainNameConfigurationProperty	The DomainNameConfiguration property type specifies the configuration for an API's domain name.
CfnDomainName.IMutualTlsAuthenticationProperty	If specified, API Gateway performs two-way authentication between the client and the server.
CfnIntegration.IResponseParameterListProperty
CfnIntegration.IResponseParameterMapProperty	map of response parameter lists.
CfnIntegration.IResponseParameterProperty	Supported only for HTTP APIs.
CfnIntegration.ITlsConfigProperty	The TlsConfig property specifies the TLS configuration for a private integration.
CfnRoute.IParameterConstraintsProperty
CfnRouteResponse.IParameterConstraintsProperty	Specifies whether the parameter is required.
CfnRoutingRule.IActionInvokeApiProperty	Represents an InvokeApi action.
CfnRoutingRule.IActionProperty	Represents a routing rule action.
CfnRoutingRule.IConditionProperty	Represents a condition.
CfnRoutingRule.IMatchBasePathsProperty	Represents a MatchBasePaths condition.
CfnRoutingRule.IMatchHeaderValueProperty	Represents a MatchHeaderValue .
CfnRoutingRule.IMatchHeadersProperty	Represents a MatchHeaders condition.
CfnStage.IAccessLogSettingsProperty	Settings for logging access in a stage.
CfnStage.IRouteSettingsProperty	Represents a collection of route settings.
IAccessLogDestination	Access log destination for a HttpApi Stage.
IAccessLogDestinationConfig	Options when binding a log destination to a HttpApi Stage.
IAccessLogSettings	Settings for access logging.
IAddApiKeyOptions	Options to the UsagePlan.addApiKey() method.
IAddRoutesOptions	Options for the Route with Integration resource.
IApi	Represents a API Gateway HTTP/WebSocket API.
IApiKey	API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API.
IApiKeyOptions	The options for creating an API Key.
IApiKeyProps	ApiKey Properties.
IApiMapping	Represents an ApiGatewayV2 ApiMapping resource.
IApiMappingAttributes	The attributes used to import existing ApiMapping.
IApiMappingProps	Properties used to create the ApiMapping resource.
IAuthorizer	Represents an Authorizer.
IBatchHttpRouteOptions	Options used when configuring multiple routes, at once.
ICfnApiGatewayManagedOverridesProps	Properties for defining a CfnApiGatewayManagedOverrides.
ICfnApiMappingProps	Properties for defining a CfnApiMapping.
ICfnApiProps	Properties for defining a CfnApi.
ICfnAuthorizerProps	Properties for defining a CfnAuthorizer.
ICfnDeploymentProps	Properties for defining a CfnDeployment.
ICfnDomainNameProps	Properties for defining a CfnDomainName.
ICfnIntegrationProps	Properties for defining a CfnIntegration.
ICfnIntegrationResponseProps	Properties for defining a CfnIntegrationResponse.
ICfnModelProps	Properties for defining a CfnModel.
ICfnRouteProps	Properties for defining a CfnRoute.
ICfnRouteResponseProps	Properties for defining a CfnRouteResponse.
ICfnRoutingRuleProps	Properties for defining a CfnRoutingRule.
ICfnStageProps	Properties for defining a CfnStage.
ICfnVpcLinkProps	Properties for defining a CfnVpcLink.
ICorsPreflightOptions	Options for the CORS Configuration.
IDomainMappingOptions	Options for DomainMapping.
IDomainName	Represents an APIGatewayV2 DomainName.
IDomainNameAttributes	custom domain name attributes.
IDomainNameProps	properties used for creating the DomainName.
IEndpointOptions	properties for creating a domain name endpoint.
IGrantInvokeOptions	Options for granting invoke access.
IHttpApi	Represents an HTTP API.
IHttpApiAttributes	Attributes for importing an HttpApi into the CDK.
IHttpApiProps	Properties to initialize an instance of HttpApi.
IHttpApiRef	Represents a reference to an HTTP API.
IHttpAuthorizer	An authorizer for HTTP APIs.
IHttpAuthorizerAttributes	Reference to an http authorizer.
IHttpAuthorizerProps	Properties to initialize an instance of HttpAuthorizer.
IHttpIntegration	Represents an Integration for an HTTP API.
IHttpIntegrationProps	The integration properties.
IHttpRoute	Represents a Route for an HTTP API.
IHttpRouteAuthorizer	An authorizer that can attach to an Http Route.
IHttpRouteAuthorizerBindOptions	Input to the bind() operation, that binds an authorizer to a route.
IHttpRouteAuthorizerConfig	Results of binding an authorizer to an http route.
IHttpRouteIntegrationBindOptions	Options to the HttpRouteIntegration during its bind operation.
IHttpRouteIntegrationConfig	Config returned back as a result of the bind.
IHttpRouteProps	Properties to initialize a new Route.
IHttpStage	Represents the HttpStage.
IHttpStageAttributes	The attributes used to import existing HttpStage.
IHttpStageOptions	The options to create a new Stage for an HTTP API.
IHttpStageProps	Properties to initialize an instance of HttpStage.
IHttpStageRef	Represents a reference to an HTTP Stage.
IIntegration	Represents an integration to an API Route.
IMTLSConfig	The mTLS authentication configuration for a custom domain name.
IMappingValue	Represents a Mapping Value.
IQuotaSettings	Specifies the maximum number of requests that clients can make to API Gateway APIs.
IRateLimitedApiKeyProps	RateLimitedApiKey properties.
IRoute	Represents a route.
IStage	Represents a Stage.
IStageAttributes	The attributes used to import existing Stage.
IStageOptions	Options required to create a new stage.
IThrottleSettings	Container for defining throttling parameters to API stages.
IUsagePlan	A UsagePlan, either managed by this CDK app, or imported.
IUsagePlanPerApiStage	Represents the API stages that a usage plan applies to.
IUsagePlanProps	Properties for defining an API Gateway Usage Plan for WebSocket APIs.
IVpcLink	Represents an API Gateway VpcLink.
IVpcLinkAttributes	Attributes when importing a new VpcLink.
IVpcLinkProps	Properties for a VpcLink.
IWebSocketApi	Represents a WebSocket API.
IWebSocketApiAttributes	Attributes for importing a WebSocketApi into the CDK.
IWebSocketApiProps	Props for WebSocket API.
IWebSocketApiRef	Represents a reference to an HTTP API.
IWebSocketAuthorizer	An authorizer for WebSocket APIs.
IWebSocketAuthorizerAttributes	Reference to an WebSocket authorizer.
IWebSocketAuthorizerProps	Properties to initialize an instance of WebSocketAuthorizer.
IWebSocketIntegration	Represents an Integration for an WebSocket API.
IWebSocketIntegrationProps	The integration properties.
IWebSocketRoute	Represents a Route for an WebSocket API.
IWebSocketRouteAuthorizer	An authorizer that can attach to an WebSocket Route.
IWebSocketRouteAuthorizerBindOptions	Input to the bind() operation, that binds an authorizer to a route.
IWebSocketRouteAuthorizerConfig	Results of binding an authorizer to an WebSocket route.
IWebSocketRouteIntegrationBindOptions	Options to the WebSocketRouteIntegration during its bind operation.
IWebSocketRouteIntegrationConfig	Config returned back as a result of the bind.
IWebSocketRouteOptions	Options used to add route to the API.
IWebSocketRouteProps	Properties to initialize a new Route.
IWebSocketStage	Represents the WebSocketStage.
IWebSocketStageAttributes	The attributes used to import existing WebSocketStage.
IWebSocketStageProps	Properties to initialize an instance of WebSocketStage.

Enums

AuthorizerPayloadVersion	Payload format version for lambda authorizers.
ContentHandling	Integration content handling.
CorsHttpMethod	Supported CORS HTTP methods.
EndpointType	Endpoint type for a domain name.
HttpAuthorizerType	Supported Authorizer types.
HttpConnectionType	Supported connection types.
HttpIntegrationSubtype	Supported integration subtypes.
HttpIntegrationType	Supported integration types.
HttpMethod	Supported HTTP methods.
IpAddressType	Supported IP Address Types.
PassthroughBehavior	Integration Passthrough Behavior.
Period	Time period for which quota settings apply.
SecurityPolicy	The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.
WebSocketAuthorizerType	Supported Authorizer types.
WebSocketIntegrationType	WebSocket Integration Types.