Package software.amazon.awscdk.services.iotanalytics

Interface CfnPipeline.ActivityProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.ActivityProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

@Stability(Stable)
public static interface CfnPipeline.ActivityProperty
extends software.amazon.jsii.JsiiSerializable

An activity that performs a transformation on a message.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotanalytics.*;
 ActivityProperty activityProperty = ActivityProperty.builder()
         .addAttributes(AddAttributesProperty.builder()
                 .attributes(Map.of(
                         "attributesKey", "attributes"))
                 .name("name")
                 // the properties below are optional
                 .next("next")
                 .build())
         .channel(ChannelProperty.builder()
                 .channelName("channelName")
                 .name("name")
                 // the properties below are optional
                 .next("next")
                 .build())
         .datastore(DatastoreProperty.builder()
                 .datastoreName("datastoreName")
                 .name("name")
                 .build())
         .deviceRegistryEnrich(DeviceRegistryEnrichProperty.builder()
                 .attribute("attribute")
                 .name("name")
                 .roleArn("roleArn")
                 .thingName("thingName")
                 // the properties below are optional
                 .next("next")
                 .build())
         .deviceShadowEnrich(DeviceShadowEnrichProperty.builder()
                 .attribute("attribute")
                 .name("name")
                 .roleArn("roleArn")
                 .thingName("thingName")
                 // the properties below are optional
                 .next("next")
                 .build())
         .filter(FilterProperty.builder()
                 .filter("filter")
                 .name("name")
                 // the properties below are optional
                 .next("next")
                 .build())
         .lambda(LambdaProperty.builder()
                 .batchSize(123)
                 .lambdaName("lambdaName")
                 .name("name")
                 // the properties below are optional
                 .next("next")
                 .build())
         .math(MathProperty.builder()
                 .attribute("attribute")
                 .math("math")
                 .name("name")
                 // the properties below are optional
                 .next("next")
                 .build())
         .removeAttributes(RemoveAttributesProperty.builder()
                 .attributes(List.of("attributes"))
                 .name("name")
                 // the properties below are optional
                 .next("next")
                 .build())
         .selectAttributes(SelectAttributesProperty.builder()
                 .attributes(List.of("attributes"))
                 .name("name")
                 // the properties below are optional
                 .next("next")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipeline.ActivityProperty.Builder	A builder for CfnPipeline.ActivityProperty
static final class	CfnPipeline.ActivityProperty.Jsii$Proxy	An implementation for CfnPipeline.ActivityProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.ActivityProperty.Builder	builder()
default Object	getAddAttributes()	Adds other attributes based on existing attributes in the message.
default Object	getChannel()	Determines the source of the messages to be processed.
default Object	getDatastore()	Specifies where to store the processed message data.
default Object	getDeviceRegistryEnrich()	Adds data from the AWS IoT device registry to your message.
default Object	getDeviceShadowEnrich()	Adds information from the AWS IoT Device Shadows service to a message.
default Object	getFilter()	Filters a message based on its attributes.
default Object	getLambda()	Runs a Lambda function to modify the message.
default Object	getMath()	Computes an arithmetic expression using the message's attributes and adds it to the message.
default Object	getRemoveAttributes()	Removes attributes from a message.
default Object	getSelectAttributes()	Creates a new message using only the specified attributes from the original message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddAttributes

@Stability(Stable)
@Nullable
default Object getAddAttributes()

Adds other attributes based on existing attributes in the message.

getChannel

@Stability(Stable)
@Nullable
default Object getChannel()

Determines the source of the messages to be processed.

getDatastore

@Stability(Stable)
@Nullable
default Object getDatastore()

Specifies where to store the processed message data.

getDeviceRegistryEnrich

@Stability(Stable)
@Nullable
default Object getDeviceRegistryEnrich()

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

getDeviceShadowEnrich

@Stability(Stable)
@Nullable
default Object getDeviceShadowEnrich()

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

getFilter

@Stability(Stable)
@Nullable
default Object getFilter()

Filters a message based on its attributes.

getLambda

@Stability(Stable)
@Nullable
default Object getLambda()

Runs a Lambda function to modify the message.

getMath

@Stability(Stable)
@Nullable
default Object getMath()

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

getRemoveAttributes

@Stability(Stable)
@Nullable
default Object getRemoveAttributes()

Removes attributes from a message.

getSelectAttributes

@Stability(Stable)
@Nullable
default Object getSelectAttributes()

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

builder

@Stability(Stable)
static CfnPipeline.ActivityProperty.Builder builder()

Returns:

a CfnPipeline.ActivityProperty.Builder of CfnPipeline.ActivityProperty