software.amazon.awscdk.services.events.targets

Class AwsApi

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.targets.AwsApi

All Implemented Interfaces:

IRuleTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.319Z")
 @Stability(value=Stable)
public class AwsApi
extends software.amazon.jsii.JsiiObject
implements IRuleTarget

Use an AWS Lambda function that makes API calls as an event rule target.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.targets.*;
 import software.amazon.awscdk.services.iam.*;
 Object parameters;
 PolicyStatement policyStatement;
 AwsApi awsApi = AwsApi.Builder.create()
         .action("action")
         .service("service")
         // the properties below are optional
         .apiVersion("apiVersion")
         .catchErrorPattern("catchErrorPattern")
         .parameters(parameters)
         .policyStatement(policyStatement)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AwsApi.Builder A fluent builder for AwsApi.

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
	AwsApi(AwsApiProps props)
protected	AwsApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AwsApi(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
RuleTargetConfig	bind(IRule rule) Returns a RuleTarget that can be used to trigger this AwsApi as a result from an EventBridge event.
RuleTargetConfig	bind(IRule rule, String id) Returns a RuleTarget that can be used to trigger this AwsApi as a result from an EventBridge event.

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

AwsApi

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

AwsApi

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

AwsApi

@Stability(value=Stable)
public AwsApi(@NotNull
                                       AwsApiProps props)

Parameters:

props - 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 AwsApi as a result from an EventBridge event.

Specified by:

bind in interface IRuleTarget

Parameters:

rule - This parameter is required.

id -

bind

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

Returns a RuleTarget that can be used to trigger this AwsApi as a result from an EventBridge event.

Specified by:

bind in interface IRuleTarget

Parameters:

rule - This parameter is required.