Package software.amazon.awscdk.services.iotanalytics

Interface CfnPipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:08.483Z")
@Stability(Stable)
public interface CfnPipelineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPipeline.

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.*;
 CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder()
         .pipelineActivities(List.of(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()))
         // the properties below are optional
         .pipelineName("pipelineName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipelineProps.Builder	builder()
Object	getPipelineActivities()	A list of "PipelineActivity" objects.
default String	getPipelineName()	The name of the pipeline.
default List<CfnTag>	getTags()	Metadata which can be used to manage the pipeline.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPipelineActivities

@Stability(Stable)
@NotNull
Object getPipelineActivities()

A list of "PipelineActivity" objects.

Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data.

The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example:

pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelineactivities

getPipelineName

@Stability(Stable)
@Nullable
default String getPipelineName()

The name of the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-pipelinename

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata which can be used to manage the pipeline.

For more information, see Tag .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotanalytics-pipeline.html#cfn-iotanalytics-pipeline-tags

builder

@Stability(Stable)
static CfnPipelineProps.Builder builder()

Returns:

a CfnPipelineProps.Builder of CfnPipelineProps