IHttpRoute

class aws_cdk.aws_apigatewayv2.IHttpRoute(*args, **kwds)

Bases: aws_cdk.aws_apigatewayv2.IRoute, typing_extensions.Protocol

(experimental) Represents a Route for an HTTP API.

Stability

experimental

Methods

apply_removal_policy(policy)

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).

Parameters

policy (RemovalPolicy) –

Return type

None

grant_invoke(grantee, *, http_methods=None)

(experimental) Grant access to invoke the route.

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

Parameters
  • grantee (IGrantable) –

  • http_methods (Optional[Sequence[HttpMethod]]) – (experimental) The HTTP methods to allow. Default: - the HttpMethod of the route

Stability

experimental

Return type

Grant

Attributes

env

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.

Return type

ResourceEnvironment

http_api

(experimental) The HTTP API associated with this route.

Stability

experimental

Return type

IHttpApi

node

The construct tree node for this construct.

Return type

ConstructNode

path

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

Stability

experimental

Return type

Optional[str]

route_arn

(experimental) Returns the arn of the route.

Stability

experimental

Attribute

true

Return type

str

route_id

(experimental) Id of the Route.

Stability

experimental

Attribute

true

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack