UNPKG

@aws/pdk

Version:

All documentation is located at: https://aws.github.io/aws-pdk

28 lines (27 loc) 1.18 kB
/*! Copyright [Amazon.com](http://amazon.com/), Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0 */ import { IFunction } from "aws-cdk-lib/aws-lambda"; import { LambdaIntegration } from "./lambda"; import { MockIntegration, MockIntegrationResponse } from "./mock"; import { S3Integration, S3IntegrationProps } from "./s3"; /** * A collection of integrations to connect API operations with a backend to service requests */ export declare class Integrations { /** * An integration that invokes a lambda function to service the request * @param lambdaFunction the function to invoke */ static lambda(lambdaFunction: IFunction): LambdaIntegration; /** * An integration that returns a hardcoded response * @param response the response to return */ static mock(response: MockIntegrationResponse): MockIntegration; /** * An integration that can read/write to an S3 bucket * @param props the integration props * @see https://docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-services-s3.html */ static s3(props: S3IntegrationProps): S3Integration; }