interface PipeProps 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Pipes.Alpha.PipeProps
Go	github.com/aws/aws-cdk-go/awscdkpipesalpha/v2#PipeProps
Java	software.amazon.awscdk.services.pipes.alpha.PipeProps
Python	aws_cdk.aws_pipes_alpha.PipeProps
TypeScript (source)	@aws-cdk/aws-pipes-alpha » PipeProps

Properties for a pipe.

Example

declare const sourceStream: kinesis.Stream;
declare const targetQueue: sqs.Queue;

const pipeSource = new sources.KinesisSource(sourceStream, {
  startingPosition: sources.KinesisStartingPosition.LATEST,
});

const pipe = new pipes.Pipe(this, 'Pipe', {
  source: pipeSource,
  target: new SqsTarget(targetQueue)
});

Properties

Name	Type	Description
source🔹	ISource	The source of the pipe.
target🔹	ITarget	The target of the pipe.
description?🔹	string	A description of the pipe displayed in the AWS console.
desiredState?🔹	DesiredState	The desired state of the pipe.
enrichment?🔹	IEnrichment	Enrichment step to enhance the data from the source before sending it to the target.
filter?🔹	IFilter	The filter pattern for the pipe source.
logDestinations?🔹	ILogDestination[]	Destinations for the logs.
logIncludeExecutionData?🔹	IncludeExecutionData[]	Whether the execution data (specifically, the payload , awsRequest , and awsResponse fields) is included in the log messages for this pipe.
logLevel?🔹	LogLevel	The level of logging detail to include.
pipeName?🔹	string	Name of the pipe in the AWS console.
role?🔹	IRole	The role used by the pipe which has permissions to read from the source and write to the target.
tags?🔹	{ [string]: string }	The list of key-value pairs to associate with the pipe.

---

source🔹

Type: ISource

The source of the pipe.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-source.html

---

target🔹

Type: ITarget

The target of the pipe.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html

---

description?🔹

Type: string (optional, default: no description)

A description of the pipe displayed in the AWS console.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-description

---

desiredState?🔹

Type: DesiredState (optional, default: DesiredState.RUNNING)

The desired state of the pipe.

If the state is set to STOPPED, the pipe will not process events.

See also: https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/API_Pipe.html#eventbridge-Type-Pipe-DesiredState

---

enrichment?🔹

Type: IEnrichment (optional, default: no enrichment)

Enrichment step to enhance the data from the source before sending it to the target.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-enrichment.html

---

filter?🔹

Type: IFilter (optional, default: no filter)

The filter pattern for the pipe source.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-filtering.html

---

logDestinations?🔹

Type: ILogDestination[] (optional, default: no logs)

Destinations for the logs.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html

---

logIncludeExecutionData?🔹

Type: IncludeExecutionData[] (optional, default: none)

Whether the execution data (specifically, the payload , awsRequest , and awsResponse fields) is included in the log messages for this pipe.

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipelogconfiguration.html#cfn-pipes-pipe-pipelogconfiguration-includeexecutiondata

---

logLevel?🔹

Type: LogLevel (optional, default: LogLevel.ERROR)

The level of logging detail to include.

This applies to all log destinations for the pipe.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html

---

pipeName?🔹

Type: string (optional, default: automatically generated name)

Name of the pipe in the AWS console.

---

role?🔹

Type: IRole (optional, default: a new role will be created.)

The role used by the pipe which has permissions to read from the source and write to the target.

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.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-permissions.html

---

tags?🔹

Type: { [string]: string } (optional, default: no tags)

The list of key-value pairs to associate with the pipe.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pipe.html#cfn-pipes-pipe-tags