aws-cdk-lib.aws_iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty

interface DeviceRegistryEnrichProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTAnalytics.CfnPipeline.DeviceRegistryEnrichProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotanalytics#CfnPipeline_DeviceRegistryEnrichProperty
Javasoftware.amazon.awscdk.services.iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty
Pythonaws_cdk.aws_iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty
TypeScript aws-cdk-lib » aws_iotanalytics » CfnPipeline » DeviceRegistryEnrichProperty

An activity that adds data from the AWS IoT device registry to your 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 deviceRegistryEnrichProperty: iotanalytics.CfnPipeline.DeviceRegistryEnrichProperty = {
  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 'deviceRegistryEnrich' activity.
roleArnstringThe ARN of the role that allows access to the device's registry information.
thingNamestringThe name of the IoT device whose registry 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 'deviceRegistryEnrich' activity.


roleArn

Type: string

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


thingName

Type: string

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


next?

Type: string (optional)

The next activity in the pipeline.