interface IHttpRoute

Language	Type name
.NET	Amazon.CDK.AWS.Apigatewayv2.IHttpRoute
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#IHttpRoute
Java	software.amazon.awscdk.services.apigatewayv2.IHttpRoute
Python	aws_cdk.aws_apigatewayv2.IHttpRoute
TypeScript (source)	aws-cdk-lib » aws_apigatewayv2 » IHttpRoute

Implemented by HttpRoute

Represents a Route for an HTTP API.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
httpApi	IHttpApi	The HTTP API associated with this route.
node	Node	The tree node.
routeArn	string	Returns the arn of the route.
routeId	string	Id of the Route.
stack	Stack	The stack in which this resource is defined.
path?	string	Returns the path component of this HTTP route, undefined if the path is the catch-all route.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

httpApi

Type: IHttpApi

The HTTP API associated with this route.

---

node

Type: Node

The tree node.

---

routeArn

Type: string

Returns the arn of the route.

---

routeId

Type: string

Id of the Route.

---

stack

Type: Stack

The stack in which this resource is defined.

---

path?

Type: string (optional)

Returns the path component of this HTTP route, undefined if the path is the catch-all route.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantInvoke(grantee, options?)	Grant access to invoke the route.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantInvoke(grantee, options?)

public grantInvoke(grantee: IGrantable, options?: GrantInvokeOptions): Grant

Parameters

• grantee IGrantable
• options GrantInvokeOptions

Returns

• Grant

Grant access to invoke the route.

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