AWS::IoTSiteWise::Task

IoTSiteWise Task

Resource schema for AWS::IoTSiteWise::Task. A task defines a reusable containerized compute workload that can be referenced by one or more pipeline compute nodes.

Properties

5 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
TaskConfiguration
TaskConfiguration
Required
TaskName
string
RequiredCreate-only
WorkspaceName
string
RequiredCreate-only
Description
string
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
StatusstringThe current lifecycle status of the task.
TaskArnstringThe ARN of the task.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::IoTSiteWise::Task

Resources:
  MyResource:
    Type: AWS::IoTSiteWise::Task
    Properties:
      WorkspaceName: "my-workspacename"
      TaskName: "my-taskname"
      TaskConfiguration: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iotsitewise:CreateTaskiotsitewise:DescribeTaskiotsitewise:TagResourceiotsitewise:ListTagsForResourceiam:PassRole

read

iotsitewise:DescribeTaskiotsitewise:ListTagsForResource

update

iotsitewise:UpdateTaskiotsitewise:DescribeTaskiotsitewise:TagResourceiotsitewise:UntagResourceiotsitewise:ListTagsForResourceiam:PassRole

delete

iotsitewise:DeleteTaskiotsitewise:DescribeTaskiotsitewise:ListTagsForResource

list

iotsitewise:ListTasks

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceIoTSiteWise
Properties7
Required3
TaggingSupported
Primary IDTaskArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

WorkspaceNameTaskName

External Links