Package software.amazon.awscdk.services.iotsitewise

Interface CfnTask.ContainerTaskConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTask.ContainerTaskConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnTask

@Stability(Stable)
public static interface CfnTask.ContainerTaskConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for running a custom container image on managed compute.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 ContainerTaskConfigurationProperty containerTaskConfigurationProperty = ContainerTaskConfigurationProperty.builder()
         .ecrUri("ecrUri")
         .processingType("processingType")
         .processingUnit("processingUnit")
         .taskExecutionRole("taskExecutionRole")
         // the properties below are optional
         .command(List.of("command"))
         .environmentVariables(Map.of(
                 "environmentVariablesKey", "environmentVariables"))
         .timeoutSeconds(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTask.ContainerTaskConfigurationProperty.Builder	A builder for CfnTask.ContainerTaskConfigurationProperty
static final class	CfnTask.ContainerTaskConfigurationProperty.Jsii$Proxy	An implementation for CfnTask.ContainerTaskConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTask.ContainerTaskConfigurationProperty.Builder	builder()
default List<String>	getCommand()	The command to execute in the container.
String	getEcrUri()	The Amazon ECR image URI for the task container.
default Object	getEnvironmentVariables()	A map of environment variable key-value pairs.
String	getProcessingType()	The processing type for compute resources.
String	getProcessingUnit()	The processing unit allocation that determines vCPU, memory, and GPU resources.
String	getTaskExecutionRole()	The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.
default Number	getTimeoutSeconds()	The timeout in seconds for task execution.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEcrUri

@Stability(Stable)
@NotNull
String getEcrUri()

The Amazon ECR image URI for the task container.

See Also:

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

getProcessingType

@Stability(Stable)
@NotNull
String getProcessingType()

The processing type for compute resources.

See Also:

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

getProcessingUnit

@Stability(Stable)
@NotNull
String getProcessingUnit()

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

See Also:

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

getTaskExecutionRole

@Stability(Stable)
@NotNull
String getTaskExecutionRole()

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

See Also:

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

getCommand

@Stability(Stable)
@Nullable
default List<String> getCommand()

The command to execute in the container.

See Also:

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

getEnvironmentVariables

@Stability(Stable)
@Nullable
default Object getEnvironmentVariables()

A map of environment variable key-value pairs.

Returns union: either IResolvable or Mapinvalid input: '<'String, String>

See Also:

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

getTimeoutSeconds

@Stability(Stable)
@Nullable
default Number getTimeoutSeconds()

The timeout in seconds for task execution.

Default: 3600 (1 hour).

See Also:

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

builder

@Stability(Stable)
static CfnTask.ContainerTaskConfigurationProperty.Builder builder()

Returns:

a CfnTask.ContainerTaskConfigurationProperty.Builder of CfnTask.ContainerTaskConfigurationProperty