aws-cdk-lib.aws_events.IRuleTarget

interface IRuleTarget

LanguageType name
.NETAmazon.CDK.AWS.Events.IRuleTarget
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsevents#IRuleTarget
Javasoftware.amazon.awscdk.services.events.IRuleTarget
Pythonaws_cdk.aws_events.IRuleTarget
TypeScript (source)aws-cdk-lib » aws_events » IRuleTarget

Implemented by ApiDestination, ApiGateway, AwsApi, BatchJob, CloudWatchLogGroup, CodeBuildProject, CodePipeline, EcsTask, EventBus, KinesisFirehoseStream, KinesisStream, LambdaFunction, SfnStateMachine, SnsTopic, SqsQueue

An abstract target for EventRules.

Methods

NameDescription
bind(rule, id?)Returns the rule target specification.

bind(rule, id?)

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

Parameters

  • rule IRule — The EventBridge Rule that would trigger this target.
  • id string — The id of the target that will be attached to the rule.

Returns

  • RuleTargetConfig

Returns the rule target specification.

NOTE: Do not use the various inputXxx options. They can be set in a call to addTarget.