CfnPipelinePropsMixin

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

Bases: Mixin

The AWS::IoTAnalytics::Pipeline resource consumes messages from one or more channels and allows you to process the messages before storing them in a data store.

You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array. For more information, see How to Use AWS IoT Analytics in the AWS IoT Analytics User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html
CloudformationResource:: AWS::IoTAnalytics::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_iotanalytics import mixins as iotanalytics_mixins

cfn_pipeline_props_mixin = iotanalytics_mixins.CfnPipelinePropsMixin(iotanalytics_mixins.CfnPipelineMixinProps(
    pipeline_activities=[iotanalytics_mixins.CfnPipelinePropsMixin.ActivityProperty(
        add_attributes=iotanalytics_mixins.CfnPipelinePropsMixin.AddAttributesProperty(
            attributes={
                "attributes_key": "attributes"
            },
            name="name",
            next="next"
        ),
        channel=iotanalytics_mixins.CfnPipelinePropsMixin.ChannelProperty(
            channel_name="channelName",
            name="name",
            next="next"
        ),
        datastore=iotanalytics_mixins.CfnPipelinePropsMixin.DatastoreProperty(
            datastore_name="datastoreName",
            name="name"
        ),
        device_registry_enrich=iotanalytics_mixins.CfnPipelinePropsMixin.DeviceRegistryEnrichProperty(
            attribute="attribute",
            name="name",
            next="next",
            role_arn="roleArn",
            thing_name="thingName"
        ),
        device_shadow_enrich=iotanalytics_mixins.CfnPipelinePropsMixin.DeviceShadowEnrichProperty(
            attribute="attribute",
            name="name",
            next="next",
            role_arn="roleArn",
            thing_name="thingName"
        ),
        filter=iotanalytics_mixins.CfnPipelinePropsMixin.FilterProperty(
            filter="filter",
            name="name",
            next="next"
        ),
        lambda_=iotanalytics_mixins.CfnPipelinePropsMixin.LambdaProperty(
            batch_size=123,
            lambda_name="lambdaName",
            name="name",
            next="next"
        ),
        math=iotanalytics_mixins.CfnPipelinePropsMixin.MathProperty(
            attribute="attribute",
            math="math",
            name="name",
            next="next"
        ),
        remove_attributes=iotanalytics_mixins.CfnPipelinePropsMixin.RemoveAttributesProperty(
            attributes=["attributes"],
            name="name",
            next="next"
        ),
        select_attributes=iotanalytics_mixins.CfnPipelinePropsMixin.SelectAttributesProperty(
            attributes=["attributes"],
            name="name",
            next="next"
        )
    )],
    pipeline_name="pipelineName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTAnalytics::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 = ['pipelineActivities', 'pipelineName', 'tags']

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

ActivityProperty

class CfnPipelinePropsMixin.ActivityProperty(*, add_attributes=None, channel=None, datastore=None, device_registry_enrich=None, device_shadow_enrich=None, filter=None, lambda_=None, math=None, remove_attributes=None, select_attributes=None)

Bases: object

An activity that performs a transformation on a message.

Parameters:

add_attributes (Union[IResolvable, AddAttributesProperty, Dict[str, Any], None]) – Adds other attributes based on existing attributes in the message.
channel (Union[IResolvable, ChannelProperty, Dict[str, Any], None]) – Determines the source of the messages to be processed.
datastore (Union[IResolvable, DatastoreProperty, Dict[str, Any], None]) – Specifies where to store the processed message data.
device_registry_enrich (Union[IResolvable, DeviceRegistryEnrichProperty, Dict[str, Any], None]) – Adds data from the AWS IoT device registry to your message.
device_shadow_enrich (Union[IResolvable, DeviceShadowEnrichProperty, Dict[str, Any], None]) – Adds information from the AWS IoT Device Shadows service to a message.
filter (Union[IResolvable, FilterProperty, Dict[str, Any], None]) – Filters a message based on its attributes.
lambda – Runs a Lambda function to modify the message.
math (Union[IResolvable, MathProperty, Dict[str, Any], None]) – Computes an arithmetic expression using the message’s attributes and adds it to the message.
remove_attributes (Union[IResolvable, RemoveAttributesProperty, Dict[str, Any], None]) – Removes attributes from a message.
select_attributes (Union[IResolvable, SelectAttributesProperty, Dict[str, Any], None]) – Creates a new message using only the specified attributes from the original message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.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_iotanalytics import mixins as iotanalytics_mixins

activity_property = iotanalytics_mixins.CfnPipelinePropsMixin.ActivityProperty(
    add_attributes=iotanalytics_mixins.CfnPipelinePropsMixin.AddAttributesProperty(
        attributes={
            "attributes_key": "attributes"
        },
        name="name",
        next="next"
    ),
    channel=iotanalytics_mixins.CfnPipelinePropsMixin.ChannelProperty(
        channel_name="channelName",
        name="name",
        next="next"
    ),
    datastore=iotanalytics_mixins.CfnPipelinePropsMixin.DatastoreProperty(
        datastore_name="datastoreName",
        name="name"
    ),
    device_registry_enrich=iotanalytics_mixins.CfnPipelinePropsMixin.DeviceRegistryEnrichProperty(
        attribute="attribute",
        name="name",
        next="next",
        role_arn="roleArn",
        thing_name="thingName"
    ),
    device_shadow_enrich=iotanalytics_mixins.CfnPipelinePropsMixin.DeviceShadowEnrichProperty(
        attribute="attribute",
        name="name",
        next="next",
        role_arn="roleArn",
        thing_name="thingName"
    ),
    filter=iotanalytics_mixins.CfnPipelinePropsMixin.FilterProperty(
        filter="filter",
        name="name",
        next="next"
    ),
    lambda_=iotanalytics_mixins.CfnPipelinePropsMixin.LambdaProperty(
        batch_size=123,
        lambda_name="lambdaName",
        name="name",
        next="next"
    ),
    math=iotanalytics_mixins.CfnPipelinePropsMixin.MathProperty(
        attribute="attribute",
        math="math",
        name="name",
        next="next"
    ),
    remove_attributes=iotanalytics_mixins.CfnPipelinePropsMixin.RemoveAttributesProperty(
        attributes=["attributes"],
        name="name",
        next="next"
    ),
    select_attributes=iotanalytics_mixins.CfnPipelinePropsMixin.SelectAttributesProperty(
        attributes=["attributes"],
        name="name",
        next="next"
    )
)

Attributes

add_attributes

Adds other attributes based on existing attributes in the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-addattributes

channel

Determines the source of the messages to be processed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-channel

datastore

Specifies where to store the processed message data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-datastore

device_registry_enrich

Adds data from the AWS IoT device registry to your message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceregistryenrich

device_shadow_enrich

Adds information from the AWS IoT Device Shadows service to a message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceshadowenrich

filter

Filters a message based on its attributes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-filter

lambda_

Runs a Lambda function to modify the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-lambda

math

Computes an arithmetic expression using the message’s attributes and adds it to the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-math

remove_attributes

Removes attributes from a message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-removeattributes

select_attributes

Creates a new message using only the specified attributes from the original message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-selectattributes

AddAttributesProperty

class CfnPipelinePropsMixin.AddAttributesProperty(*, attributes=None, name=None, next=None)

Bases: object

An activity that adds other attributes based on existing attributes in the message.

Parameters:

attributes (Union[Mapping[str, str], IResolvable, None]) – A list of 1-50 “AttributeNameMapping” objects that map an existing attribute to a new attribute. .. epigraph:: The existing attributes remain in the message, so if you want to remove the originals, use “RemoveAttributeActivity”.
name (Optional[str]) – The name of the ‘addAttributes’ activity.
next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.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_iotanalytics import mixins as iotanalytics_mixins

add_attributes_property = iotanalytics_mixins.CfnPipelinePropsMixin.AddAttributesProperty(
    attributes={
        "attributes_key": "attributes"
    },
    name="name",
    next="next"
)

Attributes

attributes

A list of 1-50 “AttributeNameMapping” objects that map an existing attribute to a new attribute.

The existing attributes remain in the message, so if you want to remove the originals, use “RemoveAttributeActivity”.

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

name

The name of the ‘addAttributes’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-addattributes.html#cfn-iotanalytics-pipeline-addattributes-next

ChannelProperty

class CfnPipelinePropsMixin.ChannelProperty(*, channel_name=None, name=None, next=None)

Bases: object

Determines the source of the messages to be processed.

Parameters:

channel_name (Optional[str]) – The name of the channel from which the messages are processed.
name (Optional[str]) – The name of the ‘channel’ activity.
next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.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_iotanalytics import mixins as iotanalytics_mixins

channel_property = iotanalytics_mixins.CfnPipelinePropsMixin.ChannelProperty(
    channel_name="channelName",
    name="name",
    next="next"
)

Attributes

channel_name

The name of the channel from which the messages are processed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-channelname

name

The name of the ‘channel’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-channel.html#cfn-iotanalytics-pipeline-channel-next

DatastoreProperty

class CfnPipelinePropsMixin.DatastoreProperty(*, datastore_name=None, name=None)

Bases: object

The datastore activity that specifies where to store the processed data.

Parameters:

datastore_name (Optional[str]) – The name of the data store where processed messages are stored.
name (Optional[str]) – The name of the datastore activity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.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_iotanalytics import mixins as iotanalytics_mixins

datastore_property = iotanalytics_mixins.CfnPipelinePropsMixin.DatastoreProperty(
    datastore_name="datastoreName",
    name="name"
)

Attributes

datastore_name

The name of the data store where processed messages are stored.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-datastore.html#cfn-iotanalytics-pipeline-datastore-datastorename

name

The name of the datastore activity.

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

DeviceRegistryEnrichProperty

class CfnPipelinePropsMixin.DeviceRegistryEnrichProperty(*, attribute=None, name=None, next=None, role_arn=None, thing_name=None)

Bases: object

An activity that adds data from the AWS IoT device registry to your message.

Parameters:

attribute (Optional[str]) – The name of the attribute that is added to the message.
name (Optional[str]) – The name of the ‘deviceRegistryEnrich’ activity.
next (Optional[str]) – The next activity in the pipeline.
role_arn (Optional[str]) – The ARN of the role that allows access to the device’s registry information.
thing_name (Optional[str]) – The name of the IoT device whose registry information is added to the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.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_iotanalytics import mixins as iotanalytics_mixins

device_registry_enrich_property = iotanalytics_mixins.CfnPipelinePropsMixin.DeviceRegistryEnrichProperty(
    attribute="attribute",
    name="name",
    next="next",
    role_arn="roleArn",
    thing_name="thingName"
)

Attributes

attribute

The name of the attribute that is added to the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-attribute

name

The name of the ‘deviceRegistryEnrich’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-next

role_arn

The ARN of the role that allows access to the device’s registry information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-rolearn

thing_name

The name of the IoT device whose registry information is added to the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceregistryenrich.html#cfn-iotanalytics-pipeline-deviceregistryenrich-thingname

DeviceShadowEnrichProperty

class CfnPipelinePropsMixin.DeviceShadowEnrichProperty(*, attribute=None, name=None, next=None, role_arn=None, thing_name=None)

Bases: object

An activity that adds information from the AWS IoT Device Shadows service to a message.

Parameters:

attribute (Optional[str]) – The name of the attribute that is added to the message.
name (Optional[str]) – The name of the ‘deviceShadowEnrich’ activity.
next (Optional[str]) – The next activity in the pipeline.
role_arn (Optional[str]) – The ARN of the role that allows access to the device’s shadow.
thing_name (Optional[str]) – The name of the IoT device whose shadow information is added to the message.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.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_iotanalytics import mixins as iotanalytics_mixins

device_shadow_enrich_property = iotanalytics_mixins.CfnPipelinePropsMixin.DeviceShadowEnrichProperty(
    attribute="attribute",
    name="name",
    next="next",
    role_arn="roleArn",
    thing_name="thingName"
)

Attributes

attribute

The name of the attribute that is added to the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-attribute

name

The name of the ‘deviceShadowEnrich’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-next

role_arn

The ARN of the role that allows access to the device’s shadow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-rolearn

thing_name

The name of the IoT device whose shadow information is added to the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-thingname

FilterProperty

class CfnPipelinePropsMixin.FilterProperty(*, filter=None, name=None, next=None)

Bases: object

An activity that filters a message based on its attributes.

Parameters:

filter (Optional[str]) – An expression that looks like an SQL WHERE clause that must return a Boolean value.
name (Optional[str]) – The name of the ‘filter’ activity.
next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.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_iotanalytics import mixins as iotanalytics_mixins

filter_property = iotanalytics_mixins.CfnPipelinePropsMixin.FilterProperty(
    filter="filter",
    name="name",
    next="next"
)

Attributes

filter

An expression that looks like an SQL WHERE clause that must return a Boolean value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-filter

name

The name of the ‘filter’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-filter.html#cfn-iotanalytics-pipeline-filter-next

LambdaProperty

class CfnPipelinePropsMixin.LambdaProperty(*, batch_size=None, lambda_name=None, name=None, next=None)

Bases: object

An activity that runs a Lambda function to modify the message.

Parameters:

batch_size (Union[int, float, None]) – The number of messages passed to the Lambda function for processing. The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.
lambda_name (Optional[str]) – The name of the Lambda function that is run on the message.
name (Optional[str]) – The name of the ‘lambda’ activity.
next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.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_iotanalytics import mixins as iotanalytics_mixins

lambda_property = iotanalytics_mixins.CfnPipelinePropsMixin.LambdaProperty(
    batch_size=123,
    lambda_name="lambdaName",
    name="name",
    next="next"
)

Attributes

batch_size

The number of messages passed to the Lambda function for processing.

The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-batchsize

lambda_name

The name of the Lambda function that is run on the message.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-lambdaname

name

The name of the ‘lambda’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-lambda.html#cfn-iotanalytics-pipeline-lambda-next

MathProperty

class CfnPipelinePropsMixin.MathProperty(*, attribute=None, math=None, name=None, next=None)

Bases: object

An activity that computes an arithmetic expression using the message’s attributes.

Parameters:

attribute (Optional[str]) – The name of the attribute that contains the result of the math operation.
math (Optional[str]) – An expression that uses one or more existing attributes and must return an integer value.
name (Optional[str]) – The name of the ‘math’ activity.
next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.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_iotanalytics import mixins as iotanalytics_mixins

math_property = iotanalytics_mixins.CfnPipelinePropsMixin.MathProperty(
    attribute="attribute",
    math="math",
    name="name",
    next="next"
)

Attributes

attribute

The name of the attribute that contains the result of the math operation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-attribute

math

An expression that uses one or more existing attributes and must return an integer value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-math

name

The name of the ‘math’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-math.html#cfn-iotanalytics-pipeline-math-next

RemoveAttributesProperty

class CfnPipelinePropsMixin.RemoveAttributesProperty(*, attributes=None, name=None, next=None)

Bases: object

An activity that removes attributes from a message.

Parameters:

attributes (Optional[Sequence[str]]) – A list of 1-50 attributes to remove from the message.
name (Optional[str]) – The name of the ‘removeAttributes’ activity.
next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.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_iotanalytics import mixins as iotanalytics_mixins

remove_attributes_property = iotanalytics_mixins.CfnPipelinePropsMixin.RemoveAttributesProperty(
    attributes=["attributes"],
    name="name",
    next="next"
)

Attributes

attributes

A list of 1-50 attributes to remove from the message.

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

name

The name of the ‘removeAttributes’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-removeattributes.html#cfn-iotanalytics-pipeline-removeattributes-next

SelectAttributesProperty

class CfnPipelinePropsMixin.SelectAttributesProperty(*, attributes=None, name=None, next=None)

Bases: object

Creates a new message using only the specified attributes from the original message.

Parameters:

attributes (Optional[Sequence[str]]) – A list of the attributes to select from the message.
name (Optional[str]) – The name of the ‘selectAttributes’ activity.
next (Optional[str]) – The next activity in the pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.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_iotanalytics import mixins as iotanalytics_mixins

select_attributes_property = iotanalytics_mixins.CfnPipelinePropsMixin.SelectAttributesProperty(
    attributes=["attributes"],
    name="name",
    next="next"
)

Attributes

attributes

A list of the attributes to select from the message.

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

name

The name of the ‘selectAttributes’ activity.

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

next

The next activity in the pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-selectattributes.html#cfn-iotanalytics-pipeline-selectattributes-next