CfnPipeline

class aws_cdk.aws_datapipeline.CfnPipeline(scope, id, *, name, activate=None, description=None, parameter_objects=None, parameter_values=None, pipeline_objects=None, pipeline_tags=None)

Bases: CfnResource

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
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 import aws_datapipeline as datapipeline

cfn_pipeline = datapipeline.CfnPipeline(self, "MyCfnPipeline",
    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"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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 (Optional[Sequence[Union[PipelineTagProperty, Dict[str, Any]]]]) – 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 .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DataPipeline::Pipeline'

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

attr_id

Id

Type:: cloudformationAttribute

attr_pipeline_id

The ID of the pipeline.

CloudformationAttribute:: PipelineId

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: A description of the pipeline.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the pipeline.

node: The tree node.

parameter_objects: The parameter objects used with the pipeline.

parameter_values: The parameter values used with the pipeline.

pipeline_objects: The objects that define the pipeline.

pipeline_tags: A list of arbitrary tags (key-value pairs) to associate with the pipeline, which you can use to control permissions.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

FieldProperty

class CfnPipeline.FieldProperty(*, key, 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 (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 import aws_datapipeline as datapipeline

field_property = datapipeline.CfnPipeline.FieldProperty(
    key="key",

    # the properties below are optional
    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 CfnPipeline.ParameterAttributeProperty(*, key, string_value)

Bases: object

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

Parameters:

key (str) – The field identifier.
string_value (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 import aws_datapipeline as datapipeline

parameter_attribute_property = datapipeline.CfnPipeline.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 CfnPipeline.ParameterObjectProperty(*, attributes, id)

Bases: object

Contains information about a parameter object.

Parameters:

attributes (Union[IResolvable, Sequence[Union[IResolvable, ParameterAttributeProperty, Dict[str, Any]]]]) – The attributes of the parameter object.
id (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 import aws_datapipeline as datapipeline

parameter_object_property = datapipeline.CfnPipeline.ParameterObjectProperty(
    attributes=[datapipeline.CfnPipeline.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 CfnPipeline.ParameterValueProperty(*, id, string_value)

Bases: object

A value or list of parameter values.

Parameters:

id (str) – The ID of the parameter value.
string_value (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 import aws_datapipeline as datapipeline

parameter_value_property = datapipeline.CfnPipeline.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 CfnPipeline.PipelineObjectProperty(*, fields, id, name)

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]]]]) – Key-value pairs that define the properties of the object.
id (str) – The ID of the object.
name (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 import aws_datapipeline as datapipeline

pipeline_object_property = datapipeline.CfnPipeline.PipelineObjectProperty(
    fields=[datapipeline.CfnPipeline.FieldProperty(
        key="key",

        # the properties below are optional
        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 CfnPipeline.PipelineTagProperty(*, key, value)

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 (str) – The key name of a tag.
value (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 import aws_datapipeline as datapipeline

pipeline_tag_property = datapipeline.CfnPipeline.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