Package software.amazon.awscdk.services.events.targets

Class ApiGateway

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.events.targets.ApiGateway
All Implemented Interfaces:
IRuleTarget, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:38.945Z") @Stability(Stable) public class ApiGateway extends software.amazon.jsii.JsiiObject implements IRuleTarget
Use an API Gateway REST APIs as a target for Amazon EventBridge rules.

Example: 

 import software.amazon.awscdk.services.apigateway.*;
 import software.amazon.awscdk.services.lambda.*;
 Rule rule = Rule.Builder.create(this, "Rule")
         .schedule(Schedule.rate(Duration.minutes(1)))
         .build();
 Function fn = Function.Builder.create(this, "MyFunc")
         .handler("index.handler")
         .runtime(Runtime.NODEJS_LATEST)
         .code(Code.fromInline("exports.handler = e => {}"))
         .build();
 LambdaRestApi restApi = LambdaRestApi.Builder.create(this, "MyRestAPI").handler(fn).build();
 Queue dlq = new Queue(this, "DeadLetterQueue");
 rule.addTarget(
 ApiGateway.Builder.create(restApi)
         .path("/*/test")
         .method("GET")
         .stage("prod")
         .pathParameterValues(List.of("path-value"))
         .headerParameters(Map.of(
                 "Header1", "header1"))
         .queryStringParameters(Map.of(
                 "QueryParam1", "query-param-1"))
         .deadLetterQueue(dlq)
         .build());

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ApiGateway.Builder
    A fluent builder for ApiGateway.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.events.IRuleTarget

    IRuleTarget.Jsii$Default, IRuleTarget.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    ApiGateway(IRestApi restApi)
     
     
    ApiGateway(IRestApi restApi, ApiGatewayProps props)
     
    protected
    ApiGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ApiGateway(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    RuleTargetConfig
    bind(IRule rule)
    Returns a RuleTarget that can be used to trigger this API Gateway REST APIs as a result from an EventBridge event.
    RuleTargetConfig
    bind(IRule rule, String _id)
    Returns a RuleTarget that can be used to trigger this API Gateway REST APIs as a result from an EventBridge event.
    IRestApi
    getIRestApi()
    Returns the target IRestApi.
    RestApi
    getRestApi()
    Deprecated.
    Use the iRestApi getter instead

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson