Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Tool

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

Hierarchy

  • Tool

Index

Properties

command

command: string | undefined

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

Optional exitBehavior

exitBehavior: ExitBehavior | string

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

name: string | undefined

The name of the tool.

Optional streamOutputToCloudWatch

streamOutputToCloudWatch: undefined | false | true

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

Optional streamUI

streamUI: undefined | false | true

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.