Package software.amazon.awscdk.services.datapipeline

Class CfnPipeline.Builder

java.lang.Object
software.amazon.awscdk.services.datapipeline.CfnPipeline.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPipeline>
Enclosing class:
CfnPipeline
@Stability(Stable) public static final class CfnPipeline.Builder extends Object implements software.amazon.jsii.Builder<CfnPipeline>
A fluent builder for CfnPipeline.

  • Method Details

    • create

      @Stability(Stable) public static CfnPipeline.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnPipeline.Builder.

    • name

      @Stability(Stable) public CfnPipeline.Builder name(String name)
      The name of the pipeline.

      Parameters:
      name - The name of the pipeline. This parameter is required.
      Returns:
      this

    • activate

      @Stability(Stable) public CfnPipeline.Builder activate(Boolean activate)
      Indicates whether to validate and start the pipeline or stop an active pipeline.

      By default, the value is set to true .

      Parameters:
      activate - Indicates whether to validate and start the pipeline or stop an active pipeline. This parameter is required.
      Returns:
      this

    • activate

      @Stability(Stable) public CfnPipeline.Builder activate(IResolvable activate)
      Indicates whether to validate and start the pipeline or stop an active pipeline.

      By default, the value is set to true .

      Parameters:
      activate - Indicates whether to validate and start the pipeline or stop an active pipeline. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnPipeline.Builder description(String description)
      A description of the pipeline.

      Parameters:
      description - A description of the pipeline. This parameter is required.
      Returns:
      this

    • parameterObjects

      @Stability(Stable) public CfnPipeline.Builder parameterObjects(IResolvable parameterObjects)
      The parameter objects used with the pipeline.

      Parameters:
      parameterObjects - The parameter objects used with the pipeline. This parameter is required.
      Returns:
      this

    • parameterObjects

      @Stability(Stable) public CfnPipeline.Builder parameterObjects(List<? extends Object> parameterObjects)
      The parameter objects used with the pipeline.

      Parameters:
      parameterObjects - The parameter objects used with the pipeline. This parameter is required.
      Returns:
      this

    • parameterValues

      @Stability(Stable) public CfnPipeline.Builder parameterValues(IResolvable parameterValues)
      The parameter values used with the pipeline.

      Parameters:
      parameterValues - The parameter values used with the pipeline. This parameter is required.
      Returns:
      this

    • parameterValues

      @Stability(Stable) public CfnPipeline.Builder parameterValues(List<? extends Object> parameterValues)
      The parameter values used with the pipeline.

      Parameters:
      parameterValues - The parameter values used with the pipeline. This parameter is required.
      Returns:
      this

    • pipelineObjects

      @Stability(Stable) public CfnPipeline.Builder pipelineObjects(IResolvable pipelineObjects)
      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 .

      Parameters:
      pipelineObjects - The objects that define the pipeline. This parameter is required.
      Returns:
      this

    • pipelineObjects

      @Stability(Stable) public CfnPipeline.Builder pipelineObjects(List<? extends Object> pipelineObjects)
      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 .

      Parameters:
      pipelineObjects - The objects that define the pipeline. This parameter is required.
      Returns:
      this

    • pipelineTags

      @Stability(Stable) public CfnPipeline.Builder pipelineTags(IResolvable pipelineTags)
      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 .

      Parameters:
      pipelineTags - A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. This parameter is required.
      Returns:
      this

    • pipelineTags

      @Stability(Stable) public CfnPipeline.Builder pipelineTags(List<? extends Object> pipelineTags)
      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 .

      Parameters:
      pipelineTags - A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnPipeline build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPipeline>
      Returns:
      a newly built instance of CfnPipeline.