GradientEdge CDK Utils
    Preparing search index...

    Interface ApiToLambdaTargetRestApiType

    interface ApiToLambdaTargetRestApiType {
        api: IRestApi;
        authoriser?: IAuthorizer;
        basePathMappings: BasePathMapping[];
        certificate: ICertificate;
        domain: DomainName;
        errorResponseModel: Model;
        hostedZone: IHostedZone;
        integration: Integration;
        integrationErrorResponse: IntegrationResponse;
        integrationRequestParameters: { [p: string]: string };
        integrationRequestTemplates: { [p: string]: string };
        integrationResponse: IntegrationResponse;
        lambda: IFunction;
        method: Method;
        methodErrorResponse: MethodResponse;
        methodResponse: MethodResponse;
        policy?: PolicyDocument;
        resource: Resource;
        responseModel: Model;
        role?: Role;
        topic?: ITopic;
    }

    Implemented by

    Index

    Properties

    api authoriser? basePathMappings certificate domain errorResponseModel hostedZone integration integrationErrorResponse integrationRequestParameters integrationRequestTemplates integrationResponse lambda method methodErrorResponse methodResponse policy? resource responseModel role? topic?

    Properties

    api: IRestApi

    The API Gateway REST API

    authoriser?: IAuthorizer

    The optional API Gateway authorizer

    basePathMappings: BasePathMapping[]

    The base path mappings for the API custom domain

    certificate: ICertificate

    The SSL/TLS certificate for the custom domain

    domain: DomainName

    The API Gateway custom domain

    errorResponseModel: Model

    The API Gateway error response model

    hostedZone: IHostedZone

    The Route53 hosted zone for the API domain

    integration: Integration

    The API Gateway Lambda integration

    integrationErrorResponse: IntegrationResponse

    The integration error response mapping

    integrationRequestParameters: { [p: string]: string }

    The integration request parameter mappings

    integrationRequestTemplates: { [p: string]: string }

    The integration request template mappings

    integrationResponse: IntegrationResponse

    The integration success response mapping

    lambda: IFunction

    The Lambda function used as the integration target

    method: Method

    The API Gateway resource method

    methodErrorResponse: MethodResponse

    The method error response

    methodResponse: MethodResponse

    The method success response

    policy?: PolicyDocument

    The IAM policy for the API Gateway integration role

    resource: Resource

    The API Gateway resource

    responseModel: Model

    The success response model

    role?: Role

    The IAM role for the API Gateway integration

    topic?: ITopic

    The optional SNS topic

    Settings

    Member Visibility

    On This Page

    Properties