Struct aws_sdk_robomaker::types::Tool

#[non_exhaustive]
pub struct Tool {
    pub stream_ui: Option<bool>,
    pub name: String,
    pub command: String,
    pub stream_output_to_cloud_watch: Option<bool>,
    pub exit_behavior: Option<ExitBehavior>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stream_ui: Option<bool>

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.

name: String

The name of the tool.

command: String

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

stream_output_to_cloud_watch: Option<bool>

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

exit_behavior: Option<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 is RESTART.

Implementations

impl Tool

pub fn stream_ui(&self) -> Option<bool>

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.

pub fn name(&self) -> &str

The name of the tool.

pub fn command(&self) -> &str

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

pub fn stream_output_to_cloud_watch(&self) -> Option<bool>

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

pub fn exit_behavior(&self) -> Option<&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 is RESTART.

impl Tool

pub fn builder() -> ToolBuilder

Creates a new builder-style object to manufacture Tool.

Trait Implementations

impl Clone for Tool

fn clone(&self) -> Tool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Tool

fn eq(&self, other: &Tool) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Tool