aws-cdk-lib.aws_iotanalytics.CfnPipeline.DeviceShadowEnrichProperty

interface DeviceShadowEnrichProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTAnalytics.CfnPipeline.DeviceShadowEnrichProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotanalytics#CfnPipeline_DeviceShadowEnrichProperty
Javasoftware.amazon.awscdk.services.iotanalytics.CfnPipeline.DeviceShadowEnrichProperty
Pythonaws_cdk.aws_iotanalytics.CfnPipeline.DeviceShadowEnrichProperty
TypeScript aws-cdk-lib » 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 { aws_iotanalytics as iotanalytics } from 'aws-cdk-lib';
const deviceShadowEnrichProperty: iotanalytics.CfnPipeline.DeviceShadowEnrichProperty = {
  attribute: 'attribute',
  name: 'name',
  roleArn: 'roleArn',
  thingName: 'thingName',

  // the properties below are optional
  next: 'next',
};

Properties

NameTypeDescription
attributestringThe name of the attribute that is added to the message.
namestringThe name of the 'deviceShadowEnrich' activity.
roleArnstringThe ARN of the role that allows access to the device's shadow.
thingNamestringThe name of the IoT device whose shadow information is added to the message.
next?stringThe 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.