CfnTaskPropsMixin

class aws_cdk.cfn_property_mixins.aws_iotsitewise.CfnTaskPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-task.html
CloudformationResource:: AWS::IoTSiteWise::Task
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_task_props_mixin = iotsitewise.CfnTaskPropsMixin(iotsitewise.CfnTaskMixinProps(
    description="description",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    task_configuration=iotsitewise.CfnTaskPropsMixin.TaskConfigurationProperty(
        container_task_configuration=iotsitewise.CfnTaskPropsMixin.ContainerTaskConfigurationProperty(
            command=["command"],
            ecr_uri="ecrUri",
            environment_variables={
                "environment_variables_key": "environmentVariables"
            },
            processing_type="processingType",
            processing_unit="processingUnit",
            task_execution_role="taskExecutionRole",
            timeout_seconds=123
        )
    ),
    task_name="taskName",
    workspace_name="workspaceName"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::IoTSiteWise::Task.

Parameters:

props (Union[CfnTaskMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'tags', 'taskConfiguration', 'taskName', 'workspaceName']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ContainerTaskConfigurationProperty

class CfnTaskPropsMixin.ContainerTaskConfigurationProperty(*, command=None, ecr_uri=None, environment_variables=None, processing_type=None, processing_unit=None, task_execution_role=None, timeout_seconds=None)

Bases: object

Configuration for running a custom container image on managed compute.

Parameters:

command (Optional[Sequence[str]]) – The command to execute in the container.
ecr_uri (Optional[str]) – The Amazon ECR image URI for the task container.
environment_variables (Union[IResolvable, Mapping[str, str], None]) – A map of environment variable key-value pairs.
processing_type (Optional[str]) – The processing type for compute resources.
processing_unit (Optional[str]) – The processing unit allocation that determines vCPU, memory, and GPU resources.
task_execution_role (Optional[str]) – The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
timeout_seconds (Union[int, float, None]) – The timeout in seconds for task execution. Default: 3600 (1 hour).

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

container_task_configuration_property = iotsitewise.CfnTaskPropsMixin.ContainerTaskConfigurationProperty(
    command=["command"],
    ecr_uri="ecrUri",
    environment_variables={
        "environment_variables_key": "environmentVariables"
    },
    processing_type="processingType",
    processing_unit="processingUnit",
    task_execution_role="taskExecutionRole",
    timeout_seconds=123
)

Attributes

command

The command to execute in the container.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-containertaskconfiguration.html#cfn-iotsitewise-task-containertaskconfiguration-command

ecr_uri

The Amazon ECR image URI for the task container.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-containertaskconfiguration.html#cfn-iotsitewise-task-containertaskconfiguration-ecruri

environment_variables

A map of environment variable key-value pairs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-containertaskconfiguration.html#cfn-iotsitewise-task-containertaskconfiguration-environmentvariables

processing_type

The processing type for compute resources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-containertaskconfiguration.html#cfn-iotsitewise-task-containertaskconfiguration-processingtype

processing_unit

The processing unit allocation that determines vCPU, memory, and GPU resources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-containertaskconfiguration.html#cfn-iotsitewise-task-containertaskconfiguration-processingunit

task_execution_role

The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-containertaskconfiguration.html#cfn-iotsitewise-task-containertaskconfiguration-taskexecutionrole

timeout_seconds

The timeout in seconds for task execution.

Default: 3600 (1 hour).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-containertaskconfiguration.html#cfn-iotsitewise-task-containertaskconfiguration-timeoutseconds

TaskConfigurationProperty

class CfnTaskPropsMixin.TaskConfigurationProperty(*, container_task_configuration=None)

Bases: object

The task execution configuration.

Parameters:: container_task_configuration (Union[IResolvable, ContainerTaskConfigurationProperty, Dict[str, Any], None]) – Configuration for running a custom container image on managed compute.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-task-taskconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

task_configuration_property = iotsitewise.CfnTaskPropsMixin.TaskConfigurationProperty(
    container_task_configuration=iotsitewise.CfnTaskPropsMixin.ContainerTaskConfigurationProperty(
        command=["command"],
        ecr_uri="ecrUri",
        environment_variables={
            "environment_variables_key": "environmentVariables"
        },
        processing_type="processingType",
        processing_unit="processingUnit",
        task_execution_role="taskExecutionRole",
        timeout_seconds=123
    )
)

Attributes

container_task_configuration

Configuration for running a custom container image on managed compute.

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