class HttpApiHelper

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

Calculations and operations for HTTP APIs.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';

declare const httpApiRef: apigatewayv2.IHttpApiRef;
const httpApiHelper = apigatewayv2.HttpApiHelper.fromHttpApi(httpApiRef);

Methods

Name	Description
arnForExecuteApi(method?, path?, stage?)	Get the "execute-api" ARN.
static fromHttpApi(httpApi)	Return an HttpApiHelper for the given HTTP API.

---

arnForExecuteApi(method?, path?, stage?)

public arnForExecuteApi(method?: string, path?: string, stage?: string): string

Parameters

• method string
• path string
• stage string

Returns

• string

Get the "execute-api" ARN.

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

---

static fromHttpApi(httpApi)

public static fromHttpApi(httpApi: IHttpApiRef): HttpApiHelper

Parameters

• httpApi IHttpApiRef

Returns

• HttpApiHelper

Return an HttpApiHelper for the given HTTP API.