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

File metadata

File hashes

Hashes for aws_cdk_aws_pipes_enrichments_alpha-2.263.0a0.tar.gz
Algorithm Hash digest
SHA256 049daf528f527292e214307ac25bab3c04dfe787d399505d7ddd543839f40a38
MD5 2f3a0d98c3e52ca61089efaa07f50a73
BLAKE2b-256 f86684ab06c794d820008b9f4c67b4a1ddb9f7559c7b977b3deeb9ef7088dba1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aws_cdk_aws_pipes_enrichments_alpha-2.263.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 f9bc37db8c573839962d98e817768f91e9ea867ed849a8a48466ea0377d635c1
MD5 5bee2d700ba323f0f729c5f9def18853
BLAKE2b-256 3afbc018bee6228deefbc86c24ed5a87e7b5afa59f9921934b63f391266f567b

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

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