AWS::IoTEvents::Input

The AWS::IoTEvents::Input resource creates an input. To monitor your devices and processes, they must have a way to get telemetry data into AWS IoT Events. This is done by sending messages as inputs to AWS IoT Events. For more information, see How to Use AWS IoT Events in the AWS IoT Events Developer Guide.

Syntax

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

JSON

{
  "Type" : "AWS::IoTEvents::Input",
  "Properties" : {
      "InputDefinition" : InputDefinition,
      "InputDescription" : String,
      "InputName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::IoTEvents::Input
Properties:
  InputDefinition: 
    InputDefinition
  InputDescription: String
  InputName: String
  Tags: 
    - Tag

Properties

InputDefinition

The definition of the input.

Required: Yes

Type: InputDefinition

Update requires: No interruption

InputDescription

A brief description of the input.

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

InputName

The name of the input.

Required: No

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

Minimum: 1

Maximum: 128

Update requires: Replacement

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the input. For example:

{"Ref": "myInput"}

For the AWS IoT Events input myInput, Ref returns the name of the input.

For more information about using the Ref function, see Ref.

Examples

Input

The following example creates an input.

JSON

{
  "Description": "Input Template for CloudFormation",
  "Resources": {
    "myInput": {
      "Type": "AWS::IoTEvents::Input",
      "Properties": {
        "InputName": "myInput",
        "InputDescription": "My Input created by CloudFormation",
        "InputDefinition": {
          "Attributes": [
            {
              "JsonPath": "foo"
            },
            {
              "JsonPath": "bar"
            }
          ]
        }
      }
    }
  }
} 

YAML

---
Description: "Input Template for CloudFormation"
Resources:
  myInput:
    Type: "AWS::IoTEvents::Input"
    Properties:
      InputName: "myInput"
      InputDescription: "My Input created by CloudFormation"
      InputDefinition:
        Attributes:
          -
            JsonPath: "foo"
          -
            JsonPath: "bar"
         

See also

• How to Use AWS IoT Events in the AWS IoT Events Developer Guide

• CreateInput in the AWS IoT Events API Reference