@aws-cdk_aws-apigatewayv2-alpha.HttpRouteProps

interface HttpRouteProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.HttpRouteProps
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#HttpRouteProps
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.HttpRouteProps
Pythonaws_cdk.aws_apigatewayv2_alpha.HttpRouteProps
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป 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 * as apigatewayv2_alpha from '@aws-cdk/aws-apigatewayv2-alpha';

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

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

Properties

NameTypeDescription
httpApi๐Ÿ”นIHttpApithe API the route is associated with.
integration๐Ÿ”นHttpRouteIntegrationThe integration to be configured on this route.
routeKey๐Ÿ”นHttpRouteKeyThe key to this route.
authorizationScopes?๐Ÿ”นstring[]The list of OIDC scopes to include in the authorization.
authorizer?๐Ÿ”นIHttpRouteAuthorizerAuthorizer 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.