Package software.amazon.awscdk.services.apigatewayv2

Class HttpApiHelper

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigatewayv2.HttpApiHelper
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-03T13:58:14.999Z") @Stability(Stable) public class HttpApiHelper extends software.amazon.jsii.JsiiObject
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 software.amazon.awscdk.services.apigatewayv2.*;
 IHttpApiRef httpApiRef;
 HttpApiHelper httpApiHelper = HttpApiHelper.fromHttpApi(httpApiRef);

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    HttpApiHelper(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    HttpApiHelper(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    arnForExecuteApi()
    Get the "execute-api" ARN.
    String
    arnForExecuteApi(String method)
    Get the "execute-api" ARN.
    String
    arnForExecuteApi(String method, String path)
    Get the "execute-api" ARN.
    String
    arnForExecuteApi(String method, String path, String stage)
    Get the "execute-api" ARN.
    static HttpApiHelper
    fromHttpApi(IHttpApiRef httpApi)
    Return an HttpApiHelper for the given HTTP API.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • HttpApiHelper

      protected HttpApiHelper(software.amazon.jsii.JsiiObjectRef objRef)

    • HttpApiHelper

      protected HttpApiHelper(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • fromHttpApi

      @Stability(Stable) @NotNull public static HttpApiHelper fromHttpApi(@NotNull IHttpApiRef httpApi)
      Return an HttpApiHelper for the given HTTP API.

      Parameters:
      httpApi - This parameter is required.

    • arnForExecuteApi

      @Stability(Stable) @NotNull public String arnForExecuteApi(@Nullable String method, @Nullable String path, @Nullable String stage)
      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.

      Parameters:
      method -
      path -
      stage -

    • arnForExecuteApi

      @Stability(Stable) @NotNull public String arnForExecuteApi(@Nullable String method, @Nullable String path)
      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.

      Parameters:
      method -
      path -

    • arnForExecuteApi

      @Stability(Stable) @NotNull public String arnForExecuteApi(@Nullable String method)
      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.

      Parameters:
      method -

    • arnForExecuteApi

      @Stability(Stable) @NotNull public String arnForExecuteApi()
      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.