interface DeviceShadowEnrichProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.IoTAnalytics.CfnPipeline.DeviceShadowEnrichProperty |
 Java | software.amazon.awscdk.services.iotanalytics.CfnPipeline.DeviceShadowEnrichProperty |
 Python | aws_cdk.aws_iotanalytics.CfnPipeline.DeviceShadowEnrichProperty |
 TypeScript | @aws-cdk/aws-iotanalytics » CfnPipeline » DeviceShadowEnrichProperty |
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 * as iotanalytics from '@aws-cdk/aws-iotanalytics';
const deviceShadowEnrichProperty: iotanalytics.CfnPipeline.DeviceShadowEnrichProperty = {
attribute: 'attribute',
name: 'name',
roleArn: 'roleArn',
thingName: 'thingName',
// the properties below are optional
next: 'next',
};
Properties
| Name | Type | Description |
|---|---|---|
| attribute | string | The name of the attribute that is added to the message. |
| name | string | The name of the 'deviceShadowEnrich' activity. |
| role | string | The ARN of the role that allows access to the device's shadow. |
| thing | string | The name of the IoT device whose shadow information is added to the message. |
| next? | string | The next activity in the pipeline. |
attribute
Type:
string
The name of the attribute that is added to the message.
name
Type:
string
The name of the 'deviceShadowEnrich' activity.
roleArn
Type:
string
The ARN of the role that allows access to the device's shadow.
thingName
Type:
string
The name of the IoT device whose shadow information is added to the message.
next?
Type:
string
(optional)
The next activity in the pipeline.