Amazonka.RobOMaker.Types.Tool

Documentation

data Tool

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

See: newTool smart constructor.

Constructors

Tool'

Fields

• exitBehavior :: Maybe 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.

• streamOutputToCloudWatch :: Maybe Bool

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

• streamUI :: Maybe 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 :: Text

  The name of the tool.

• command :: Text

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

Instances

FromJSON Tool

Defined in Amazonka.RobOMaker.Types.Tool

Methods

parseJSON :: Value -> Parser Tool

parseJSONList :: Value -> Parser [Tool]

ToJSON Tool

Defined in Amazonka.RobOMaker.Types.Tool

Methods

toJSON :: Tool -> Value

toEncoding :: Tool -> Encoding

toJSONList :: [Tool] -> Value

toEncodingList :: [Tool] -> Encoding

Generic Tool

Defined in Amazonka.RobOMaker.Types.Tool

Associated Types

type Rep Tool :: Type -> Type

Methods

from :: Tool -> Rep Tool x

to :: Rep Tool x -> Tool

Read Tool

Defined in Amazonka.RobOMaker.Types.Tool

Methods

readsPrec :: Int -> ReadS Tool

readList :: ReadS [Tool]

readPrec :: ReadPrec Tool

readListPrec :: ReadPrec [Tool]

Show Tool

Defined in Amazonka.RobOMaker.Types.Tool

Methods

showsPrec :: Int -> Tool -> ShowS

show :: Tool -> String

showList :: [Tool] -> ShowS

NFData Tool

Defined in Amazonka.RobOMaker.Types.Tool

Methods

rnf :: Tool -> ()

Eq Tool

Defined in Amazonka.RobOMaker.Types.Tool

Methods

(==) :: Tool -> Tool -> Bool

(/=) :: Tool -> Tool -> Bool

Hashable Tool

Defined in Amazonka.RobOMaker.Types.Tool

Methods

hashWithSalt :: Int -> Tool -> Int

hash :: Tool -> Int

type Rep Tool

Defined in Amazonka.RobOMaker.Types.Tool

type Rep Tool = D1 ('MetaData "Tool" "Amazonka.RobOMaker.Types.Tool" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "Tool'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exitBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExitBehavior)) :*: S1 ('MetaSel ('Just "streamOutputToCloudWatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "streamUI") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTool

Arguments

:: Text

$sel:name:Tool'

-> Text

$sel:command:Tool'

-> Tool

Create a value of Tool with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:exitBehavior:Tool', tool_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.

$sel:streamOutputToCloudWatch:Tool', tool_streamOutputToCloudWatch - Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

$sel:streamUI:Tool', tool_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 is False.

$sel:name:Tool', tool_name - The name of the tool.

$sel:command:Tool', tool_command - Command-line arguments for the tool. It must include the tool executable name.

tool_exitBehavior :: Lens' Tool (Maybe 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.

tool_streamOutputToCloudWatch :: Lens' Tool (Maybe Bool)

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

tool_streamUI :: Lens' Tool (Maybe 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.

tool_name :: Lens' Tool Text

The name of the tool.

tool_command :: Lens' Tool Text

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