Interface Tool.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Tool.Builder,
,Tool> SdkBuilder<Tool.Builder,
,Tool> SdkPojo
- Enclosing class:
Tool
-
Method Summary
Modifier and TypeMethodDescriptionCommand-line arguments for the tool.exitBehavior
(String exitBehavior) Exit behavior determines what happens when your tool quits running.exitBehavior
(ExitBehavior exitBehavior) Exit behavior determines what happens when your tool quits running.The name of the tool.streamOutputToCloudWatch
(Boolean streamOutputToCloudWatch) Boolean indicating whether logs will be recorded in CloudWatch for the tool.Boolean indicating whether a streaming session will be configured for the tool.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
.- Parameters:
streamUI
- Boolean indicating whether a streaming session will be configured for the tool. IfTrue
, 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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the tool.
- Parameters:
name
- The name of the tool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
command
Command-line arguments for the tool. It must include the tool executable name.
- Parameters:
command
- Command-line arguments for the tool. It must include the tool executable name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
streamOutputToCloudWatch
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is
False
.- Parameters:
streamOutputToCloudWatch
- Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default isFalse
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-