CfnPipelinePropsMixin

class aws_cdk.mixins_preview.aws_datapipeline.mixins.CfnPipelinePropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::DataPipeline::Pipeline resource specifies a data pipeline that you can use to automate the movement and transformation of data.

AWS Data Pipeline is no longer available to new customers. Existing customers of AWS Data Pipeline can continue to use the service as normal. Learn more

In each pipeline, you define pipeline objects, such as activities, schedules, data nodes, and resources.

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datapipeline-pipeline.html
CloudformationResource:: AWS::DataPipeline::Pipeline
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_pipeline_props_mixin = datapipeline_mixins.CfnPipelinePropsMixin(datapipeline_mixins.CfnPipelineMixinProps(
    activate=False,
    description="description",
    name="name",
    parameter_objects=[datapipeline_mixins.CfnPipelinePropsMixin.ParameterObjectProperty(
        attributes=[datapipeline_mixins.CfnPipelinePropsMixin.ParameterAttributeProperty(
            key="key",
            string_value="stringValue"
        )],
        id="id"
    )],
    parameter_values=[datapipeline_mixins.CfnPipelinePropsMixin.ParameterValueProperty(
        id="id",
        string_value="stringValue"
    )],
    pipeline_objects=[datapipeline_mixins.CfnPipelinePropsMixin.PipelineObjectProperty(
        fields=[datapipeline_mixins.CfnPipelinePropsMixin.FieldProperty(
            key="key",
            ref_value="refValue",
            string_value="stringValue"
        )],
        id="id",
        name="name"
    )],
    pipeline_tags=[datapipeline_mixins.CfnPipelinePropsMixin.PipelineTagProperty(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::DataPipeline::Pipeline.

Parameters:

props (Union[CfnPipelineMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['activate', 'description', 'name', 'parameterObjects', 'parameterValues', 'pipelineObjects', 'pipelineTags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

FieldProperty

class CfnPipelinePropsMixin.FieldProperty(*, key=None, ref_value=None, string_value=None)

Bases: object

A key-value pair that describes a property of a PipelineObject .

The value is specified as either a string value ( StringValue ) or a reference to another object ( RefValue ) but not as both. To view fields for a data pipeline object, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .

Parameters:

key (Optional[str]) –
Specifies the name of a field for a particular object. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .
ref_value (Optional[str]) – A field value that you specify as an identifier of another object in the same pipeline definition. .. epigraph:: You can specify the field value as either a string value ( StringValue ) or a reference to another object ( RefValue ), but not both. Required if the key that you are using requires it.
string_value (Optional[str]) –
A field value that you specify as a string. To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide . .. epigraph:: You can specify the field value as either a string value ( StringValue ) or a reference to another object ( RefValue ), but not both. Required if the key that you are using requires it.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

field_property = datapipeline_mixins.CfnPipelinePropsMixin.FieldProperty(
    key="key",
    ref_value="refValue",
    string_value="stringValue"
)

Attributes

key

Specifies the name of a field for a particular object.

To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-field.html#cfn-datapipeline-pipeline-field-key

ref_value

A field value that you specify as an identifier of another object in the same pipeline definition.

You can specify the field value as either a string value ( StringValue ) or a reference to another object ( RefValue ), but not both.

Required if the key that you are using requires it.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-field.html#cfn-datapipeline-pipeline-field-refvalue

string_value

A field value that you specify as a string.

To view valid values for a particular field, see Pipeline Object Reference in the AWS Data Pipeline Developer Guide . .. epigraph:

You can specify the field value as either a string value ( ``StringValue`` ) or a reference to another object ( ``RefValue`` ), but not both.

Required if the key that you are using requires it.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-field.html#cfn-datapipeline-pipeline-field-stringvalue

ParameterAttributeProperty

class CfnPipelinePropsMixin.ParameterAttributeProperty(*, key=None, string_value=None)

Bases: object

Attribute is a property of ParameterObject that defines the attributes of a parameter object as key-value pairs.

Parameters:

key (Optional[str]) – The field identifier.
string_value (Optional[str]) – The field value, expressed as a String.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

parameter_attribute_property = datapipeline_mixins.CfnPipelinePropsMixin.ParameterAttributeProperty(
    key="key",
    string_value="stringValue"
)

Attributes

key

The field identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterattribute.html#cfn-datapipeline-pipeline-parameterattribute-key

string_value

The field value, expressed as a String.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterattribute.html#cfn-datapipeline-pipeline-parameterattribute-stringvalue

ParameterObjectProperty

class CfnPipelinePropsMixin.ParameterObjectProperty(*, attributes=None, id=None)

Bases: object

Contains information about a parameter object.

Parameters:

attributes (Union[IResolvable, Sequence[Union[IResolvable, ParameterAttributeProperty, Dict[str, Any]]], None]) – The attributes of the parameter object.
id (Optional[str]) – The ID of the parameter object.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

parameter_object_property = datapipeline_mixins.CfnPipelinePropsMixin.ParameterObjectProperty(
    attributes=[datapipeline_mixins.CfnPipelinePropsMixin.ParameterAttributeProperty(
        key="key",
        string_value="stringValue"
    )],
    id="id"
)

Attributes

attributes

The attributes of the parameter object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobject.html#cfn-datapipeline-pipeline-parameterobject-attributes

id

The ID of the parameter object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parameterobject.html#cfn-datapipeline-pipeline-parameterobject-id

ParameterValueProperty

class CfnPipelinePropsMixin.ParameterValueProperty(*, id=None, string_value=None)

Bases: object

A value or list of parameter values.

Parameters:

id (Optional[str]) – The ID of the parameter value.
string_value (Optional[str]) – The field value, expressed as a String.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

parameter_value_property = datapipeline_mixins.CfnPipelinePropsMixin.ParameterValueProperty(
    id="id",
    string_value="stringValue"
)

Attributes

id

The ID of the parameter value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalue.html#cfn-datapipeline-pipeline-parametervalue-id

string_value

The field value, expressed as a String.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-parametervalue.html#cfn-datapipeline-pipeline-parametervalue-stringvalue

PipelineObjectProperty

class CfnPipelinePropsMixin.PipelineObjectProperty(*, fields=None, id=None, name=None)

Bases: object

PipelineObject is property of the AWS::DataPipeline::Pipeline resource that contains information about a pipeline object.

This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

Parameters:

fields (Union[IResolvable, Sequence[Union[IResolvable, FieldProperty, Dict[str, Any]]], None]) – Key-value pairs that define the properties of the object.
id (Optional[str]) – The ID of the object.
name (Optional[str]) – The name of the object.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

pipeline_object_property = datapipeline_mixins.CfnPipelinePropsMixin.PipelineObjectProperty(
    fields=[datapipeline_mixins.CfnPipelinePropsMixin.FieldProperty(
        key="key",
        ref_value="refValue",
        string_value="stringValue"
    )],
    id="id",
    name="name"
)

Attributes

fields

Key-value pairs that define the properties of the object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobject.html#cfn-datapipeline-pipeline-pipelineobject-fields

id

The ID of the object.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelineobject.html#cfn-datapipeline-pipeline-pipelineobject-id

name

The name of the object.

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

PipelineTagProperty

class CfnPipelinePropsMixin.PipelineTagProperty(*, key=None, value=None)

Bases: object

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:

key (Optional[str]) – The key name of a tag.
value (Optional[str]) – The value to associate with the key name.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

pipeline_tag_property = datapipeline_mixins.CfnPipelinePropsMixin.PipelineTagProperty(
    key="key",
    value="value"
)

Attributes

key

The key name of a tag.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetag.html#cfn-datapipeline-pipeline-pipelinetag-key

value

The value to associate with the key name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datapipeline-pipeline-pipelinetag.html#cfn-datapipeline-pipeline-pipelinetag-value