class Aws::RoboMaker::Types::Tool

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

@note When making an API call, you may pass Tool

data as a hash:

    {
      stream_ui: false,
      name: "Name", # required
      command: "UnrestrictedCommand", # required
      stream_output_to_cloud_watch: false,
      exit_behavior: "FAIL", # accepts FAIL, RESTART
    }

@!attribute [rw] stream_ui

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`.
@return [Boolean]

@!attribute [rw] name

The name of the tool.
@return [String]

@!attribute [rw] command

Command-line arguments for the tool. It must include the tool
executable name.
@return [String]

@!attribute [rw] stream_output_to_cloud_watch

Boolean indicating whether logs will be recorded in CloudWatch for
the tool. The default is `False`.
@return [Boolean]

@!attribute [rw] exit_behavior

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`.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/Tool AWS API Documentation

Constants

SENSITIVE