Package software.amazon.awscdk.services.apigatewayv2
package software.amazon.awscdk.services.apigatewayv2
AWS::ApiGatewayV2 Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.apigatewayv2.*;
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for ApiGatewayV2 construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::ApiGatewayV2 resources directly.
An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:
@aws-cdk/aws-apigatewayv2-alpha
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::ApiGatewayV2.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
-
ClassDescriptionThe
AWS::ApiGatewayV2::Apiresource creates an API.TheBodyS3Locationproperty specifies an S3 location from which to import an OpenAPI definition.A builder forCfnApi.BodyS3LocationPropertyAn implementation forCfnApi.BodyS3LocationPropertyA fluent builder forCfnApi.TheCorsproperty specifies a CORS configuration for an API.A builder forCfnApi.CorsPropertyAn implementation forCfnApi.CorsPropertyTheAWS::ApiGatewayV2::ApiGatewayManagedOverridesresource overrides the default properties of API Gateway-managed resources that are implicitly configured for you when you use quick create.TheAccessLogSettingsproperty overrides the access log settings for an API Gateway-managed stage.A builder forCfnApiGatewayManagedOverrides.AccessLogSettingsPropertyAn implementation forCfnApiGatewayManagedOverrides.AccessLogSettingsPropertyA fluent builder forCfnApiGatewayManagedOverrides.TheIntegrationOverridesproperty overrides the integration settings for an API Gateway-managed integration.An implementation forCfnApiGatewayManagedOverrides.IntegrationOverridesPropertyTheRouteOverridesproperty overrides the route configuration for an API Gateway-managed route.A builder forCfnApiGatewayManagedOverrides.RouteOverridesPropertyAn implementation forCfnApiGatewayManagedOverrides.RouteOverridesPropertyTheRouteSettingsproperty overrides the route settings for an API Gateway-managed route.A builder forCfnApiGatewayManagedOverrides.RouteSettingsPropertyAn implementation forCfnApiGatewayManagedOverrides.RouteSettingsPropertyTheStageOverridesproperty overrides the stage configuration for an API Gateway-managed stage.A builder forCfnApiGatewayManagedOverrides.StageOverridesPropertyAn implementation forCfnApiGatewayManagedOverrides.StageOverridesPropertyProperties for defining aCfnApiGatewayManagedOverrides.A builder forCfnApiGatewayManagedOverridesPropsAn implementation forCfnApiGatewayManagedOverridesPropsTheAWS::ApiGatewayV2::ApiMappingresource contains an API mapping.A fluent builder forCfnApiMapping.Properties for defining aCfnApiMapping.A builder forCfnApiMappingPropsAn implementation forCfnApiMappingPropsProperties for defining aCfnApi.A builder forCfnApiPropsAn implementation forCfnApiPropsTheAWS::ApiGatewayV2::Authorizerresource creates an authorizer for a WebSocket API or an HTTP API.A fluent builder forCfnAuthorizer.TheJWTConfigurationproperty specifies the configuration of a JWT authorizer.A builder forCfnAuthorizer.JWTConfigurationPropertyAn implementation forCfnAuthorizer.JWTConfigurationPropertyProperties for defining aCfnAuthorizer.A builder forCfnAuthorizerPropsAn implementation forCfnAuthorizerPropsTheAWS::ApiGatewayV2::Deploymentresource creates a deployment for an API.A fluent builder forCfnDeployment.Properties for defining aCfnDeployment.A builder forCfnDeploymentPropsAn implementation forCfnDeploymentPropsTheAWS::ApiGatewayV2::DomainNameresource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).A fluent builder forCfnDomainName.TheDomainNameConfigurationproperty type specifies the configuration for an API's domain name.A builder forCfnDomainName.DomainNameConfigurationPropertyAn implementation forCfnDomainName.DomainNameConfigurationPropertyIf specified, API Gateway performs two-way authentication between the client and the server.A builder forCfnDomainName.MutualTlsAuthenticationPropertyAn implementation forCfnDomainName.MutualTlsAuthenticationPropertyProperties for defining aCfnDomainName.A builder forCfnDomainNamePropsAn implementation forCfnDomainNamePropsTheAWS::ApiGatewayV2::Integrationresource creates an integration for an API.A fluent builder forCfnIntegration.Specifies a list of response parameters for an HTTP API.A builder forCfnIntegration.ResponseParameterListPropertyAn implementation forCfnIntegration.ResponseParameterListPropertySupported only for HTTP APIs.A builder forCfnIntegration.ResponseParameterPropertyAn implementation forCfnIntegration.ResponseParameterPropertyTheTlsConfigproperty specifies the TLS configuration for a private integration.A builder forCfnIntegration.TlsConfigPropertyAn implementation forCfnIntegration.TlsConfigPropertyProperties for defining aCfnIntegration.A builder forCfnIntegrationPropsAn implementation forCfnIntegrationPropsTheAWS::ApiGatewayV2::IntegrationResponseresource updates an integration response for an WebSocket API.A fluent builder forCfnIntegrationResponse.Properties for defining aCfnIntegrationResponse.A builder forCfnIntegrationResponsePropsAn implementation forCfnIntegrationResponsePropsTheAWS::ApiGatewayV2::Modelresource updates data model for a WebSocket API.A fluent builder forCfnModel.Properties for defining aCfnModel.A builder forCfnModelPropsAn implementation forCfnModelPropsTheAWS::ApiGatewayV2::Routeresource creates a route for an API.A fluent builder forCfnRoute.Example:A builder forCfnRoute.ParameterConstraintsPropertyAn implementation forCfnRoute.ParameterConstraintsPropertyProperties for defining aCfnRoute.A builder forCfnRoutePropsAn implementation forCfnRoutePropsTheAWS::ApiGatewayV2::RouteResponseresource creates a route response for a WebSocket API.A fluent builder forCfnRouteResponse.Specifies whether the parameter is required.A builder forCfnRouteResponse.ParameterConstraintsPropertyAn implementation forCfnRouteResponse.ParameterConstraintsPropertyProperties for defining aCfnRouteResponse.A builder forCfnRouteResponsePropsAn implementation forCfnRouteResponsePropsTheAWS::ApiGatewayV2::Stageresource specifies a stage for an API.Settings for logging access in a stage.A builder forCfnStage.AccessLogSettingsPropertyAn implementation forCfnStage.AccessLogSettingsPropertyA fluent builder forCfnStage.Represents a collection of route settings.A builder forCfnStage.RouteSettingsPropertyAn implementation forCfnStage.RouteSettingsPropertyProperties for defining aCfnStage.A builder forCfnStagePropsAn implementation forCfnStagePropsTheAWS::ApiGatewayV2::VpcLinkresource creates a VPC link.A fluent builder forCfnVpcLink.Properties for defining aCfnVpcLink.A builder forCfnVpcLinkPropsAn implementation forCfnVpcLinkProps