AWS::Pipes::Pipe - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Pipes::Pipe

Create a pipe. Amazon EventBridge Pipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Pipes::Pipe",
  "Properties" : {
      "Description" : String,
      "DesiredState" : String,
      "Enrichment" : String,
      "EnrichmentParameters" : PipeEnrichmentParameters,
      "Name" : String,
      "RoleArn" : String,
      "Source" : String,
      "SourceParameters" : PipeSourceParameters,
      "Tags" : {Key: Value, ...},
      "Target" : String,
      "TargetParameters" : PipeTargetParameters
    }
}

YAML

Type: AWS::Pipes::Pipe
Properties: 
  Description: String
  DesiredState: String
  Enrichment: String
  EnrichmentParameters: 
    PipeEnrichmentParameters
  Name: String
  RoleArn: String
  Source: String
  SourceParameters: 
    PipeSourceParameters
  Tags: 
    Key: Value
  Target: String
  TargetParameters: 
    PipeTargetParameters

Properties

Description

A description of the pipe.

Required: No

Type: String

Update requires: No interruption

DesiredState

The state the pipe should be in.

Required: No

Type: String

Update requires: No interruption

Enrichment

The ARN of the enrichment resource.

Required: No

Type: String

Update requires: No interruption

EnrichmentParameters

The parameters required to set up enrichment on your pipe.

Required: No

Type: PipeEnrichmentParameters

Update requires: No interruption

Name

The name of the pipe.

Required: No

Type: String

Update requires: Replacement

RoleArn

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

Required: Yes

Type: String

Update requires: No interruption

Source

The ARN of the source resource.

Required: Yes

Type: String

Update requires: Replacement

SourceParameters

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

Required: No

Type: PipeSourceParameters

Update requires: No interruption

Tags

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

Required: No

Type: Map of String

Update requires: No interruption

Target

The ARN of the target resource.

Required: Yes

Type: String

Update requires: No interruption

TargetParameters

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 in the Amazon EventBridge User Guide.

Required: No

Type: PipeTargetParameters

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the name of the pipe that was created by the request.

Fn::GetAtt

The Fn::GetAttintrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAttintrinsic function, see Fn::GetAtt.

Arn

The ARN of the pipe.

CreationTime

The time the pipe was created.

CurrentState

The state the pipe is in.

LastModifiedTime

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

StateReason

The reason the pipe is in its current state.

Examples

Create a Pipe with an enrichment

Create a Pipe with an Amazon SQS source, an API Gateway enrichment, and a Step Functions state machine target.

JSON

{
  "AWSTemplateFormatVersion": "2010-09-09",
  "Resources": {
    "TestPipe": {
      "Type": "AWS::Pipes::Pipe",
      "Properties": {
        "Name": "PipeCfnExample",
        "RoleArn": "arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role",
        "Source": "arn:aws:sqs:us-east-1:123456789123:pipeDemoSource",
        "Enrichment": "arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets",
        "Target": "arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine"
      }
    }
  }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Resources:
  TestPipe:
    Type: AWS::Pipes::Pipe
    Properties:
      Name:  PipeCfnExample
      RoleArn: arn:aws:iam::123456789123:role/Pipe-Dev-All-Targets-Dummy-Execution-Role
      Source: arn:aws:sqs:us-east-1:123456789123:pipeDemoSource
      Enrichment: arn:aws:execute-api:us-east-1:123456789123:53eo2i89p9/*/POST/pets
      Target: arn:aws:states:us-east-1:123456789123:stateMachine:PipeTargetStateMachine