aws-cdk-lib/aws-apigatewayv2/lib/http/api-helper.d.ts

Version 2 of the AWS Cloud Development Kit library

import type { IHttpApiRef } from './api';
/**
 * Calculations and operations for HTTP APIs
 */
export declare class HttpApiHelper {
    private readonly httpApi;
    /**
     * Return an `HttpApiHelper` for the given HTTP API
     */
    static fromHttpApi(httpApi: IHttpApiRef): HttpApiHelper;
    private constructor();
    /**
     * Get the "execute-api" ARN.
     *
     * When 'ANY' is passed to the method, an ARN with the method set to '*' is obtained.
     *
     * @default - 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.
     */
    arnForExecuteApi(method?: string, path?: string, stage?: string): string;
}