aws-cdk-lib.aws_iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty

DeviceRegistryEnrichProperty Struct

An activity that adds data from the AWS IoT device registry to your message.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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 deviceRegistryEnrichProperty: iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty = {
  attribute: 'attribute',
  name: 'name',
  roleArn: 'roleArn',
  thingName: 'thingName',

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

Properties

attributestringattributestrattributeStringAttributestringAttribute*stringrequired#

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

namestringnamestrnameStringNamestringName*stringrequired#

The name of the 'deviceRegistryEnrich' activity.

next?optionalstringnext?optionalstrnext?optionalStringNext?optionalstringNext?optional*string#

The next activity in the pipeline.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#

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

thingNamestringthing_namestrthingNameStringThingNamestringThingName*stringrequired#

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