HttpRouteProps

class aws_cdk.aws_apigatewayv2.HttpRouteProps(*, integration, http_api, route_key, authorization_scopes=None, authorizer=None)

Bases: aws_cdk.aws_apigatewayv2.BatchHttpRouteOptions

(experimental) Properties to initialize a new Route.

Parameters
  • integration (IHttpRouteIntegration) – (experimental) The integration to be configured on this route.

  • http_api (IHttpApi) – (experimental) the API the route is associated with.

  • route_key (HttpRouteKey) – (experimental) The key to this route. This is a combination of an HTTP method and an HTTP path.

  • authorization_scopes (Optional[Sequence[str]]) – (experimental) The list of OIDC scopes to include in the authorization. These scopes will be merged with the scopes from the attached authorizer Default: - no additional authorization scopes

  • authorizer (Optional[IHttpRouteAuthorizer]) – (experimental) Authorizer for a WebSocket API or an HTTP API. Default: - No authorizer

Stability

experimental

Attributes

authorization_scopes

(experimental) The list of OIDC scopes to include in the authorization.

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

Default
  • no additional authorization scopes

Stability

experimental

Return type

Optional[List[str]]

authorizer

(experimental) Authorizer for a WebSocket API or an HTTP API.

Default
  • No authorizer

Stability

experimental

Return type

Optional[IHttpRouteAuthorizer]

http_api

(experimental) the API the route is associated with.

Stability

experimental

Return type

IHttpApi

integration

(experimental) The integration to be configured on this route.

Stability

experimental

Return type

IHttpRouteIntegration

route_key

(experimental) The key to this route.

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

Stability

experimental

Return type

HttpRouteKey