AWS::IoTAnalytics::Pipeline DeviceShadowEnrich - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::IoTAnalytics::Pipeline DeviceShadowEnrich

An activity that adds information from the Amazon IoT Device Shadows service to a message.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Attribute" : String,
  "Name" : String,
  "Next" : String,
  "RoleArn" : String,
  "ThingName" : String
}

YAML

  Attribute: String
  Name: String
  Next: String
  RoleArn: String
  ThingName: String

Properties

Attribute

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

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

Name

The name of the 'deviceShadowEnrich' activity.

Required: Yes

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

Next

The next activity in the pipeline.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

RoleArn

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

Required: Yes

Type: String

Minimum: 20

Maximum: 2048

Update requires: No interruption

ThingName

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

Required: Yes

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption