Class HttpRoute
(experimental) Route class that creates the Route for API Gateway HTTP API.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class HttpRoute : Resource, IHttpRoute, IRoute, IResource, IConstruct, IDependable
Syntax (vb)
Public Class HttpRoute
Inherits Resource
Implements IHttpRoute, IRoute, IResource, IConstruct, IDependable
Remarks
Stability: Experimental
Resource: AWS::ApiGatewayV2::Route
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
HttpApi httpApi;
IHttpRouteAuthorizer httpRouteAuthorizer;
HttpRouteIntegration httpRouteIntegration;
HttpRouteKey httpRouteKey;
var httpRoute = new HttpRoute(this, "MyHttpRoute", new HttpRouteProps {
HttpApi = httpApi,
Integration = httpRouteIntegration,
RouteKey = httpRouteKey,
// the properties below are optional
AuthorizationScopes = new [] { "authorizationScopes" },
Authorizer = httpRouteAuthorizer
});
Synopsis
Constructors
HttpRoute(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
HttpRoute(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
HttpRoute(Construct, String, IHttpRouteProps) |
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. |
RouteId | (experimental) Id of the Route. |
Methods
GrantInvoke(IGrantable, IGrantInvokeOptions) | (experimental) Grant access to invoke the route. |
Constructors
HttpRoute(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected HttpRoute(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
HttpRoute(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected HttpRoute(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
HttpRoute(Construct, String, IHttpRouteProps)
public HttpRoute(Construct scope, string id, IHttpRouteProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IHttpRouteProps
Remarks
Stability: Experimental
Properties
HttpApi
(experimental) The HTTP API associated with this route.
public virtual 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.
public virtual string Path { get; }
Property Value
System.String
Remarks
Stability: Experimental
RouteArn
(experimental) Returns the arn of the route.
public virtual string RouteArn { get; }
Property Value
System.String
Remarks
Stability: Experimental
RouteId
(experimental) Id of the Route.
public virtual string RouteId { get; }
Property Value
System.String
Remarks
Stability: Experimental
Methods
GrantInvoke(IGrantable, IGrantInvokeOptions)
(experimental) Grant access to invoke the route.
public virtual 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