Interface IHttpRoute
(experimental) Represents a Route for an HTTP API.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface IHttpRoute : IRoute, IResource, IConstruct, IDependable
Syntax (vb)
Public Interface IHttpRoute
Inherits IRoute, IResource, IConstruct, IConstruct, IDependable
Remarks
Stability: Experimental
Synopsis
Properties
HttpApi | (experimental) The HTTP API associated with this route. |
Path | (experimental) Returns the path component of this HTTP route, |
RouteArn | (experimental) Returns the arn of the route. |
Methods
GrantInvoke(IGrantable, IGrantInvokeOptions) | (experimental) Grant access to invoke the route. |
Properties
HttpApi
(experimental) The HTTP API associated with this route.
IHttpApi HttpApi { get; }
Property Value
Remarks
Stability: Experimental
Path
(experimental) Returns the path component of this HTTP route, undefined
if the path is the catch-all route.
virtual string Path { get; }
Property Value
System.String
Remarks
Stability: Experimental
RouteArn
(experimental) Returns the arn of the route.
string RouteArn { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
Methods
GrantInvoke(IGrantable, IGrantInvokeOptions)
(experimental) Grant access to invoke the route.
Grant GrantInvoke(IGrantable grantee, IGrantInvokeOptions options = null)
Parameters
- grantee IGrantable
- options IGrantInvokeOptions
Returns
Remarks
This method requires that the authorizer of the route is undefined or is
an HttpIamAuthorizer
.
Stability: Experimental