AWS::DataPipeline::PipelineCfnPipeline
The AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to automate the movement and transformation of data. > AWS Data Pipeline is no longer available to new customers. Existing customers of AWS Data Pipeline can continue to use the service as normal. [Learn more](https://docs.aws.amazon.com/big-data/migrate-workloads-from-aws-data-pipeline/) In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources. The `AWS::DataPipeline::Pipeline` resource adds tasks, schedules, and preconditions to the specified pipeline. You can use `PutPipelineDefinition` to populate a new pipeline. `PutPipelineDefinition` also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following validation errors exist in the pipeline. - An object is missing a name or identifier field. - A string or reference field is empty. - The number of objects in the pipeline exceeds the allowed maximum number of objects. - The pipeline is in a FINISHED state. Pipeline object definitions are passed to the [PutPipelineDefinition](https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html) action and returned by the [GetPipelineDefinition](https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_GetPipelineDefinition.html) action.
Import
import { CfnPipeline } from 'aws-cdk-lib/aws-datapipeline';Or use the module namespace:
import * as datapipeline from 'aws-cdk-lib/aws-datapipeline';
// datapipeline.CfnPipelineProperties
Configuration passed to the constructor as CfnPipelineProps.
nameRequiredstringThe name of the pipeline.
activateOptionalboolean | IResolvableIndicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to `true` .
descriptionOptionalstringA description of the pipeline.
parameterObjectsOptionalIResolvable | IResolvable | ParameterObjectProperty[]The parameter objects used with the pipeline.
parameterValuesOptionalIResolvable | IResolvable | ParameterValueProperty[]The parameter values used with the pipeline.
pipelineObjectsOptionalIResolvable | IResolvable | PipelineObjectProperty[]The objects that define the pipeline. These objects overwrite the existing pipeline definition. Not all objects, fields, and values can be updated. For information about restrictions, see [Editing Your Pipeline](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-manage-pipeline-modify-console.html) in the *AWS Data Pipeline Developer Guide* .
pipelineTagsOptionalPipelineTagProperty[]A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. For more information, see [Controlling Access to Pipelines and Resources](https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html) in the *AWS Data Pipeline Developer Guide* .
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-datapipelineAWS::DataPipeline::Pipeline