Interface IInterceptor

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IInterceptor.Jsii$Default
All Known Implementing Classes:
IInterceptor.Jsii$Proxy, LambdaInterceptor

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.444Z") @Stability(Stable) public interface IInterceptor extends software.amazon.jsii.JsiiSerializable
Represents an interceptor that can be bound to a Gateway.

Interceptors allow custom code execution at specific points in the gateway request/response flow.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Internal default implementation for IInterceptor.
    static final class 
    A proxy class which represents a concrete javascript instance of this type.
  • Method Summary

    Modifier and Type
    Method
    Description
    bind(software.constructs.Construct scope, IGateway gateway)
    Binds this interceptor to a Gateway.
    The interception point where this interceptor will be invoked.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getInterceptionPoint

      @Stability(Stable) @NotNull InterceptionPoint getInterceptionPoint()
      The interception point where this interceptor will be invoked.
    • bind

      @Stability(Stable) @NotNull InterceptorBindConfig bind(@NotNull software.constructs.Construct scope, @NotNull IGateway gateway)
      Binds this interceptor to a Gateway.

      This method is called when the interceptor is added to a gateway. It should:

      1. Grant any necessary permissions (e.g., Lambda invoke permissions)
      2. Perform any required setup
      3. Return the CloudFormation configuration

      Parameters:
      scope - The construct scope for creating any required resources. This parameter is required.
      gateway - The gateway this interceptor is being bound to [disable-awslint:prefer-ref-interface]. This parameter is required.
      Returns:
      Configuration that will be rendered to CloudFormation