Add-VSIoTAnalyticsPipelineActivity
Add-VSIoTAnalyticsPipelineActivity
SYNOPSIS
Adds an AWS::IoTAnalytics::Pipeline.Activity resource property to the template. An activity that performs a transformation on a message.
SYNTAX
Add-VSIoTAnalyticsPipelineActivity [[-SelectAttributes] <Object>] [[-Datastore] <Object>] [[-Filter] <Object>]
[[-AddAttributes] <Object>] [[-Channel] <Object>] [[-DeviceShadowEnrich] <Object>] [[-Math] <Object>]
[[-Lambda] <Object>] [[-DeviceRegistryEnrich] <Object>] [[-RemoveAttributes] <Object>] [<CommonParameters>]
DESCRIPTION
Adds an AWS::IoTAnalytics::Pipeline.Activity resource property to the template. An activity that performs a transformation on a message.
PARAMETERS
-SelectAttributes
Creates a new message using only the specified attributes from the original message.
Type: SelectAttributes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-selectattributes UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Datastore
Specifies where to store the processed message data.
Type: Datastore Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-datastore UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Filter
Filters a message based on its attributes.
Type: Filter Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-filter UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AddAttributes
Adds other attributes based on existing attributes in the message.
Type: AddAttributes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-addattributes UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Channel
Determines the source of the messages to be processed.
Type: Channel Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-channel UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DeviceShadowEnrich
Adds information from the AWS IoT Device Shadows service to a message.
Type: DeviceShadowEnrich Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceshadowenrich UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Math
Computes an arithmetic expression using the message’s attributes and adds it to the message.
Type: Math Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-math UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Lambda
Runs a Lambda function to modify the message.
Type: Lambda Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-lambda UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DeviceRegistryEnrich
Adds data from the AWS IoT device registry to your message.
Type: DeviceRegistryEnrich Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-deviceregistryenrich UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RemoveAttributes
Removes attributes from a message.
Type: RemoveAttributes Documentation: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-activity.html#cfn-iotanalytics-pipeline-activity-removeattributes UpdateType: Mutable
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.