software.amazon.awscdk.services.iotanalytics

Class CfnPipeline

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iotanalytics.CfnPipeline

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.037Z")
 @Stability(value=Stable)
public class CfnPipeline
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTAnalytics::Pipeline`.

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.*;
 Object attributes;
 CfnPipeline cfnPipeline = CfnPipeline.Builder.create(this, "MyCfnPipeline")
         .pipelineActivities(List.of(ActivityProperty.builder()
                 .addAttributes(AddAttributesProperty.builder()
                         .attributes(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()))
         // the properties below are optional
         .pipelineName("pipelineName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnPipeline.ActivityProperty Example:
static interface	CfnPipeline.AddAttributesProperty Example:
static class	CfnPipeline.Builder A fluent builder for CfnPipeline.
static interface	CfnPipeline.ChannelProperty Example:
static interface	CfnPipeline.DatastoreProperty Example:
static interface	CfnPipeline.DeviceRegistryEnrichProperty Example:
static interface	CfnPipeline.DeviceShadowEnrichProperty Example:
static interface	CfnPipeline.FilterProperty Example:
static interface	CfnPipeline.LambdaProperty Example:
static interface	CfnPipeline.MathProperty Example:
static interface	CfnPipeline.RemoveAttributesProperty Example:
static interface	CfnPipeline.SelectAttributesProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPipeline(software.constructs.Construct scope, String id, CfnPipelineProps props) Create a new `AWS::IoTAnalytics::Pipeline`.
protected	CfnPipeline(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPipeline(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
Object	getPipelineActivities() `AWS::IoTAnalytics::Pipeline.PipelineActivities`.
String	getPipelineName() `AWS::IoTAnalytics::Pipeline.PipelineName`.
TagManager	getTags() `AWS::IoTAnalytics::Pipeline.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setPipelineActivities(IResolvable value) `AWS::IoTAnalytics::Pipeline.PipelineActivities`.
void	setPipelineActivities(List<Object> value) `AWS::IoTAnalytics::Pipeline.PipelineActivities`.
void	setPipelineName(String value) `AWS::IoTAnalytics::Pipeline.PipelineName`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPipeline

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

CfnPipeline

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

CfnPipeline

@Stability(value=Stable)
public CfnPipeline(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnPipelineProps props)

Create a new `AWS::IoTAnalytics::Pipeline`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getPipelineActivities

@Stability(value=Stable)
 @NotNull
public Object getPipelineActivities()

`AWS::IoTAnalytics::Pipeline.PipelineActivities`.

setPipelineActivities

@Stability(value=Stable)
public void setPipelineActivities(@NotNull
                                                           IResolvable value)

`AWS::IoTAnalytics::Pipeline.PipelineActivities`.

setPipelineActivities

@Stability(value=Stable)
public void setPipelineActivities(@NotNull
                                                           List<Object> value)

`AWS::IoTAnalytics::Pipeline.PipelineActivities`.

getPipelineName

@Stability(value=Stable)
 @Nullable
public String getPipelineName()

`AWS::IoTAnalytics::Pipeline.PipelineName`.

setPipelineName

@Stability(value=Stable)
public void setPipelineName(@Nullable
                                                     String value)

`AWS::IoTAnalytics::Pipeline.PipelineName`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::IoTAnalytics::Pipeline.Tags`.