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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.318Z")
 @Stability(value=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_14_X)
         .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 and Description
static 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 and Description
protected	ApiGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ApiGateway(software.amazon.jsii.JsiiObjectRef objRef)
	ApiGateway(RestApi restApi)
	ApiGateway(RestApi restApi, ApiGatewayProps props)

Method Summary

Modifier and Type	Method and 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.
RestApi	getRestApi()

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

Constructor Detail

ApiGateway

protected ApiGateway(software.amazon.jsii.JsiiObjectRef objRef)

ApiGateway

protected ApiGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ApiGateway

@Stability(value=Stable)
public ApiGateway(@NotNull
                                           RestApi restApi,
                                           @Nullable
                                           ApiGatewayProps props)

Parameters:

restApi - This parameter is required.

props -

ApiGateway

@Stability(value=Stable)
public ApiGateway(@NotNull
                                           RestApi restApi)

Parameters:

restApi - This parameter is required.

Method Detail

bind

@Stability(value=Stable)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                IRule rule,
                                                                @Nullable
                                                                String _id)

Returns a RuleTarget that can be used to trigger this API Gateway REST APIs as a result from an EventBridge event.

Specified by:

bind in interface IRuleTarget

Parameters:

rule - This parameter is required.

_id -

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sqs-permissions

bind

@Stability(value=Stable)
 @NotNull
public RuleTargetConfig bind(@NotNull
                                                                IRule rule)

Returns a RuleTarget that can be used to trigger this API Gateway REST APIs as a result from an EventBridge event.

Specified by:

bind in interface IRuleTarget

Parameters:

rule - This parameter is required.

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sqs-permissions

getRestApi

@Stability(value=Stable)
 @NotNull
public RestApi getRestApi()