Skip to content

Commit 22a2858

Browse files
authored
docs(events): improved maintenance of information on supported targets (#30785)
### Reason for this change Information about targets supported by `aws-events-targets` is also listed in `aws-events`, but this information is outdated and can be confusing to users. Aggregating the list of supported targets in `aws-events-targets` will prevent contributors from forgetting to update it. ### Description of changes Add a message to the README of `aws-events` encouraging people to look at `aws-events-targets` for information on targets. ### Description of how you validated changes ### Checklist - [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent f48becb commit 22a2858

File tree

1 file changed

+1
-13
lines changed

1 file changed

+1
-13
lines changed

packages/aws-cdk-lib/aws-events/README.md

+1-13
Original file line numberDiff line numberDiff line change
@@ -159,19 +159,7 @@ const ecsTaskTarget = new targets.EcsTask({ cluster, taskDefinition, role, platf
159159
The `aws-cdk-lib/aws-events-targets` module includes classes that implement the `IRuleTarget`
160160
interface for various AWS services.
161161

162-
The following targets are supported:
163-
164-
* `targets.CodeBuildProject`: Start an AWS CodeBuild build
165-
* `targets.CodePipeline`: Start an AWS CodePipeline pipeline execution
166-
* `targets.EcsTask`: Start a task on an Amazon ECS cluster
167-
* `targets.LambdaFunction`: Invoke an AWS Lambda function
168-
* `targets.SnsTopic`: Publish into an SNS topic
169-
* `targets.SqsQueue`: Send a message to an Amazon SQS Queue
170-
* `targets.SfnStateMachine`: Trigger an AWS Step Functions state machine
171-
* `targets.BatchJob`: Queue an AWS Batch Job
172-
* `targets.AwsApi`: Make an AWS API call
173-
* `targets.ApiGateway`: Invoke an AWS API Gateway
174-
* `targets.ApiDestination`: Make an call to an external destination
162+
See the README of the [`aws-cdk-lib/aws-events-targets`](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-events-targets) module for more information on supported targets.
175163

176164
### Cross-account and cross-region targets
177165

0 commit comments

Comments
 (0)