Interface CfnPipeline.IActivityProperty

An activity that performs a transformation on a message.

Namespace: Amazon.CDK.AWS.IoTAnalytics

Assembly: Amazon.CDK.AWS.IoTAnalytics.dll

Syntax (csharp)

public interface IActivityProperty

Syntax (vb)

Public Interface IActivityProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTAnalytics;

var activityProperty = new ActivityProperty {
    AddAttributes = new AddAttributesProperty {
        Attributes = new Dictionary<string, string> {
            { "attributesKey", "attributes" }
        },
        Name = "name",

        // the properties below are optional
        Next = "next"
    },
    Channel = new ChannelProperty {
        ChannelName = "channelName",
        Name = "name",

        // the properties below are optional
        Next = "next"
    },
    Datastore = new DatastoreProperty {
        DatastoreName = "datastoreName",
        Name = "name"
    },
    DeviceRegistryEnrich = new DeviceRegistryEnrichProperty {
        Attribute = "attribute",
        Name = "name",
        RoleArn = "roleArn",
        ThingName = "thingName",

        // the properties below are optional
        Next = "next"
    },
    DeviceShadowEnrich = new DeviceShadowEnrichProperty {
        Attribute = "attribute",
        Name = "name",
        RoleArn = "roleArn",
        ThingName = "thingName",

        // the properties below are optional
        Next = "next"
    },
    Filter = new FilterProperty {
        Filter = "filter",
        Name = "name",

        // the properties below are optional
        Next = "next"
    },
    Lambda = new LambdaProperty {
        BatchSize = 123,
        LambdaName = "lambdaName",
        Name = "name",

        // the properties below are optional
        Next = "next"
    },
    Math = new MathProperty {
        Attribute = "attribute",
        Math = "math",
        Name = "name",

        // the properties below are optional
        Next = "next"
    },
    RemoveAttributes = new RemoveAttributesProperty {
        Attributes = new [] { "attributes" },
        Name = "name",

        // the properties below are optional
        Next = "next"
    },
    SelectAttributes = new SelectAttributesProperty {
        Attributes = new [] { "attributes" },
        Name = "name",

        // the properties below are optional
        Next = "next"
    }
};

Synopsis

Properties

AddAttributes	Adds other attributes based on existing attributes in the message.
Channel	Determines the source of the messages to be processed.
Datastore	Specifies where to store the processed message data.
DeviceRegistryEnrich	Adds data from the AWS IoT device registry to your message.
DeviceShadowEnrich	Adds information from the AWS IoT Device Shadows service to a message.
Filter	Filters a message based on its attributes.
Lambda	Runs a Lambda function to modify the message.
Math	Computes an arithmetic expression using the message's attributes and adds it to the message.
RemoveAttributes	Removes attributes from a message.
SelectAttributes	Creates a new message using only the specified attributes from the original message.

Properties

AddAttributes

Adds other attributes based on existing attributes in the message.

virtual object AddAttributes { get; }

Property Value

System.Object

Remarks

Link: 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.

virtual object Channel { get; }

Property Value

System.Object

Remarks

Link: 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.

virtual object Datastore { get; }

Property Value

System.Object

Remarks

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

DeviceRegistryEnrich

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

virtual object DeviceRegistryEnrich { get; }

Property Value

System.Object

Remarks

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

DeviceShadowEnrich

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

virtual object DeviceShadowEnrich { get; }

Property Value

System.Object

Remarks

Link: 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.

virtual object Filter { get; }

Property Value

System.Object

Remarks

Link: 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.

virtual object Lambda { get; }

Property Value

System.Object

Remarks

Link: 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.

virtual object Math { get; }

Property Value

System.Object

Remarks

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

RemoveAttributes

Removes attributes from a message.

virtual object RemoveAttributes { get; }

Property Value

System.Object

Remarks

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

SelectAttributes

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

virtual object SelectAttributes { get; }

Property Value

System.Object

Remarks

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