class CfnPipelinePropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.DataPipeline.Mixins.CfnPipelinePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsdatapipeline/mixins#CfnPipelinePropsMixin
Java	software.amazon.awscdk.mixins.preview.services.datapipeline.mixins.CfnPipelinePropsMixin
Python	aws_cdk.mixins_preview.aws_datapipeline.mixins.CfnPipelinePropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_datapipeline » mixins » CfnPipelinePropsMixin

Implements IMixin

Extends Mixin

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

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 action and returned by the GetPipelineDefinition action.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as datapipeline_mixins } from '@aws-cdk/mixins-preview/aws-datapipeline';
const cfnPipelinePropsMixin = new datapipeline_mixins.CfnPipelinePropsMixin({
  activate: false,
  description: 'description',
  name: 'name',
  parameterObjects: [{
    attributes: [{
      key: 'key',
      stringValue: 'stringValue',
    }],
    id: 'id',
  }],
  parameterValues: [{
    id: 'id',
    stringValue: 'stringValue',
  }],
  pipelineObjects: [{
    fields: [{
      key: 'key',
      refValue: 'refValue',
      stringValue: 'stringValue',
    }],
    id: 'id',
    name: 'name',
  }],
  pipelineTags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnPipelinePropsMixin(props: CfnPipelineMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnPipelineMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::DataPipeline::Pipeline.

Properties

Name	Type	Description
props	CfnPipelineMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnPipelineMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.