Package software.amazon.awscdk.services.datapipeline

Class CfnPipeline

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.datapipeline.CfnPipeline
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.138Z") @Stability(Stable) public class CfnPipeline extends CfnResource implements IInspectable
A CloudFormation AWS::DataPipeline::Pipeline.

The AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to automate the movement and transformation of data. In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources. For information about pipeline objects and components that you can use, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnPipelineProps props)
      Create a new AWS::DataPipeline::Pipeline.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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.

    • getAttrPipelineId

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

    • getCfnProperties

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

    • 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.

      By default, the value is set to true .

    • setActivate

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

      By default, the value is set to true .

    • setActivate

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

      By default, the value is set to true .

    • 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.

    • 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.

    • 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.

      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 .

    • setPipelineObjects

      @Stability(Stable) public void setPipelineObjects(@Nullable IResolvable value)
      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 .

    • setPipelineObjects

      @Stability(Stable) public void setPipelineObjects(@Nullable List<Object> value)
      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 .

    • getPipelineTags

      @Stability(Stable) @Nullable public Object getPipelineTags()
      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 .

    • setPipelineTags

      @Stability(Stable) public void setPipelineTags(@Nullable IResolvable value)
      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 .

    • setPipelineTags

      @Stability(Stable) public void setPipelineTags(@Nullable List<Object> value)
      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 .