Package software.amazon.awscdk.services.iotanalytics

Interface CfnPipeline.DeviceShadowEnrichProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipeline.DeviceShadowEnrichProperty.Jsii$Proxy

Enclosing class:

CfnPipeline

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

An activity that adds information from the AWS IoT Device Shadows service to 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.*;
 DeviceShadowEnrichProperty deviceShadowEnrichProperty = DeviceShadowEnrichProperty.builder()
         .attribute("attribute")
         .name("name")
         .roleArn("roleArn")
         .thingName("thingName")
         // the properties below are optional
         .next("next")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipeline.DeviceShadowEnrichProperty.Builder	builder()
String	getAttribute()	The name of the attribute that is added to the message.
String	getName()	The name of the 'deviceShadowEnrich' activity.
default String	getNext()	The next activity in the pipeline.
String	getRoleArn()	The ARN of the role that allows access to the device's shadow.
String	getThingName()	The name of the IoT device whose shadow information is added to the message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttribute

@Stability(Stable)
@NotNull
String getAttribute()

The name of the attribute that is added to the message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-attribute

getName

@Stability(Stable)
@NotNull
String getName()

The name of the 'deviceShadowEnrich' activity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-name

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The ARN of the role that allows access to the device's shadow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-rolearn

getThingName

@Stability(Stable)
@NotNull
String getThingName()

The name of the IoT device whose shadow information is added to the message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-thingname

getNext

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

The next activity in the pipeline.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-pipeline-deviceshadowenrich.html#cfn-iotanalytics-pipeline-deviceshadowenrich-next

builder

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

Returns:

a CfnPipeline.DeviceShadowEnrichProperty.Builder of CfnPipeline.DeviceShadowEnrichProperty