CfnPipelineProps

class aws_cdk.aws_datapipeline.CfnPipelineProps(*, name, activate=None, description=None, parameter_objects=None, parameter_values=None, pipeline_objects=None, pipeline_tags=None)

Bases: object

Properties for defining a CfnPipeline.

Parameters:

  • name (str) – The name of the pipeline.

  • activate (Union[bool, IResolvable, None]) – Indicates whether to validate and start the pipeline or stop an active pipeline. By default, the value is set to true .

  • description (Optional[str]) – A description of the pipeline.

  • parameter_objects (Union[IResolvable, Sequence[Union[IResolvable, ParameterObjectProperty, Dict[str, Any]]], None]) – The parameter objects used with the pipeline.

  • parameter_values (Union[IResolvable, Sequence[Union[IResolvable, ParameterValueProperty, Dict[str, Any]]], None]) – The parameter values used with the pipeline.

  • pipeline_objects (Union[IResolvable, Sequence[Union[IResolvable, PipelineObjectProperty, Dict[str, Any]]], None]) – 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 .

  • pipeline_tags (Union[IResolvable, Sequence[Union[IResolvable, PipelineTagProperty, Dict[str, Any]]], None]) – 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 .

Link:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_datapipeline as datapipeline

cfn_pipeline_props = datapipeline.CfnPipelineProps(
    name="name",

    # the properties below are optional
    activate=False,
    description="description",
    parameter_objects=[datapipeline.CfnPipeline.ParameterObjectProperty(
        attributes=[datapipeline.CfnPipeline.ParameterAttributeProperty(
            key="key",
            string_value="stringValue"
        )],
        id="id"
    )],
    parameter_values=[datapipeline.CfnPipeline.ParameterValueProperty(
        id="id",
        string_value="stringValue"
    )],
    pipeline_objects=[datapipeline.CfnPipeline.PipelineObjectProperty(
        fields=[datapipeline.CfnPipeline.FieldProperty(
            key="key",

            # the properties below are optional
            ref_value="refValue",
            string_value="stringValue"
        )],
        id="id",
        name="name"
    )],
    pipeline_tags=[datapipeline.CfnPipeline.PipelineTagProperty(
        key="key",
        value="value"
    )]
)

Attributes

activate

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

By default, the value is set to true .

Link:

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

description

A description of the pipeline.

Link:

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

name

The name of the pipeline.

Link:

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

parameter_objects

The parameter objects used with the pipeline.

Link:

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

parameter_values

The parameter values used with the pipeline.

Link:

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

pipeline_objects

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 .

Link:

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

pipeline_tags

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 .

Link:

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