interface CfnPipelineProps

Language	Type name
.NET	`Amazon.CDK.AWS.DataPipeline.CfnPipelineProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdatapipeline#CfnPipelineProps`
Java	`software.amazon.awscdk.services.datapipeline.CfnPipelineProps`
Python	`aws_cdk.aws_datapipeline.CfnPipelineProps`
TypeScript	`aws-cdk-lib` » `aws_datapipeline` » `CfnPipelineProps`

Properties for defining a CfnPipeline.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datapipeline as datapipeline } from 'aws-cdk-lib';
const cfnPipelineProps: datapipeline.CfnPipelineProps = {
  name: 'name',

  // the properties below are optional
  activate: false,
  description: 'description',
  parameterObjects: [{
    attributes: [{
      key: 'key',
      stringValue: 'stringValue',
    }],
    id: 'id',
  }],
  parameterValues: [{
    id: 'id',
    stringValue: 'stringValue',
  }],
  pipelineObjects: [{
    fields: [{
      key: 'key',

      // the properties below are optional
      refValue: 'refValue',
      stringValue: 'stringValue',
    }],
    id: 'id',
    name: 'name',
  }],
  pipelineTags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	The name of the pipeline.
activate?	`boolean \|` `IResolvable`	Indicates whether to validate and start the pipeline or stop an active pipeline.
description?	`string`	A description of the pipeline.
parameterObjects?	`IResolvable` `\|` `IResolvable` `\|` `ParameterObjectProperty[]`	The parameter objects used with the pipeline.
parameterValues?	`IResolvable` `\|` `IResolvable` `\|` `ParameterValueProperty[]`	The parameter values used with the pipeline.
pipelineObjects?	`IResolvable` `\|` `IResolvable` `\|` `PipelineObjectProperty[]`	The objects that define the pipeline.
pipelineTags?	`PipelineTagProperty[]`	A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

name

Type: string

The name of the pipeline.

activate?

Type: boolean | IResolvable (optional)

Indicates whether to validate and start the pipeline or stop an active pipeline.

By default, the value is set to true .

description?

Type: string (optional)

A description of the pipeline.

parameterObjects?

Type: IResolvable | IResolvable | ParameterObjectProperty[] (optional)

The parameter objects used with the pipeline.

parameterValues?

Type: IResolvable | IResolvable | ParameterValueProperty[] (optional)

The parameter values used with the pipeline.

pipelineObjects?

Type: IResolvable | IResolvable | PipelineObjectProperty[] (optional)

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 in the AWS Data Pipeline Developer Guide .

pipelineTags?

Type: PipelineTagProperty[] (optional)

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 in the AWS Data Pipeline Developer Guide .