HttpApiHelper

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

Bases: object

Calculations and operations for HTTP APIs.

ExampleMetadata:

fixture=_generated

Example:

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

# http_api_ref: apigatewayv2.IHttpApiRef

http_api_helper = apigatewayv2.HttpApiHelper.from_http_api(http_api_ref)

Methods

arn_for_execute_api(method=None, path=None, stage=None)

Get the “execute-api” ARN.

When ‘ANY’ is passed to the method, an ARN with the method set to ‘*’ is obtained.

Parameters:

  • method (Optional[str])

  • path (Optional[str])

  • stage (Optional[str])

Default:

Return type:

str

  • The default behavior applies when no specific method, path, or stage is provided.

In this case, the ARN will cover all methods, all resources, and all stages of this API. Specifically, if ‘method’ is not specified, it defaults to ‘*’, representing all methods. If ‘path’ is not specified, it defaults to ‘/’, representing all paths. If ‘stage’ is not specified, it also defaults to ‘’, representing all stages.

Static Methods

classmethod from_http_api(http_api)

Return an HttpApiHelper for the given HTTP API.

Parameters:

http_api (IHttpApiRef)

Return type:

HttpApiHelper