Package software.amazon.awscdk.services.datapipeline

Class CfnPipeline

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.datapipeline.CfnPipeline
All Implemented Interfaces:
IInspectable, ITaggableV2, IPipelineRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:35.936Z") @Stability(Stable) public class CfnPipeline extends CfnResource implements IInspectable, IPipelineRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datapipeline.*;
 CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
         .name("name")
         // the properties below are optional
         .activate(false)
         .description("description")
         .parameterObjects(List.of(ParameterObjectProperty.builder()
                 .attributes(List.of(ParameterAttributeProperty.builder()
                         .key("key")
                         .stringValue("stringValue")
                         .build()))
                 .id("id")
                 .build()))
         .parameterValues(List.of(ParameterValueProperty.builder()
                 .id("id")
                 .stringValue("stringValue")
                 .build()))
         .pipelineObjects(List.of(PipelineObjectProperty.builder()
                 .fields(List.of(FieldProperty.builder()
                         .key("key")
                         // the properties below are optional
                         .refValue("refValue")
                         .stringValue("stringValue")
                         .build()))
                 .id("id")
                 .name("name")
                 .build()))
         .pipelineTags(List.of(PipelineTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPipeline

      protected CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPipeline

      protected CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPipeline

      @Stability(Stable) public CfnPipeline(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPipelineProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromPipelineID

      @Stability(Stable) @NotNull public static IPipelineRef fromPipelineID(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String pipelineId)
      Creates a new IPipelineRef from a pipelineId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      pipelineId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getAttrPipelineId

      @Stability(Stable) @NotNull public String getAttrPipelineId()
      The ID of the pipeline.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPipelineRef

      @Stability(Stable) @NotNull public PipelineReference getPipelineRef()
      A reference to a Pipeline resource.
      Specified by:
      getPipelineRef in interface IPipelineRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the pipeline.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the pipeline.

    • getActivate

      @Stability(Stable) @Nullable public Object getActivate()
      Indicates whether to validate and start the pipeline or stop an active pipeline.

      Returns union: either Boolean or IResolvable

    • setActivate

      @Stability(Stable) public void setActivate(@Nullable Boolean value)
      Indicates whether to validate and start the pipeline or stop an active pipeline.

    • setActivate

      @Stability(Stable) public void setActivate(@Nullable IResolvable value)
      Indicates whether to validate and start the pipeline or stop an active pipeline.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the pipeline.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the pipeline.

    • getParameterObjects

      @Stability(Stable) @Nullable public Object getParameterObjects()
      The parameter objects used with the pipeline.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipeline.ParameterObjectProperty>

    • setParameterObjects

      @Stability(Stable) public void setParameterObjects(@Nullable IResolvable value)
      The parameter objects used with the pipeline.

    • setParameterObjects

      @Stability(Stable) public void setParameterObjects(@Nullable List<Object> value)
      The parameter objects used with the pipeline.

    • getParameterValues

      @Stability(Stable) @Nullable public Object getParameterValues()
      The parameter values used with the pipeline.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipeline.ParameterValueProperty>

    • setParameterValues

      @Stability(Stable) public void setParameterValues(@Nullable IResolvable value)
      The parameter values used with the pipeline.

    • setParameterValues

      @Stability(Stable) public void setParameterValues(@Nullable List<Object> value)
      The parameter values used with the pipeline.

    • getPipelineObjects

      @Stability(Stable) @Nullable public Object getPipelineObjects()
      The objects that define the pipeline.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPipeline.PipelineObjectProperty>

    • setPipelineObjects

      @Stability(Stable) public void setPipelineObjects(@Nullable IResolvable value)
      The objects that define the pipeline.

    • setPipelineObjects

      @Stability(Stable) public void setPipelineObjects(@Nullable List<Object> value)
      The objects that define the pipeline.

    • getPipelineTags

      @Stability(Stable) @Nullable public List<CfnPipeline.PipelineTagProperty> getPipelineTags()
      A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

    • setPipelineTags

      @Stability(Stable) public void setPipelineTags(@Nullable List<CfnPipeline.PipelineTagProperty> value)
      A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.