Package software.amazon.awsconstructs.services.openapigatewaylambda

Interface ApiLambdaFunction

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ApiLambdaFunction.Jsii$Proxy
@Generated(value="jsii-pacmak/1.111.0 (build cc021d6)", date="2025-04-30T23:41:29.025Z") public interface ApiLambdaFunction extends software.amazon.jsii.JsiiSerializable
Helper object to map an ApiIntegration id to its resolved lambda.Function. This type is exposed as a property on the instantiated construct.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    ApiLambdaFunction.Builder
    A builder for ApiLambdaFunction
    static final class 
    ApiLambdaFunction.Jsii$Proxy
    An implementation for ApiLambdaFunction

  • Method Summary

    Modifier and Type
    Method
    Description
    static ApiLambdaFunction.Builder
    builder()
     
    default software.amazon.awscdk.services.lambda.Alias
    getFunctionAlias()
     
    String
    getId()
    Id of the ApiIntegration, used to correlate this lambda function to the api integration in the open api definition.
    default software.amazon.awscdk.services.lambda.Function
    getLambdaFunction()
    The function the API method will integrate with - Must be defined in lambdaFunction or functionAlias (but not both).

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getId

      @NotNull String getId()
      Id of the ApiIntegration, used to correlate this lambda function to the api integration in the open api definition.

    • getFunctionAlias

      @Nullable default software.amazon.awscdk.services.lambda.Alias getFunctionAlias()

    • getLambdaFunction

      @Nullable default software.amazon.awscdk.services.lambda.Function getLambdaFunction()
      The function the API method will integrate with - Must be defined in lambdaFunction or functionAlias (but not both).

    • builder

      static ApiLambdaFunction.Builder builder()
      Returns:
      a ApiLambdaFunction.Builder of ApiLambdaFunction