AWS Fundamentals Logo
AWS Fundamentals
AWS::Pipes::Pipe

Pipes Pipe

Definition of AWS::Pipes::Pipe Resource Type

Properties

13 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
RoleArn
string
Required
Source
string
RequiredCreate-only
Target
string
Required
Description
string
DesiredState
string
Enrichment
string
EnrichmentParameters
PipeEnrichmentParameters
KmsKeyIdentifier
string
LogConfiguration
PipeLogConfiguration
Name
string
Create-only
SourceParameters
PipeSourceParameters
Write-only
Tags
TagMap
TargetParameters
PipeTargetParameters
Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
CreationTimestring-
CurrentStatestring-
LastModifiedTimestring-
StateReasonstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Pipes::Pipe

Resources:
  MyResource:
    Type: AWS::Pipes::Pipe
    Properties:
      RoleArn: "arn:aws:service:region:account:resource"
      Source: "value"
      Target: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

pipes:CreatePipepipes:DescribePipepipes:TagResourceiam:PassRolelogs:PutResourcePolicylogs:DescribeResourcePolicieslogs:DescribeLogGroupsiam:CreateServiceLinkedRole

read

pipes:DescribePipekms:Decrypt

update

pipes:UpdatePipepipes:TagResourcepipes:UntagResourcepipes:DescribePipeiam:PassRolelogs:PutResourcePolicylogs:DescribeResourcePolicieslogs:DescribeLogGroups

delete

pipes:DeletePipepipes:DescribePipepipes:UntagResourcelogs:CreateLogDeliverylogs:UpdateLogDeliverylogs:DeleteLogDeliverylogs:GetLogDeliverylogs:ListLogDeliveries

list

pipes:ListPipes

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

ServicePipes
Properties18
Required3
TaggingSupported
Primary IDName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

NameSourceSourceParameters/DynamoDBStreamParameters/StartingPositionSourceParameters/KinesisStreamParameters/StartingPositionSourceParameters/KinesisStreamParameters/StartingPositionTimestampSourceParameters/ActiveMQBrokerParameters/QueueNameSourceParameters/RabbitMQBrokerParameters/QueueNameSourceParameters/RabbitMQBrokerParameters/VirtualHostSourceParameters/ManagedStreamingKafkaParameters/TopicNameSourceParameters/ManagedStreamingKafkaParameters/StartingPositionSourceParameters/ManagedStreamingKafkaParameters/ConsumerGroupIDSourceParameters/SelfManagedKafkaParameters/TopicNameSourceParameters/SelfManagedKafkaParameters/StartingPositionSourceParameters/SelfManagedKafkaParameters/AdditionalBootstrapServersSourceParameters/SelfManagedKafkaParameters/ConsumerGroupID

External Links