Package software.amazon.awscdk.cfnpropertymixins.services.iotanalytics

Class CfnPipelinePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.iotanalytics.CfnPipelinePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.301Z")
@Stability(Stable)
public class CfnPipelinePropsMixin
extends Mixin
implements software.constructs.IMixin

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 in the User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iotanalytics.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnPipelinePropsMixin cfnPipelinePropsMixin = CfnPipelinePropsMixin.Builder.create(CfnPipelineMixinProps.builder()
         .pipelineActivities(List.of(ActivityProperty.builder()
                 .addAttributes(AddAttributesProperty.builder()
                         .attributes(Map.of(
                                 "attributesKey", "attributes"))
                         .name("name")
                         .next("next")
                         .build())
                 .channel(ChannelProperty.builder()
                         .channelName("channelName")
                         .name("name")
                         .next("next")
                         .build())
                 .datastore(DatastoreProperty.builder()
                         .datastoreName("datastoreName")
                         .name("name")
                         .build())
                 .deviceRegistryEnrich(DeviceRegistryEnrichProperty.builder()
                         .attribute("attribute")
                         .name("name")
                         .next("next")
                         .roleArn("roleArn")
                         .thingName("thingName")
                         .build())
                 .deviceShadowEnrich(DeviceShadowEnrichProperty.builder()
                         .attribute("attribute")
                         .name("name")
                         .next("next")
                         .roleArn("roleArn")
                         .thingName("thingName")
                         .build())
                 .filter(FilterProperty.builder()
                         .filter("filter")
                         .name("name")
                         .next("next")
                         .build())
                 .lambda(LambdaProperty.builder()
                         .batchSize(123)
                         .lambdaName("lambdaName")
                         .name("name")
                         .next("next")
                         .build())
                 .math(MathProperty.builder()
                         .attribute("attribute")
                         .math("math")
                         .name("name")
                         .next("next")
                         .build())
                 .removeAttributes(RemoveAttributesProperty.builder()
                         .attributes(List.of("attributes"))
                         .name("name")
                         .next("next")
                         .build())
                 .selectAttributes(SelectAttributesProperty.builder()
                         .attributes(List.of("attributes"))
                         .name("name")
                         .next("next")
                         .build())
                 .build()))
         .pipelineName("pipelineName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnPipelinePropsMixin.ActivityProperty	An activity that performs a transformation on a message.
static interface	CfnPipelinePropsMixin.AddAttributesProperty	An activity that adds other attributes based on existing attributes in the message.
static final class	CfnPipelinePropsMixin.Builder	A fluent builder for CfnPipelinePropsMixin.
static interface	CfnPipelinePropsMixin.ChannelProperty	Determines the source of the messages to be processed.
static interface	CfnPipelinePropsMixin.DatastoreProperty	The datastore activity that specifies where to store the processed data.
static interface	CfnPipelinePropsMixin.DeviceRegistryEnrichProperty	An activity that adds data from the AWS IoT device registry to your message.
static interface	CfnPipelinePropsMixin.DeviceShadowEnrichProperty	An activity that adds information from the AWS IoT Device Shadows service to a message.
static interface	CfnPipelinePropsMixin.FilterProperty	An activity that filters a message based on its attributes.
static interface	CfnPipelinePropsMixin.LambdaProperty	An activity that runs a Lambda function to modify the message.
static interface	CfnPipelinePropsMixin.MathProperty	An activity that computes an arithmetic expression using the message's attributes.
static interface	CfnPipelinePropsMixin.RemoveAttributesProperty	An activity that removes attributes from a message.
static interface	CfnPipelinePropsMixin.SelectAttributesProperty	Creates a new message using only the specified attributes from the original message.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnPipelinePropsMixin(CfnPipelineMixinProps props)	Create a mixin to apply properties to AWS::IoTAnalytics::Pipeline.
	CfnPipelinePropsMixin(CfnPipelineMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::IoTAnalytics::Pipeline.
protected	CfnPipelinePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPipelinePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnPipelineMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnPipelinePropsMixin

protected CfnPipelinePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnPipelinePropsMixin

protected CfnPipelinePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnPipelinePropsMixin

@Stability(Stable)
public CfnPipelinePropsMixin(@NotNull
 CfnPipelineMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::IoTAnalytics::Pipeline.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnPipelinePropsMixin

@Stability(Stable)
public CfnPipelinePropsMixin(@NotNull
 CfnPipelineMixinProps props)

Create a mixin to apply properties to AWS::IoTAnalytics::Pipeline.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnPipelineMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()