Interface HttpRouteProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.290Z") @Stability(Experimental) public interface HttpRouteProps extends, BatchHttpRouteOptions
(experimental) Properties to initialize a new Route.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 HttpApi httpApi;
 IHttpRouteAuthorizer httpRouteAuthorizer;
 HttpRouteIntegration httpRouteIntegration;
 HttpRouteKey httpRouteKey;
 HttpRouteProps httpRouteProps = HttpRouteProps.builder()
         // the properties below are optional
  • Method Details

    • getHttpApi

      @Stability(Experimental) @NotNull IHttpApi getHttpApi()
      (experimental) the API the route is associated with.
    • getRouteKey

      @Stability(Experimental) @NotNull HttpRouteKey getRouteKey()
      (experimental) The key to this route.

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

    • getAuthorizationScopes

      @Stability(Experimental) @Nullable default List<String> getAuthorizationScopes()
      (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

    • getAuthorizer

      @Stability(Experimental) @Nullable default IHttpRouteAuthorizer getAuthorizer()
      (experimental) Authorizer for a WebSocket API or an HTTP API.

      Default: - No authorizer

    • builder

      @Stability(Experimental) static HttpRouteProps.Builder builder()
      a HttpRouteProps.Builder of HttpRouteProps