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	awscc.iotanalytics.pipelines

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
pipeline_name	string
region	string	AWS region.

For more information, see AWS::IoTAnalytics::Pipeline.

Methods

Name	Resource	Accessible by	Required Params
create_resource	pipelines	INSERT	PipelineActivities, region
delete_resource	pipelines	DELETE	Identifier, region
update_resource	pipelines	UPDATE	Identifier, PatchDocument, region
list_resources	pipelines_list_only	SELECT	region
get_resource	pipelines	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual pipeline.

SELECT
  region,
  id,
  pipeline_name,
  tags,
  pipeline_activities
FROM awscc.iotanalytics.pipelines
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ pipeline_name }}';

list (identifiers only)

Lists all pipelines in a region.

SELECT
  region,
  pipeline_name
FROM awscc.iotanalytics.pipelines_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: pipeline
    props:
      - name: pipeline_name
        value: '{{ pipeline_name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: pipeline_activities
        value:
          - select_attributes:
              next: '{{ next }}'
              attributes:
                - '{{ attributes[0] }}'
              name: '{{ name }}'
            datastore:
              datastore_name: '{{ datastore_name }}'
              name: '{{ name }}'
            filter:
              filter: '{{ filter }}'
              next: '{{ next }}'
              name: '{{ name }}'
            add_attributes:
              next: '{{ next }}'
              attributes: {}
              name: '{{ name }}'
            channel:
              channel_name: '{{ channel_name }}'
              next: '{{ next }}'
              name: '{{ name }}'
            device_shadow_enrich:
              attribute: '{{ attribute }}'
              next: '{{ next }}'
              thing_name: '{{ thing_name }}'
              role_arn: '{{ role_arn }}'
              name: '{{ name }}'
            math:
              attribute: '{{ attribute }}'
              next: '{{ next }}'
              math: '{{ math }}'
              name: '{{ name }}'
            lambda:
              batch_size: '{{ batch_size }}'
              next: '{{ next }}'
              lambda_name: '{{ lambda_name }}'
              name: '{{ name }}'
            device_registry_enrich:
              attribute: '{{ attribute }}'
              next: '{{ next }}'
              thing_name: '{{ thing_name }}'
              role_arn: '{{ role_arn }}'
              name: '{{ name }}'
            remove_attributes:
              next: '{{ next }}'
              attributes:
                - '{{ attributes[0] }}'
              name: '{{ name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iotanalytics.pipelines
SET PatchDocument = string('{{ {
    "Tags": tags,
    "PipelineActivities": pipeline_activities
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ pipeline_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iotanalytics.pipelines
WHERE
  Identifier = '{{ pipeline_name }}' 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