Package software.amazon.awscdk.cfnpropertymixins.services.datapipeline

Interface CfnPipelineMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-02T21:55:25.777Z")
@Stability(Stable)
public interface CfnPipelineMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnPipelinePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.datapipeline.*;
 CfnPipelineMixinProps cfnPipelineMixinProps = CfnPipelineMixinProps.builder()
         .activate(false)
         .description("description")
         .name("name")
         .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")
                         .refValue("refValue")
                         .stringValue("stringValue")
                         .build()))
                 .id("id")
                 .name("name")
                 .build()))
         .pipelineTags(List.of(PipelineTagProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipelineMixinProps.Builder	A builder for CfnPipelineMixinProps
static final class	CfnPipelineMixinProps.Jsii$Proxy	An implementation for CfnPipelineMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnPipelineMixinProps.Builder	builder()
default Object	getActivate()	Indicates whether to validate and start the pipeline or stop an active pipeline.
default String	getDescription()	A description of the pipeline.
default String	getName()	The name of the pipeline.
default Object	getParameterObjects()	The parameter objects used with the pipeline.
default Object	getParameterValues()	The parameter values used with the pipeline.
default Object	getPipelineObjects()	The objects that define the pipeline.
default List<CfnPipelinePropsMixin.PipelineTagProperty>	getPipelineTags()	A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActivate

@Stability(Stable)
@Nullable
default Object getActivate()

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

By default, the value is set to true .

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-activate

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-name

getParameterObjects

@Stability(Stable)
@Nullable
default Object getParameterObjects()

The parameter objects used with the pipeline.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-parameterobjects

getParameterValues

@Stability(Stable)
@Nullable
default Object getParameterValues()

The parameter values used with the pipeline.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-parametervalues

getPipelineObjects

@Stability(Stable)
@Nullable
default 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 .

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-pipelineobjects

getPipelineTags

@Stability(Stable)
@Nullable
default List<CfnPipelinePropsMixin.PipelineTagProperty> 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html#cfn-datapipeline-pipeline-pipelinetags

builder

@Stability(Stable)
static CfnPipelineMixinProps.Builder builder()

Returns:

a CfnPipelineMixinProps.Builder of CfnPipelineMixinProps