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.264.0a0.tar.gz.

File metadata

File hashes

Hashes for aws_cdk_aws_pipes_enrichments_alpha-2.264.0a0.tar.gz
Algorithm Hash digest
SHA256 1c7f74f0ef39010c86e2fed5af48ac4ca3844fa232ec7b3b981c5021e578eec4
MD5 37d9c03c36191e160b3f172de1d29dc0
BLAKE2b-256 1dd7f746497fb0c3af37b41fb7e9bf334357faf44d63b38191eb3b4ea5e03692

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_cdk_aws_pipes_enrichments_alpha-2.264.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 5084b51e978953cb99c73aee0548fa51de755d245cd92d4f107ba056694b57b4
MD5 ee7aa9a481c54a63e0a4855b6190bd87
BLAKE2b-256 e1767e6d3481a651de7e9a9d9bfc70fa072fed22aab2c9958c92f3b5f9f723ae

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.264.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