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

Class CfnPipelinePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.datapipeline.CfnPipelinePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPipelinePropsMixin>

Enclosing class:

CfnPipelinePropsMixin

@Stability(Stable)
public static final class CfnPipelinePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPipelinePropsMixin>

A fluent builder for CfnPipelinePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnPipelinePropsMixin.Builder	activate(Boolean activate)	Indicates whether to validate and start the pipeline or stop an active pipeline.
CfnPipelinePropsMixin.Builder	activate(IResolvable activate)	Indicates whether to validate and start the pipeline or stop an active pipeline.
CfnPipelinePropsMixin	build()
static CfnPipelinePropsMixin.Builder	create()
static CfnPipelinePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnPipelinePropsMixin.Builder	description(String description)	A description of the pipeline.
CfnPipelinePropsMixin.Builder	name(String name)	The name of the pipeline.
CfnPipelinePropsMixin.Builder	parameterObjects(List<? extends Object> parameterObjects)	The parameter objects used with the pipeline.
CfnPipelinePropsMixin.Builder	parameterObjects(IResolvable parameterObjects)	The parameter objects used with the pipeline.
CfnPipelinePropsMixin.Builder	parameterValues(List<? extends Object> parameterValues)	The parameter values used with the pipeline.
CfnPipelinePropsMixin.Builder	parameterValues(IResolvable parameterValues)	The parameter values used with the pipeline.
CfnPipelinePropsMixin.Builder	pipelineObjects(List<? extends Object> pipelineObjects)	The objects that define the pipeline.
CfnPipelinePropsMixin.Builder	pipelineObjects(IResolvable pipelineObjects)	The objects that define the pipeline.
CfnPipelinePropsMixin.Builder	pipelineTags(List<? extends CfnPipelinePropsMixin.PipelineTagProperty> pipelineTags)	A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPipelinePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnPipelinePropsMixin.Builder.

create

@Stability(Stable)
public static CfnPipelinePropsMixin.Builder create()

Returns:

a new instance of CfnPipelinePropsMixin.Builder.

activate

@Stability(Stable)
public CfnPipelinePropsMixin.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

See Also:

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

activate

@Stability(Stable)
public CfnPipelinePropsMixin.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

See Also:

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

description

@Stability(Stable)
public CfnPipelinePropsMixin.Builder description(String description)

A description of the pipeline.

Parameters:

description - A description of the pipeline. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnPipelinePropsMixin.Builder name(String name)

The name of the pipeline.

Parameters:

name - The name of the pipeline. This parameter is required.

Returns:

this

See Also:

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

parameterObjects

@Stability(Stable)
public CfnPipelinePropsMixin.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

See Also:

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

parameterObjects

@Stability(Stable)
public CfnPipelinePropsMixin.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

See Also:

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

parameterValues

@Stability(Stable)
public CfnPipelinePropsMixin.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

See Also:

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

parameterValues

@Stability(Stable)
public CfnPipelinePropsMixin.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

See Also:

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

pipelineObjects

@Stability(Stable)
public CfnPipelinePropsMixin.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

See Also:

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

pipelineObjects

@Stability(Stable)
public CfnPipelinePropsMixin.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

See Also:

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

pipelineTags

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

See Also:

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

build

@Stability(Stable)
public CfnPipelinePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPipelinePropsMixin>

Returns:

a newly built instance of CfnPipelinePropsMixin.