Package software.amazon.awscdk.services.apigatewayv2

Interface IHttpRoute

All Superinterfaces:
IConstruct, software.constructs.IConstruct, IDependable, IResource, IRoute, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IHttpRoute.Jsii$Default
All Known Implementing Classes:
HttpRoute, IHttpRoute.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.300Z") @Stability(Experimental) public interface IHttpRoute extends software.amazon.jsii.JsiiSerializable, IRoute
(experimental) Represents a Route for an HTTP API.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IHttpRoute.Jsii$Default
    Internal default implementation for IHttpRoute.
    static final class 
    IHttpRoute.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    IHttpApi
    getHttpApi()
    (experimental) The HTTP API associated with this route.
    default String
    getPath()
    (experimental) Returns the path component of this HTTP route, undefined if the path is the catch-all route.
    String
    getRouteArn()
    (experimental) Returns the arn of the route.
    Grant
    grantInvoke(IGrantable grantee)
    (experimental) Grant access to invoke the route.
    Grant
    grantInvoke(IGrantable grantee, GrantInvokeOptions options)
    (experimental) Grant access to invoke the route.

    Methods inherited from interface software.amazon.awscdk.core.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.core.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.IRoute

    getRouteId

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getHttpApi

      @Stability(Experimental) @NotNull IHttpApi getHttpApi()
      (experimental) The HTTP API associated with this route.

    • getRouteArn

      @Stability(Experimental) @NotNull String getRouteArn()
      (experimental) Returns the arn of the route.

    • getPath

      @Stability(Experimental) @Nullable default String getPath()
      (experimental) Returns the path component of this HTTP route, undefined if the path is the catch-all route.

    • grantInvoke

      @Stability(Experimental) @NotNull Grant grantInvoke(@NotNull IGrantable grantee, @Nullable GrantInvokeOptions options)
      (experimental) Grant access to invoke the route.

      This method requires that the authorizer of the route is undefined or is an HttpIamAuthorizer.

      Parameters:
      grantee - This parameter is required.
      options -

    • grantInvoke

      @Stability(Experimental) @NotNull Grant grantInvoke(@NotNull IGrantable grantee)
      (experimental) Grant access to invoke the route.

      This method requires that the authorizer of the route is undefined or is an HttpIamAuthorizer.

      Parameters:
      grantee - This parameter is required.