Class: Aws::RoboMaker::Types::Tool

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb

Overview

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
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#commandString

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

Returns:

  • (String)


6606
6607
6608
6609
6610
6611
6612
6613
6614
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6606

class Tool < Struct.new(
  :stream_ui,
  :name,
  :command,
  :stream_output_to_cloud_watch,
  :exit_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#exit_behaviorString

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.

Returns:

  • (String)


6606
6607
6608
6609
6610
6611
6612
6613
6614
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6606

class Tool < Struct.new(
  :stream_ui,
  :name,
  :command,
  :stream_output_to_cloud_watch,
  :exit_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the tool.

Returns:

  • (String)


6606
6607
6608
6609
6610
6611
6612
6613
6614
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6606

class Tool < Struct.new(
  :stream_ui,
  :name,
  :command,
  :stream_output_to_cloud_watch,
  :exit_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#stream_output_to_cloud_watchBoolean

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

Returns:

  • (Boolean)


6606
6607
6608
6609
6610
6611
6612
6613
6614
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6606

class Tool < Struct.new(
  :stream_ui,
  :name,
  :command,
  :stream_output_to_cloud_watch,
  :exit_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#stream_uiBoolean

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.

Returns:

  • (Boolean)


6606
6607
6608
6609
6610
6611
6612
6613
6614
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 6606

class Tool < Struct.new(
  :stream_ui,
  :name,
  :command,
  :stream_output_to_cloud_watch,
  :exit_behavior)
  SENSITIVE = []
  include Aws::Structure
end