CfnTaskProps

class aws_cdk.aws_iotsitewise.CfnTaskProps(*, task_configuration, task_name, workspace_name, description=None, tags=None)

Bases: object

Properties for defining a CfnTask.

Parameters:
  • task_configuration (Union[IResolvable, TaskConfigurationProperty, Dict[str, Any]]) – The task execution configuration.

  • task_name (str) – The name of the task. Must be unique within the workspace.

  • workspace_name (str) – The name of the workspace.

  • description (Optional[str]) – A description of the task.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotsitewise as iotsitewise

cfn_task_props = iotsitewise.CfnTaskProps(
    task_configuration=iotsitewise.CfnTask.TaskConfigurationProperty(
        container_task_configuration=iotsitewise.CfnTask.ContainerTaskConfigurationProperty(
            ecr_uri="ecrUri",
            processing_type="processingType",
            processing_unit="processingUnit",
            task_execution_role="taskExecutionRole",

            # the properties below are optional
            command=["command"],
            environment_variables={
                "environment_variables_key": "environmentVariables"
            },
            timeout_seconds=123
        )
    ),
    task_name="taskName",
    workspace_name="workspaceName",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description of the task.

See:

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

tags

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

See:

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

task_configuration

The task execution configuration.

See:

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

task_name

The name of the task.

Must be unique within the workspace.

See:

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

workspace_name

The name of the workspace.

See:

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