CfnPipelinePropsMixin

class aws_cdk.cfn_property_mixins.aws_iotsitewise.CfnPipelinePropsMixin(props, *, strategy=None)

Bases: Mixin

Resource schema for AWS::IoTSiteWise::Pipeline.

A pipeline defines a directed acyclic graph (DAG) of compute nodes, where each node references a task definition and can declare dependencies on other nodes.

See:

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

CloudformationResource:

AWS::IoTSiteWise::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.cfn_property_mixins import aws_iotsitewise as iotsitewise
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_pipeline_props_mixin = iotsitewise.CfnPipelinePropsMixin(iotsitewise.CfnPipelineMixinProps(
    computations=[iotsitewise.CfnPipelinePropsMixin.ComputeNodeProperty(
        compute_node_name="computeNodeName",
        depends_on=["dependsOn"],
        environment_variables={
            "environment_variables_key": "environmentVariables"
        },
        task_name="taskName"
    )],
    description="description",
    environment_variables={
        "environment_variables_key": "environmentVariables"
    },
    pipeline_name="pipelineName",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    workspace_name="workspaceName"
),
    strategy=merge_strategy
)

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

Parameters:

• props (Union[CfnPipelineMixinProps, Dict[str, Any]]) – L1 properties to apply.

• strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

None

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['computations', 'description', 'environmentVariables', 'pipelineName', 'tags', 'workspaceName']

Static Methods

classmethod is_mixin(x)

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.

ComputeNodeProperty

class CfnPipelinePropsMixin.ComputeNodeProperty(*, compute_node_name=None, depends_on=None, environment_variables=None, task_name=None)

Bases: object

A single compute node in a pipeline DAG.

Parameters:

• compute_node_name (Optional[str]) – The unique name for this compute node within the pipeline.

• depends_on (Optional[Sequence[str]]) – A list of compute node names that must complete successfully before this node can start.

• environment_variables (Union[IResolvable, Mapping[str, str], None]) – A map of environment variable key-value pairs.

• task_name (Optional[str]) – The name of the task to execute for this compute node.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-pipeline-computenode.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.cfn_property_mixins import aws_iotsitewise as iotsitewise

compute_node_property = iotsitewise.CfnPipelinePropsMixin.ComputeNodeProperty(
    compute_node_name="computeNodeName",
    depends_on=["dependsOn"],
    environment_variables={
        "environment_variables_key": "environmentVariables"
    },
    task_name="taskName"
)

Attributes

compute_node_name

The unique name for this compute node within the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-pipeline-computenode.html#cfn-iotsitewise-pipeline-computenode-computenodename

depends_on

A list of compute node names that must complete successfully before this node can start.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-pipeline-computenode.html#cfn-iotsitewise-pipeline-computenode-dependson

environment_variables

A map of environment variable key-value pairs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-pipeline-computenode.html#cfn-iotsitewise-pipeline-computenode-environmentvariables

task_name

The name of the task to execute for this compute node.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-pipeline-computenode.html#cfn-iotsitewise-pipeline-computenode-taskname