software.amazon.awscdk.services.apigatewayv2.alpha

Interface IHttpRoute

All Superinterfaces:

software.constructs.IConstruct, software.constructs.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.74.0 (build 6d08790)",
           date="2023-02-15T19:53:17.414Z")
 @Stability(value=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 and Description
static interface	IHttpRoute.Jsii$Default Internal default implementation for IHttpRoute.
static class	IHttpRoute.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and 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.services.apigatewayv2.alpha.IRoute

getRouteId

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHttpApi

@Stability(value=Experimental)
 @NotNull
IHttpApi getHttpApi()

(experimental) The HTTP API associated with this route.

getRouteArn

@Stability(value=Experimental)
 @NotNull
String getRouteArn()

(experimental) Returns the arn of the route.

getPath

@Stability(value=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(value=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(value=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.