HttpRouteKey

class aws_cdk.aws_apigatewayv2.HttpRouteKey(*args: Any, **kwargs)

Bases: object

(experimental) HTTP route in APIGateway is a combination of the HTTP method and the path component.

This class models that combination.

Stability

experimental

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigatewayv2 as apigatewayv2

http_route_key = apigatewayv2.HttpRouteKey.with("path", apigatewayv2.HttpMethod.ANY)

Attributes

DEFAULT = <aws_cdk.aws_apigatewayv2.HttpRouteKey object>
key

(experimental) The key to the RouteKey as recognized by APIGateway.

Stability

experimental

Return type

str

method

(experimental) The method of the route.

Stability

experimental

Return type

HttpMethod

path

(experimental) The path part of this RouteKey.

Returns undefined when RouteKey.DEFAULT is used.

Stability

experimental

Return type

Optional[str]

Static Methods

classmethod with_(path, method=None)

(experimental) Create a route key with the combination of the path and the method.

Parameters
  • path (str) –

  • method (Optional[HttpMethod]) – default is ‘ANY’.

Stability

experimental

Return type

HttpRouteKey