interface HttpRouteProps

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.HttpRouteProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#HttpRouteProps
Java	software.amazon.awscdk.services.apigatewayv2.HttpRouteProps
Python	aws_cdk.aws_apigatewayv2.HttpRouteProps
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » HttpRouteProps

Properties to initialize a new Route.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';

declare const httpApi: apigatewayv2.HttpApi;
declare const httpRouteAuthorizer: apigatewayv2.IHttpRouteAuthorizer;
declare const httpRouteIntegration: apigatewayv2.HttpRouteIntegration;
declare const httpRouteKey: apigatewayv2.HttpRouteKey;
const httpRouteProps: apigatewayv2.HttpRouteProps = {
  httpApi: httpApi,
  integration: httpRouteIntegration,
  routeKey: httpRouteKey,

  // the properties below are optional
  authorizationScopes: ['authorizationScopes'],
  authorizer: httpRouteAuthorizer,
};

Properties

Name	Type	Description
httpApi	IHttpApi	the API the route is associated with.
integration	HttpRouteIntegration	The integration to be configured on this route.
routeKey	HttpRouteKey	The key to this route.
authorizationScopes?	string[]	The list of OIDC scopes to include in the authorization.
authorizer?	IHttpRouteAuthorizer	Authorizer for a WebSocket API or an HTTP API.

---

httpApi

Type: IHttpApi

the API the route is associated with.

---

integration

Type: HttpRouteIntegration

The integration to be configured on this route.

---

routeKey

Type: HttpRouteKey

The key to this route.

This is a combination of an HTTP method and an HTTP path.

---

authorizationScopes?

Type: string[] (optional, default: no additional authorization scopes)

The list of OIDC scopes to include in the authorization.

These scopes will be merged with the scopes from the attached authorizer

---

authorizer?

Type: IHttpRouteAuthorizer (optional, default: No authorizer)

Authorizer for a WebSocket API or an HTTP API.