Experimental
@aws-cdk/aws-pipes-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
PipeProps Struct
Properties for a pipe.
Example
declare const sourceQueue: sqs.Queue;
declare const dest: events.ApiDestination;
const apiTarget = new targets.ApiDestinationTarget(dest, {
inputTransformation: pipes.InputTransformation.fromObject({ body: "👀" }),
});
const pipe = new pipes.Pipe(this, 'Pipe', {
source: new SqsSource(sourceQueue),
target: apiTarget,
});
# source_queue: sqs.Queue
# dest: events.ApiDestination
api_target = targets.ApiDestinationTarget(dest,
input_transformation=pipes.InputTransformation.from_object({"body": "👀"})
)
pipe = pipes.Pipe(self, "Pipe",
source=SqsSource(source_queue),
target=api_target
)
Queue sourceQueue;
ApiDestination dest;
ApiDestinationTarget apiTarget = ApiDestinationTarget.Builder.create(dest)
.inputTransformation(InputTransformation.fromObject(Map.of("body", "👀")))
.build();
Pipe pipe = Pipe.Builder.create(this, "Pipe")
.source(new SqsSource(sourceQueue))
.target(apiTarget)
.build();
// Install: dotnet add package Amazon.CDK.AWS.Pipes.Alpha
Queue sourceQueue;
ApiDestination dest;
var apiTarget = new ApiDestinationTarget(dest, new ApiDestinationTargetParameters {
InputTransformation = InputTransformation.FromObject(new Dictionary<string, object> { { "body", "👀" } })
});
var pipe = new Pipe(this, "Pipe", new PipeProps {
Source = new SqsSource(sourceQueue),
Target = apiTarget
});
// Install: go get github.com/aws/aws-cdk-go/awscdkpipesalpha/v2
var sourceQueue Queue
var dest ApiDestination
apiTarget := targets.NewApiDestinationTarget(dest, &ApiDestinationTargetParameters{
InputTransformation: pipes.InputTransformation_FromObject(map[string]interface{}{
"body": jsii.String("👀"),
}),
})
pipe := pipes.NewPipe(this, jsii.String("Pipe"), &PipeProps{
Source: awscdkpipessourcesalpha.NewSqsSource(sourceQueue),
Target: apiTarget,
})
Properties
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Default: no description
desiredStateoptionalDesiredStatedesired_stateoptionalDesiredStatedesiredStateoptionalDesiredStateDesiredStateoptionalDesiredStateDesiredStateoptionalDesiredState= DesiredState.RUNNING#If the state is set to STOPPED, the pipe will not process events.
enrichmentoptionalIEnrichmentenrichmentoptionalIEnrichmentenrichmentoptionalIEnrichmentEnrichmentoptionalIEnrichmentEnrichmentoptionalIEnrichment#Default: no enrichment
filteroptionalIFilterfilteroptionalIFilterfilteroptionalIFilterFilteroptionalIFilterFilteroptionalIFilter#Default: no filter
Default: undefined - AWS managed key is used
logDestinationsoptionalILogDestination[]log_destinationsoptionaltyping.List[ILogDestination]logDestinationsoptionalList<ILogDestination>LogDestinationsoptionalILogDestination[]LogDestinationsoptional*[]ILogDestination#Default: no logs
logIncludeExecutionDataoptionalIncludeExecutionData[]log_include_execution_dataoptionaltyping.List[IncludeExecutionData]logIncludeExecutionDataoptionalList<IncludeExecutionData>LogIncludeExecutionDataoptionalIncludeExecutionData[]LogIncludeExecutionDataoptional*[]IncludeExecutionData= none#notes
This applies to all log destinations for the pipe.
For more information, see Including execution data in logs and the message schema in the Amazon EventBridge User Guide .
logLeveloptionalLogLevellog_leveloptionalLogLevellogLeveloptionalLogLevelLogLeveloptionalLogLevelLogLeveloptionalLogLevel= LogLevel.ERROR#This applies to all log destinations for the pipe.
pipeNameoptionalstringpipe_nameoptionalstrpipeNameoptionalStringPipeNameoptionalstringPipeNameoptional*string#Default: automatically generated name
Default: a new role will be created.
If an enriched target is used, the role also have permissions to call the enriched target. If no role is provided, a role will be created.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Default: no tags