Package software.amazon.awsconstructs.services.openapigatewaylambda

Interface ApiIntegration

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ApiIntegration.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-12T16:16:13.802Z") public interface ApiIntegration extends software.amazon.jsii.JsiiSerializable
The ApiIntegration interface is used to correlate a user-specified id with either a existing lambda function or set of lambda props.

See the 'Overview of how the OpenAPI file transformation works' section of the README.md for more details on its usage.

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ApiIntegration.Builder
    builder()
     
    default software.amazon.awscdk.services.lambda.Function
    getExistingLambdaObj()
    The Lambda function to associate with the API method in the OpenAPI file matched by id.
    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.FunctionProps
    getLambdaFunctionProps()
    Properties for the Lambda function to create and associate with the API method in the OpenAPI file matched by id.

    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.

      Note this is not a CDK Construct ID, and is instead a client defined string used to map the resolved lambda resource with the OpenAPI definition.

    • getExistingLambdaObj

      @Nullable default software.amazon.awscdk.services.lambda.Function getExistingLambdaObj()
      The Lambda function to associate with the API method in the OpenAPI file matched by id.

      One and only one of existingLambdaObj or lambdaFunctionProps must be specified, any other combination will cause an error.

    • getLambdaFunctionProps

      @Nullable default software.amazon.awscdk.services.lambda.FunctionProps getLambdaFunctionProps()
      Properties for the Lambda function to create and associate with the API method in the OpenAPI file matched by id.

      One and only one of existingLambdaObj or lambdaFunctionProps must be specified, any other combination will cause an error.

    • builder

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