@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-13T01:13:35.707Z") public class HttpRoute extends Resource implements IHttpRoute
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigatewayv2.*; HttpApi httpApi; IHttpRouteAuthorizer httpRouteAuthorizer; HttpRouteIntegration httpRouteIntegration; HttpRouteKey httpRouteKey; HttpRoute httpRoute = HttpRoute.Builder.create(this, "MyHttpRoute") .httpApi(httpApi) .integration(httpRouteIntegration) .routeKey(httpRouteKey) // the properties below are optional .authorizationScopes(List.of("authorizationScopes")) .authorizer(httpRouteAuthorizer) .build();
Modifier and Type | Class and Description |
---|---|
static class |
HttpRoute.Builder
(experimental) A fluent builder for
HttpRoute . |
IHttpRoute.Jsii$Default, IHttpRoute.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
HttpRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
HttpRoute(software.amazon.jsii.JsiiObjectRef objRef) |
|
HttpRoute(software.constructs.Construct scope,
java.lang.String id,
HttpRouteProps props) |
Modifier and Type | Method and Description |
---|---|
IHttpApi |
getHttpApi()
(experimental) The HTTP API associated with this route.
|
java.lang.String |
getPath()
(experimental) Returns the path component of this HTTP route, `undefined` if the path is the catch-all route.
|
java.lang.String |
getRouteArn()
(experimental) Returns the arn of the route.
|
java.lang.String |
getRouteId()
(experimental) Id 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.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected HttpRoute(software.amazon.jsii.JsiiObjectRef objRef)
protected HttpRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public HttpRoute(software.constructs.Construct scope, java.lang.String id, HttpRouteProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public Grant grantInvoke(IGrantable grantee, GrantInvokeOptions options)
This method requires that the authorizer of the route is undefined or is
an HttpIamAuthorizer
.
grantInvoke
in interface IHttpRoute
grantee
- This parameter is required.options
- public Grant grantInvoke(IGrantable grantee)
This method requires that the authorizer of the route is undefined or is
an HttpIamAuthorizer
.
grantInvoke
in interface IHttpRoute
grantee
- This parameter is required.public IHttpApi getHttpApi()
getHttpApi
in interface IHttpRoute
public java.lang.String getRouteArn()
getRouteArn
in interface IHttpRoute
public java.lang.String getRouteId()
getRouteId
in interface IRoute
public java.lang.String getPath()
getPath
in interface IHttpRoute