robomaker/aws.sdk.kotlin.services.robomaker.model/Tool

Tool

class Tool

Information about a tool. Tools are used in a simulation job.

Types

Builder

class Builder

Companion

object Companion

Properties

command

val command: String

Command-line arguments for the tool. It must include the tool executable name.

exitBehavior

val exitBehavior: ExitBehavior?

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

name

val name: String

The name of the tool.

streamOutputToCloudWatch

val streamOutputToCloudWatch: Boolean?

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

streamUi

val streamUi: Boolean?

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

Functions

copy

inline fun copy(block: Tool.Builder.() -> Unit = {}): Tool

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String