AWS::DataPipeline::Pipeline

DataPipeline Pipeline

An example resource schema demonstrating some basic constructs and validation rules.

Properties

7 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`	RequiredCreate-only
`Activate`	`boolean`
`Description`	`string`	Create-only
`ParameterObjects`	`Array<ParameterObject>`
`ParameterValues`	`Array<ParameterValue>`
`PipelineObjects`	`Array<PipelineObject>`
`PipelineTags`	`Array<PipelineTag>`

Return Values

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

Attribute	Type	Description
`PipelineId`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DataPipeline::Pipeline

Resources:
  MyResource:
    Type: AWS::DataPipeline::Pipeline
    Properties:
      Name: "my-name"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

datapipeline:CreatePipelinedatapipeline:PutPipelineDefinitiondatapipeline:GetPipelineDefinitiondatapipeline:DescribePipelinesdatapipeline:ValidatePipelineDefinitiondatapipeline:ActivatePipelinedatapipeline:AddTagsiam:PassRole

read

datapipeline:GetPipelineDefinitiondatapipeline:DescribePipelines

update

datapipeline:PutPipelineDefinitiondatapipeline:AddTagsdatapipeline:RemoveTagsdatapipeline:DeactivatePipelinedatapipeline:GetPipelineDefinitiondatapipeline:ActivatePipelinedatapipeline:ValidatePipelineDefinitiondatapipeline:DescribePipelines

delete

datapipeline:DeletePipelinedatapipeline:DescribePipelinesdatapipeline:GetPipelineDefinitiondatapipeline:RemoveTags

list

datapipeline:ListPipelines

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

ServiceDataPipeline

Properties8

Required1

TaggingSupported

Primary IDPipelineId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

DescriptionName

External Links

AWS Documentation