The CDK Construct Library for Amazon EventBridge Pipes Targets
Project description
Amazon EventBridge Pipes Targets Construct Library
---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 Targets let you create a target for a EventBridge Pipe.
For more details see the service documentation:
Targets
Pipe targets are the end point of a EventBridge Pipe.
The following targets are supported:
targets.SqsTarget
: Send event source to a Queuetargets.SfnStateMachine
: Invoke a State Machine from an event sourcetargets.LambdaFunction
: Send event source to a Lambda Function
Amazon SQS
A SQS message queue can be used as a target for a pipe. Messages will be pushed to the queue.
# source_queue: sqs.Queue
# target_queue: sqs.Queue
pipe_target = targets.SqsTarget(target_queue)
pipe = pipes.Pipe(self, "Pipe",
source=SomeSource(source_queue),
target=pipe_target
)
The target input can be transformed:
# source_queue: sqs.Queue
# target_queue: sqs.Queue
pipe_target = targets.SqsTarget(target_queue,
input_transformation=pipes.InputTransformation.from_object({
"SomeKey": pipes.DynamicInput.from_event_path("$.body")
})
)
pipe = pipes.Pipe(self, "Pipe",
source=SomeSource(source_queue),
target=pipe_target
)
AWS Step Functions State Machine
A State Machine can be used as a target for a pipe. The State Machine will be invoked with the (enriched) source payload.
# source_queue: sqs.Queue
# target_state_machine: sfn.IStateMachine
pipe_target = targets.SfnStateMachine(target_state_machine)
pipe = pipes.Pipe(self, "Pipe",
source=SomeSource(source_queue),
target=pipe_target
)
Specifying the Invocation Type when the target State Machine is invoked:
# source_queue: sqs.Queue
# target_state_machine: sfn.IStateMachine
pipe_target = targets.SfnStateMachine(target_state_machine,
invocation_type=targets.StateMachineInvocationType.FIRE_AND_FORGET
)
pipe = pipes.Pipe(self, "Pipe",
source=SomeSource(source_queue),
target=pipe_target
)
The input to the target State Machine can be transformed:
# source_queue: sqs.Queue
# target_state_machine: sfn.IStateMachine
pipe_target = targets.SfnStateMachine(target_state_machine,
input_transformation=pipes.InputTransformation.from_object({"body": "<$.body>"}),
invocation_type=targets.StateMachineInvocationType.FIRE_AND_FORGET
)
pipe = pipes.Pipe(self, "Pipe",
source=SomeSource(source_queue),
target=pipe_target
)
AWS Lambda Function
A Lambda Function can be used as a target for a pipe. The Lambda Function will be invoked with the (enriched) source payload.
# source_queue: sqs.Queue
# target_function: lambda.IFunction
pipe_target = targets.LambdaFunction(target_function)
pipe = pipes.Pipe(self, "Pipe",
source=SomeSource(source_queue),
target=pipe_target
)
The target Lambda Function is invoked synchronously by default. You can also choose to invoke the Lambda Function asynchronously by setting invocationType
property to FIRE_AND_FORGET
.
# source_queue: sqs.Queue
# target_function: lambda.IFunction
pipe_target = targets.LambdaFunction(target_function,
invocation_type=targets.LambdaFunctionInvocationType.FIRE_AND_FORGET
)
pipe = pipes.Pipe(self, "Pipe",
source=SomeSource(source_queue),
target=pipe_target
)
The input to the target Lambda Function can be transformed:
# source_queue: sqs.Queue
# target_function: lambda.IFunction
pipe_target = targets.LambdaFunction(target_function,
input_transformation=pipes.InputTransformation.from_object({"body": "👀"})
)
pipe = pipes.Pipe(self, "Pipe",
source=SomeSource(source_queue),
target=pipe_target
)
Project details
Release history Release notifications | RSS feed
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
Hashes for aws-cdk.aws-pipes-targets-alpha-2.151.0a0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e75d080ca59c403737c5521edff93287e80266290aac6410f5036ed8ed5c407 |
|
MD5 | 6b0e336868a6ada122ea6782c64301bd |
|
BLAKE2b-256 | d7f3fe50038c058bcc103afe7e03719e98108d93aef965e124991694ec5079b9 |
Hashes for aws_cdk.aws_pipes_targets_alpha-2.151.0a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd09694e62df2216dc980ccb5f81f97c5cf29837bbd35d2e0e3edcfc60604f35 |
|
MD5 | 56082c7766239c416a243e3e67655a8c |
|
BLAKE2b-256 | 85f60a4053f5a99432fffaf920c1c8cfd6e2195885e57b77c31c59bde6b60b68 |