Uses of Package
software.amazon.awscdk.services.apigatewayv2
Package
Description
AWS::APIGatewayv2 Construct Library
AWS APIGatewayv2 Authorizers
AWS APIGatewayv2 Integrations
-
ClassDescription(experimental) Options for the Route with Integration resource.A builder for
AddRoutesOptions
(experimental) Create a new API mapping for API Gateway API endpoint.(experimental) A fluent builder forApiMapping
.(experimental) The attributes used to import existing ApiMapping.A builder forApiMappingAttributes
(experimental) Properties used to create the ApiMapping resource.A builder forApiMappingProps
(experimental) Payload format version for lambda authorizers.(experimental) Options used when configuring multiple routes, at once.A builder forBatchHttpRouteOptions
A CloudFormationAWS::ApiGatewayV2::Api
.TheBodyS3Location
property specifies an S3 location from which to import an OpenAPI definition.A builder forCfnApi.BodyS3LocationProperty
A fluent builder forCfnApi
.TheCors
property specifies a CORS configuration for an API.A builder forCfnApi.CorsProperty
A CloudFormationAWS::ApiGatewayV2::ApiGatewayManagedOverrides
.TheAccessLogSettings
property overrides the access log settings for an API Gateway-managed stage.A builder forCfnApiGatewayManagedOverrides.AccessLogSettingsProperty
A fluent builder forCfnApiGatewayManagedOverrides
.TheIntegrationOverrides
property overrides the integration settings for an API Gateway-managed integration.TheRouteOverrides
property overrides the route configuration for an API Gateway-managed route.A builder forCfnApiGatewayManagedOverrides.RouteOverridesProperty
TheRouteSettings
property overrides the route settings for an API Gateway-managed route.A builder forCfnApiGatewayManagedOverrides.RouteSettingsProperty
TheStageOverrides
property overrides the stage configuration for an API Gateway-managed stage.A builder forCfnApiGatewayManagedOverrides.StageOverridesProperty
Properties for defining aCfnApiGatewayManagedOverrides
.A builder forCfnApiGatewayManagedOverridesProps
A CloudFormationAWS::ApiGatewayV2::ApiMapping
.A fluent builder forCfnApiMapping
.Properties for defining aCfnApiMapping
.A builder forCfnApiMappingProps
Properties for defining aCfnApi
.A builder forCfnApiProps
A CloudFormationAWS::ApiGatewayV2::Authorizer
.A fluent builder forCfnAuthorizer
.TheJWTConfiguration
property specifies the configuration of a JWT authorizer.A builder forCfnAuthorizer.JWTConfigurationProperty
Properties for defining aCfnAuthorizer
.A builder forCfnAuthorizerProps
A CloudFormationAWS::ApiGatewayV2::Deployment
.A fluent builder forCfnDeployment
.Properties for defining aCfnDeployment
.A builder forCfnDeploymentProps
A CloudFormationAWS::ApiGatewayV2::DomainName
.A fluent builder forCfnDomainName
.TheDomainNameConfiguration
property type specifies the configuration for a an API's domain name.A builder forCfnDomainName.DomainNameConfigurationProperty
If specified, API Gateway performs two-way authentication between the client and the server.A builder forCfnDomainName.MutualTlsAuthenticationProperty
Properties for defining aCfnDomainName
.A builder forCfnDomainNameProps
A CloudFormationAWS::ApiGatewayV2::Integration
.A fluent builder forCfnIntegration
.Specifies a list of response parameters for an HTTP API.A builder forCfnIntegration.ResponseParameterListProperty
Supported only for HTTP APIs.A builder forCfnIntegration.ResponseParameterProperty
TheTlsConfig
property specifies the TLS configuration for a private integration.A builder forCfnIntegration.TlsConfigProperty
Properties for defining aCfnIntegration
.A builder forCfnIntegrationProps
A CloudFormationAWS::ApiGatewayV2::IntegrationResponse
.A fluent builder forCfnIntegrationResponse
.Properties for defining aCfnIntegrationResponse
.A builder forCfnIntegrationResponseProps
A CloudFormationAWS::ApiGatewayV2::Model
.A fluent builder forCfnModel
.Properties for defining aCfnModel
.A builder forCfnModelProps
A CloudFormationAWS::ApiGatewayV2::Route
.A fluent builder forCfnRoute
.Example:A builder forCfnRoute.ParameterConstraintsProperty
Properties for defining aCfnRoute
.A builder forCfnRouteProps
A CloudFormationAWS::ApiGatewayV2::RouteResponse
.A fluent builder forCfnRouteResponse
.Specifies whether the parameter is required.A builder forCfnRouteResponse.ParameterConstraintsProperty
Properties for defining aCfnRouteResponse
.A builder forCfnRouteResponseProps
A CloudFormationAWS::ApiGatewayV2::Stage
.Settings for logging access in a stage.A builder forCfnStage.AccessLogSettingsProperty
A fluent builder forCfnStage
.Represents a collection of route settings.A builder forCfnStage.RouteSettingsProperty
Properties for defining aCfnStage
.A builder forCfnStageProps
A CloudFormationAWS::ApiGatewayV2::VpcLink
.A fluent builder forCfnVpcLink
.Properties for defining aCfnVpcLink
.A builder forCfnVpcLinkProps
(experimental) Supported CORS HTTP methods.(experimental) Options for the CORS Configuration.A builder forCorsPreflightOptions
(experimental) Options for DomainMapping.A builder forDomainMappingOptions
(experimental) Custom domain resource for the API.(experimental) A fluent builder forDomainName
.(experimental) custom domain name attributes.A builder forDomainNameAttributes
(experimental) properties used for creating the DomainName.A builder forDomainNameProps
(experimental) properties for creating a domain name endpoint.A builder forEndpointOptions
(experimental) Endpoint type for a domain name.(experimental) Options for granting invoke access.A builder forGrantInvokeOptions
(experimental) Create a new API Gateway HTTP API endpoint.(experimental) A fluent builder forHttpApi
.(experimental) Attributes for importing an HttpApi into the CDK.A builder forHttpApiAttributes
(experimental) Properties to initialize an instance ofHttpApi
.A builder forHttpApiProps
(experimental) An authorizer for Http Apis.(experimental) A fluent builder forHttpAuthorizer
.(experimental) Reference to an http authorizer.A builder forHttpAuthorizerAttributes
(experimental) Properties to initialize an instance ofHttpAuthorizer
.A builder forHttpAuthorizerProps
(experimental) Supported Authorizer types.(experimental) Supported connection types.(experimental) The integration for an API route.(experimental) A fluent builder forHttpIntegration
.(experimental) The integration properties.A builder forHttpIntegrationProps
(experimental) Supported integration subtypes.(experimental) Supported integration types.(experimental) Supported HTTP methods.(experimental) Route class that creates the Route for API Gateway HTTP API.(experimental) A fluent builder forHttpRoute
.(experimental) Input to the bind() operation, that binds an authorizer to a route.A builder forHttpRouteAuthorizerBindOptions
(experimental) Results of binding an authorizer to an http route.A builder forHttpRouteAuthorizerConfig
(experimental) The interface that various route integration classes will inherit.(experimental) Options to the HttpRouteIntegration during its bind operation.A builder forHttpRouteIntegrationBindOptions
(experimental) Config returned back as a result of the bind.A builder forHttpRouteIntegrationConfig
(experimental) HTTP route in APIGateway is a combination of the HTTP method and the path component.(experimental) Properties to initialize a new Route.A builder forHttpRouteProps
(experimental) Represents a stage where an instance of the API is deployed.(experimental) A fluent builder forHttpStage
.(experimental) The attributes used to import existing HttpStage.A builder forHttpStageAttributes
(experimental) The options to create a new Stage for an HTTP API.A builder forHttpStageOptions
(experimental) Properties to initialize an instance ofHttpStage
.A builder forHttpStageProps
(experimental) Represents a API Gateway HTTP/WebSocket API.Internal default implementation forIApi
.(experimental) Represents an ApiGatewayV2 ApiMapping resource.Internal default implementation forIApiMapping
.(experimental) Represents an Authorizer.Internal default implementation forIAuthorizer
.(experimental) Represents an APIGatewayV2 DomainName.Internal default implementation forIDomainName
.(experimental) Represents an HTTP API.Internal default implementation forIHttpApi
.(experimental) An authorizer for HTTP APIs.Internal default implementation forIHttpAuthorizer
.(experimental) Represents an Integration for an HTTP API.Internal default implementation forIHttpIntegration
.(experimental) Represents a Route for an HTTP API.Internal default implementation forIHttpRoute
.(experimental) An authorizer that can attach to an Http Route.Internal default implementation forIHttpRouteAuthorizer
.(experimental) Represents the HttpStage.Internal default implementation forIHttpStage
.(experimental) Represents an integration to an API Route.Internal default implementation forIIntegration
.(experimental) Represents a Mapping Value.Internal default implementation forIMappingValue
.(experimental) Credentials used for AWS Service integrations.(experimental) Represents a route.Internal default implementation forIRoute
.(experimental) Represents a Stage.Internal default implementation forIStage
.(experimental) Represents an API Gateway VpcLink.Internal default implementation forIVpcLink
.(experimental) Represents a WebSocket API.Internal default implementation forIWebSocketApi
.(experimental) An authorizer for WebSocket APIs.Internal default implementation forIWebSocketAuthorizer
.(experimental) Represents an Integration for an WebSocket API.Internal default implementation forIWebSocketIntegration
.(experimental) Represents a Route for an WebSocket API.Internal default implementation forIWebSocketRoute
.(experimental) An authorizer that can attach to an WebSocket Route.Internal default implementation forIWebSocketRouteAuthorizer
.(experimental) Represents the WebSocketStage.Internal default implementation forIWebSocketStage
.(experimental) Represents a Mapping Value.(experimental) The mTLS authentication configuration for a custom domain name.A builder forMTLSConfig
(experimental) Represents a Parameter Mapping.(experimental) Payload format version for lambda proxy integration.(experimental) The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.(experimental) The attributes used to import existing Stage.A builder forStageAttributes
(experimental) Options required to create a new stage.A builder forStageOptions
(experimental) Container for defining throttling parameters to API stages.A builder forThrottleSettings
(experimental) 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).(experimental) A fluent builder forVpcLink
.(experimental) Attributes when importing a new VpcLink.A builder forVpcLinkAttributes
(experimental) Properties for a VpcLink.A builder forVpcLinkProps
(experimental) Create a new API Gateway WebSocket API endpoint.(experimental) A fluent builder forWebSocketApi
.(experimental) Attributes for importing a WebSocketApi into the CDK.A builder forWebSocketApiAttributes
(experimental) Represents the currently available API Key Selection Expressions.(experimental) Props for WebSocket API.A builder forWebSocketApiProps
(experimental) An authorizer for WebSocket Apis.(experimental) A fluent builder forWebSocketAuthorizer
.(experimental) Reference to an WebSocket authorizer.A builder forWebSocketAuthorizerAttributes
(experimental) Properties to initialize an instance ofWebSocketAuthorizer
.A builder forWebSocketAuthorizerProps
(experimental) Supported Authorizer types.(experimental) The integration for an API route.(experimental) A fluent builder forWebSocketIntegration
.(experimental) The integration properties.A builder forWebSocketIntegrationProps
(experimental) WebSocket Integration Types.(experimental) Route class that creates the Route for API Gateway WebSocket API.(experimental) A fluent builder forWebSocketRoute
.(experimental) Input to the bind() operation, that binds an authorizer to a route.A builder forWebSocketRouteAuthorizerBindOptions
(experimental) Results of binding an authorizer to an WebSocket route.A builder forWebSocketRouteAuthorizerConfig
(experimental) The interface that various route integration classes will inherit.(experimental) Options to the WebSocketRouteIntegration during its bind operation.A builder forWebSocketRouteIntegrationBindOptions
(experimental) Config returned back as a result of the bind.A builder forWebSocketRouteIntegrationConfig
(experimental) Options used to add route to the API.A builder forWebSocketRouteOptions
(experimental) Properties to initialize a new Route.A builder forWebSocketRouteProps
(experimental) Represents a stage where an instance of the API is deployed.(experimental) A fluent builder forWebSocketStage
.(experimental) The attributes used to import existing WebSocketStage.A builder forWebSocketStageAttributes
(experimental) Properties to initialize an instance ofWebSocketStage
.A builder forWebSocketStageProps
-
ClassDescription(experimental) Input to the bind() operation, that binds an authorizer to a route.(experimental) Results of binding an authorizer to an http route.(experimental) An authorizer that can attach to an Http Route.(experimental) An authorizer that can attach to an WebSocket Route.(experimental) Input to the bind() operation, that binds an authorizer to a route.(experimental) Results of binding an authorizer to an WebSocket route.
-
ClassDescription(experimental) Supported connection types.(experimental) Supported integration types.(experimental) Supported HTTP methods.(experimental) The interface that various route integration classes will inherit.(experimental) Options to the HttpRouteIntegration during its bind operation.(experimental) Config returned back as a result of the bind.(experimental) Represents an API Gateway VpcLink.(experimental) Represents a Parameter Mapping.(experimental) Payload format version for lambda proxy integration.(experimental) The interface that various route integration classes will inherit.(experimental) Options to the WebSocketRouteIntegration during its bind operation.(experimental) Config returned back as a result of the bind.