Class CfnPipeline
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.
Inherited Members
Namespace: Amazon.CDK.AWS.IoTAnalytics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnPipeline : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnPipeline
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 AWS IoT Analytics in the AWS IoT Analytics User Guide .
CloudformationResource: AWS::IoTAnalytics::Pipeline
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 cfnPipeline = new CfnPipeline(this, "MyCfnPipeline", new CfnPipelineProps {
PipelineActivities = new [] { 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"
}
} },
// the properties below are optional
PipelineName = "pipelineName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnPipeline(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnPipeline(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnPipeline(Construct, String, ICfnPipelineProps) |
Properties
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
PipelineActivities | A list of "PipelineActivity" objects. |
PipelineName | The name of the pipeline. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | Metadata which can be used to manage the pipeline. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnPipeline(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnPipeline(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnPipeline(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnPipeline(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnPipeline(Construct, String, ICfnPipelineProps)
public CfnPipeline(Construct scope, string id, ICfnPipelineProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnPipelineProps
Resource properties.
Properties
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
PipelineActivities
A list of "PipelineActivity" objects.
public virtual object PipelineActivities { get; set; }
Property Value
System.Object
PipelineName
The name of the pipeline.
public virtual string PipelineName { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Metadata which can be used to manage the pipeline.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>