Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Amazon EventBridge Pipes Enrichments Construct Library

---

cdk-constructs: Experimental

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


EventBridge Pipes Enrichments let you create enrichments for an EventBridge Pipe.

For more details see the service documentation:

Documentation

Pipe sources

Pipe enrichments are invoked prior to sending the events to a target of a EventBridge Pipe.

Lambda function

A Lambda function can be used to enrich events of a pipe.

# source_queue: sqs.Queue
# target_queue: sqs.Queue

# enrichment_function: lambda.Function


enrichment = enrichments.LambdaEnrichment(enrichment_function)

pipe = pipes.Pipe(self, "Pipe",
    source=SomeSource(source_queue),
    enrichment=enrichment,
    target=SomeTarget(target_queue)
)

Step Functions state machine

Step Functions state machine can be used to enrich events of a pipe.

Note: EventBridge Pipes only supports Express workflows invoked synchronously.

Visit Amazon EventBridge Pipes event enrichment for more details.

# source_queue: sqs.Queue
# target_queue: sqs.Queue

# enrichment_state_machine: stepfunctions.StateMachine


enrichment = enrichments.StepFunctionsEnrichment(enrichment_state_machine)

pipe = pipes.Pipe(self, "Pipe",
    source=SomeSource(source_queue),
    enrichment=enrichment,
    target=SomeTarget(target_queue)
)

API destination

API destination can be used to enrich events of a pipe.

# source_queue: sqs.Queue
# target_queue: sqs.Queue

# api_destination: events.ApiDestination


enrichment = enrichments.ApiDestinationEnrichment(api_destination)

pipe = pipes.Pipe(self, "Pipe",
    source=SomeSource(source_queue),
    enrichment=enrichment,
    target=SomeTarget(target_queue)
)

API Gateway (REST API)

API Gateway can be used to enrich events of a pipe. Pipes only supports API Gateway REST APIs. HTTP APIs are not supported.

# source_queue: sqs.Queue
# target_queue: sqs.Queue

# rest_api: apigateway.RestApi


enrichment = enrichments.ApiGatewayEnrichment(rest_api)

pipe = pipes.Pipe(self, "Pipe",
    source=SomeSource(source_queue),
    enrichment=enrichment,
    target=SomeTarget(target_queue)
)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file aws_cdk_aws_pipes_enrichments_alpha-2.261.0a0.tar.gz.

File metadata

File hashes

Hashes for aws_cdk_aws_pipes_enrichments_alpha-2.261.0a0.tar.gz
Algorithm Hash digest
SHA256 5fbdb9432476c3633c7f134b11397d1ce245f619b48fd441a02d96cd658950d2
MD5 52a2e8dfed5b01d20da968e1d7bef2c0
BLAKE2b-256 f05a759d237b724b1c51ae6011dec5210abb10a1b0bcd8c966a3d37197b3d8f2

See more details on using hashes here.

File details

Details for the file aws_cdk_aws_pipes_enrichments_alpha-2.261.0a0-py3-none-any.whl.

File metadata

File hashes

Hashes for aws_cdk_aws_pipes_enrichments_alpha-2.261.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b4fd50b75077a01566c92765dafe0131e4eb9b76bb41b641abf99638e1acc81
MD5 aa1af2bc89b48b955adfc7092563c391
BLAKE2b-256 7b5f17c2530c539099bf78d6001e986e303cf9f228a1793c71fb3faa297e5922

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.261.0a0 This release

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page