class AwsApi

Language	Type name
.NET	`Amazon.CDK.AWS.Events.Targets.AwsApi`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awseventstargets#AwsApi`
Java	`software.amazon.awscdk.services.events.targets.AwsApi`
Python	`aws_cdk.aws_events_targets.AwsApi`
TypeScript (source)	`aws-cdk-lib` » `aws_events_targets` » `AwsApi`

Implements IRuleTarget

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

Example

const rule = new events.Rule(this, 'Rule', {
  schedule: events.Schedule.rate(Duration.hours(1)),
});

rule.addTarget(new targets.AwsApi({
  service: 'ECS',
  action: 'updateService',
  parameters: {
    service: 'my-service',
    forceNewDeployment: true,
  },
}));

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.