# Amazon EventBridge Pipes Enrichments Construct Library
<!--BEGIN STABILITY BANNER-->---
> 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](https://semver.org/) 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.
---
<!--END STABILITY BANNER-->
EventBridge Pipes Enrichments let you create enrichments for an EventBridge Pipe.
For more details see the service documentation:
[Documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-enrichment.html)
## 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.
```python
# 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](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-enrichment.html) for more details.
```python
# 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.
```python
# 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.
```python
# 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)
)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-pipes-enrichments-alpha",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/14/68/f2c2696f6d5e6a899506b98335d6382cc9e0936c46bf2315956a84392ab8/aws_cdk_aws_pipes_enrichments_alpha-2.170.0a0.tar.gz",
"platform": null,
"description": "# Amazon EventBridge Pipes Enrichments Construct Library\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n<!--END STABILITY BANNER-->\n\nEventBridge Pipes Enrichments let you create enrichments for an EventBridge Pipe.\n\nFor more details see the service documentation:\n\n[Documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-enrichment.html)\n\n## Pipe sources\n\nPipe enrichments are invoked prior to sending the events to a target of a EventBridge Pipe.\n\n### Lambda function\n\nA Lambda function can be used to enrich events of a pipe.\n\n```python\n# source_queue: sqs.Queue\n# target_queue: sqs.Queue\n\n# enrichment_function: lambda.Function\n\n\nenrichment = enrichments.LambdaEnrichment(enrichment_function)\n\npipe = pipes.Pipe(self, \"Pipe\",\n source=SomeSource(source_queue),\n enrichment=enrichment,\n target=SomeTarget(target_queue)\n)\n```\n\n### Step Functions state machine\n\nStep Functions state machine can be used to enrich events of a pipe.\n\n**Note:** EventBridge Pipes only supports Express workflows invoked synchronously.\n\n> Visit [Amazon EventBridge Pipes event enrichment](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-enrichment.html) for more details.\n\n```python\n# source_queue: sqs.Queue\n# target_queue: sqs.Queue\n\n# enrichment_state_machine: stepfunctions.StateMachine\n\n\nenrichment = enrichments.StepFunctionsEnrichment(enrichment_state_machine)\n\npipe = pipes.Pipe(self, \"Pipe\",\n source=SomeSource(source_queue),\n enrichment=enrichment,\n target=SomeTarget(target_queue)\n)\n```\n\n### API destination\n\nAPI destination can be used to enrich events of a pipe.\n\n```python\n# source_queue: sqs.Queue\n# target_queue: sqs.Queue\n\n# api_destination: events.ApiDestination\n\n\nenrichment = enrichments.ApiDestinationEnrichment(api_destination)\n\npipe = pipes.Pipe(self, \"Pipe\",\n source=SomeSource(source_queue),\n enrichment=enrichment,\n target=SomeTarget(target_queue)\n)\n```\n\n### API Gateway (REST API)\n\nAPI Gateway can be used to enrich events of a pipe.\nPipes only supports API Gateway REST APIs. HTTP APIs are not supported.\n\n```python\n# source_queue: sqs.Queue\n# target_queue: sqs.Queue\n\n# rest_api: apigateway.RestApi\n\n\nenrichment = enrichments.ApiGatewayEnrichment(rest_api)\n\npipe = pipes.Pipe(self, \"Pipe\",\n source=SomeSource(source_queue),\n enrichment=enrichment,\n target=SomeTarget(target_queue)\n)\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "The CDK Construct Library for Amazon EventBridge Pipes Enrichments",
"version": "2.170.0a0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc696c0c3f585687d7732e4011cafc2c924e97a66f579cdb7fa694f431c6e155",
"md5": "997d0bbc3037ad59bc121f14e407fb67",
"sha256": "69ff086aff745efe56f20b92dfbfe6b8596c659a140dbf0f94810681b997a188"
},
"downloads": -1,
"filename": "aws_cdk.aws_pipes_enrichments_alpha-2.170.0a0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "997d0bbc3037ad59bc121f14e407fb67",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 46573,
"upload_time": "2024-11-22T04:41:52",
"upload_time_iso_8601": "2024-11-22T04:41:52.680916Z",
"url": "https://files.pythonhosted.org/packages/bc/69/6c0c3f585687d7732e4011cafc2c924e97a66f579cdb7fa694f431c6e155/aws_cdk.aws_pipes_enrichments_alpha-2.170.0a0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1468f2c2696f6d5e6a899506b98335d6382cc9e0936c46bf2315956a84392ab8",
"md5": "0217ee5642e83412b44832d3483566db",
"sha256": "bb33df8c5c01d9e201245599d9cf278a56454a0b5f97dc01f636367e340f8ce2"
},
"downloads": -1,
"filename": "aws_cdk_aws_pipes_enrichments_alpha-2.170.0a0.tar.gz",
"has_sig": false,
"md5_digest": "0217ee5642e83412b44832d3483566db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 47999,
"upload_time": "2024-11-22T04:42:36",
"upload_time_iso_8601": "2024-11-22T04:42:36.353899Z",
"url": "https://files.pythonhosted.org/packages/14/68/f2c2696f6d5e6a899506b98335d6382cc9e0936c46bf2315956a84392ab8/aws_cdk_aws_pipes_enrichments_alpha-2.170.0a0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-22 04:42:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-cdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.aws-pipes-enrichments-alpha"
}
JSON
