class AwsApi

Language	Type name
.NET	Amazon.CDK.AWS.Events.Targets.AwsApi
Java	software.amazon.awscdk.services.events.targets.AwsApi
Python	aws_cdk.aws_events_targets.AwsApi
TypeScript (source)	@aws-cdk/aws-events-targets » AwsApi

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 * as events_targets from '@aws-cdk/aws-events-targets';
import * as iam from '@aws-cdk/aws-iam';

declare const parameters: any;
declare const policyStatement: iam.PolicyStatement;
const awsApi = new events_targets.AwsApi({
  action: 'action',
  service: 'service',

  // the properties below are optional
  apiVersion: 'apiVersion',
  catchErrorPattern: 'catchErrorPattern',
  parameters: parameters,
  policyStatement: policyStatement,
});

Initializer

new AwsApi(props: AwsApiProps)

Parameters

• props AwsApiProps

Methods

Name	Description
bind(rule, id?)	Returns a RuleTarget that can be used to trigger this AwsApi as a result from an EventBridge event.

---

bind(rule, id?)

public bind(rule: IRule, id?: string): RuleTargetConfig

Parameters

• rule IRule
• id string

Returns

• RuleTargetConfig

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