interface CfnTaskProps

Language	Type name
.NET	Amazon.CDK.AWS.IoTSiteWise.CfnTaskProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnTaskProps
Java	software.amazon.awscdk.services.iotsitewise.CfnTaskProps
Python	aws_cdk.aws_iotsitewise.CfnTaskProps
TypeScript	aws-cdk-lib » aws_iotsitewise » CfnTaskProps

Properties for defining a CfnTask.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-task.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const cfnTaskProps: iotsitewise.CfnTaskProps = {
  taskConfiguration: {
    containerTaskConfiguration: {
      ecrUri: 'ecrUri',
      processingType: 'processingType',
      processingUnit: 'processingUnit',
      taskExecutionRole: 'taskExecutionRole',

      // the properties below are optional
      command: ['command'],
      environmentVariables: {
        environmentVariablesKey: 'environmentVariables',
      },
      timeoutSeconds: 123,
    },
  },
  taskName: 'taskName',
  workspaceName: 'workspaceName',

  // the properties below are optional
  description: 'description',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
taskConfiguration	IResolvable | TaskConfigurationProperty	The task execution configuration.
taskName	string	The name of the task.
workspaceName	string	The name of the workspace.
description?	string	A description of the task.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

taskConfiguration

Type: IResolvable | TaskConfigurationProperty

The task execution configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-task.html#cfn-iotsitewise-task-taskconfiguration

---

taskName

Type: string

The name of the task.

Must be unique within the workspace.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-task.html#cfn-iotsitewise-task-taskname

---

workspaceName

Type: string

The name of the workspace.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-task.html#cfn-iotsitewise-task-workspacename

---

description?

Type: string (optional)

A description of the task.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-task.html#cfn-iotsitewise-task-description

---

tags?

Type: CfnTag[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-task.html#cfn-iotsitewise-task-tags