Tool
Information about a tool. Tools are used in a simulation job.
Contents
- command
-
Command-line arguments for the tool. It must include the tool executable name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*
Required: Yes
- name
-
The name of the tool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_\-]*
Required: Yes
- 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 isRESTART
.Type: String
Valid Values:
FAIL | RESTART
Required: No
- streamOutputToCloudWatch
-
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is
False
.Type: Boolean
Required: No
- streamUI
-
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 isFalse
.Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: