inputs

Creates, updates, deletes or gets an input resource or lists inputs in a region

Overview

Name	inputs
Type	Resource
Description	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](https://docs.aws.amazon.com/iotevents/latest/developerguide/how-to-use-iotevents.html) in the *AWS IoT Events Developer Guide*.
Id	aws.iotevents.inputs

Fields

Name	Datatype	Description
input_definition	object	The definition of the input.
input_description	string	A brief description of the input.
input_name	string	The name of the input.
tags	array	An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	InputDefinition, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all inputs in a region.

SELECT
region,
input_definition,
input_description,
input_name,
tags
FROM aws.iotevents.inputs
WHERE region = 'us-east-1';

Gets all properties from an individual input.

SELECT
region,
input_definition,
input_description,
input_name,
tags
FROM aws.iotevents.inputs
WHERE region = 'us-east-1' AND data__Identifier = '<InputName>';

INSERT example

Use the following StackQL query and manifest file to create a new input resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.iotevents.inputs (
 InputDefinition,
 region
)
SELECT 
'{{ InputDefinition }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotevents.inputs (
 InputDefinition,
 InputDescription,
 InputName,
 Tags,
 region
)
SELECT 
 '{{ InputDefinition }}',
 '{{ InputDescription }}',
 '{{ InputName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: input
    props:
      - name: InputDefinition
        value:
          Attributes:
            - JsonPath: '{{ JsonPath }}'
      - name: InputDescription
        value: '{{ InputDescription }}'
      - name: InputName
        value: '{{ InputName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotevents.inputs
WHERE data__Identifier = '<InputName>'
AND region = 'us-east-1';

Permissions

To operate on the inputs resource, the following permissions are required:

Create

iotevents:CreateInput,
iotevents:TagResource,
iotevents:DescribeInput,
iotevents:ListTagsForResource

Read

iotevents:DescribeInput,
iotevents:ListTagsForResource

Update

iotevents:UpdateInput,
iotevents:DescribeInput,
iotevents:ListTagsForResource,
iotevents:UntagResource,
iotevents:TagResource

Delete

iotevents:DeleteInput,
iotevents:DescribeInput

List

iotevents:ListInputs