pipelines

Creates, updates, deletes or gets a pipeline resource or lists pipelines in a region

Overview

Name	pipelines
Type	Resource
Description	Resource Type definition for AWS::IoTAnalytics::Pipeline
Id	aws.iotanalytics.pipelines

Fields

Name	Datatype	Description
id	string
pipeline_name	string
tags	array
pipeline_activities	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	PipelineActivities, 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 pipelines in a region.

SELECT
region,
id,
pipeline_name,
tags,
pipeline_activities
FROM aws.iotanalytics.pipelines
WHERE region = 'us-east-1';

Gets all properties from an individual pipeline.

SELECT
region,
id,
pipeline_name,
tags,
pipeline_activities
FROM aws.iotanalytics.pipelines
WHERE region = 'us-east-1' AND data__Identifier = '<PipelineName>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.iotanalytics.pipelines (
 PipelineActivities,
 region
)
SELECT 
'{{ PipelineActivities }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.iotanalytics.pipelines (
 PipelineName,
 Tags,
 PipelineActivities,
 region
)
SELECT 
 '{{ PipelineName }}',
 '{{ Tags }}',
 '{{ PipelineActivities }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: pipeline
    props:
      - name: PipelineName
        value: '{{ PipelineName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: PipelineActivities
        value:
          - SelectAttributes:
              Next: '{{ Next }}'
              Attributes:
                - '{{ Attributes[0] }}'
              Name: '{{ Name }}'
            Datastore:
              DatastoreName: '{{ DatastoreName }}'
              Name: '{{ Name }}'
            Filter:
              Filter: '{{ Filter }}'
              Next: '{{ Next }}'
              Name: '{{ Name }}'
            AddAttributes:
              Next: '{{ Next }}'
              Attributes: {}
              Name: '{{ Name }}'
            Channel:
              ChannelName: '{{ ChannelName }}'
              Next: '{{ Next }}'
              Name: '{{ Name }}'
            DeviceShadowEnrich:
              Attribute: '{{ Attribute }}'
              Next: '{{ Next }}'
              ThingName: '{{ ThingName }}'
              RoleArn: '{{ RoleArn }}'
              Name: '{{ Name }}'
            Math:
              Attribute: '{{ Attribute }}'
              Next: '{{ Next }}'
              Math: '{{ Math }}'
              Name: '{{ Name }}'
            Lambda:
              BatchSize: '{{ BatchSize }}'
              Next: '{{ Next }}'
              LambdaName: '{{ LambdaName }}'
              Name: '{{ Name }}'
            DeviceRegistryEnrich:
              Attribute: '{{ Attribute }}'
              Next: '{{ Next }}'
              ThingName: '{{ ThingName }}'
              RoleArn: '{{ RoleArn }}'
              Name: '{{ Name }}'
            RemoveAttributes:
              Next: '{{ Next }}'
              Attributes:
                - '{{ Attributes[0] }}'
              Name: '{{ Name }}'

DELETE example

/*+ delete */
DELETE FROM aws.iotanalytics.pipelines
WHERE data__Identifier = '<PipelineName>'
AND region = 'us-east-1';

Permissions

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

Create

iotanalytics:CreatePipeline

Read

iotanalytics:DescribePipeline,
iotanalytics:ListTagsForResource

Update

iotanalytics:UpdatePipeline,
iotanalytics:TagResource,
iotanalytics:UntagResource

Delete

iotanalytics:DeletePipeline

List

iotanalytics:ListPipelines