AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pipes::Pipe

CfnPipe

Specifies a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code. > As an aid to help you jumpstart developing CloudFormation templates, the EventBridge console enables you to create templates from the existing pipes in your account. For more information, see [Generate an CloudFormation template from EventBridge Pipes](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-generate-template.html) in the *Amazon EventBridge User Guide* .

Import

import { CfnPipe } from 'aws-cdk-lib/aws-pipes';

Or use the module namespace:

import * as pipes from 'aws-cdk-lib/aws-pipes';
// pipes.CfnPipe

Properties

Configuration passed to the constructor as CfnPipeProps.

roleArnRequired
string | IRoleRef

The ARN of the role that allows the pipe to send data to the target.

sourceRequired
string | IStreamRef | IQueueRef

The ARN of the source resource.

targetRequired
string | IEventBusRef | IFunctionRef | ILogGroupRef | ITopicRef | IQueueRef | IStateMachineRef

The ARN of the target resource.

descriptionOptional
string

A description of the pipe.

desiredStateOptional
string

The state the pipe should be in.

enrichmentOptional
string | IFunctionRef

The ARN of the enrichment resource.

enrichmentParametersOptional
IResolvable | PipeEnrichmentParametersProperty

The parameters required to set up enrichment on your pipe.

kmsKeyIdentifierOptional
string

The identifier of the AWS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. To update a pipe that is using the default AWS owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier. To update a pipe that is using a customer managed key to use the default AWS owned key , specify an empty string. For more information, see [Managing keys](https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html) in the *AWS Key Management Service Developer Guide* .

logConfigurationOptional
IResolvable | PipeLogConfigurationProperty

The logging configuration settings for the pipe.

nameOptional
string

The name of the pipe.

sourceParametersOptional
IResolvable | PipeSourceParametersProperty

The parameters required to set up a source for your pipe.

tagsOptional
{ [key: string]: string }

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

targetParametersOptional
IResolvable | PipeTargetParametersProperty

The parameters required to set up a target for your pipe. For more information about pipe target parameters, including how to use dynamic path parameters, see [Target parameters](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html) in the *Amazon EventBridge User Guide* .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Pipes::PipeView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-pipes
CFN TypeAWS::Pipes::Pipe
Properties13

Explore This Service

External Links