libZSservicesZSamazonka-robomakerZSamazonka-robomaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RobOMaker.Types.Tool

Description

 
Synopsis

Documentation

data Tool Source #

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

See: newTool smart constructor.

Constructors

Tool' 

Fields

  • streamOutputToCloudWatch :: Maybe Bool

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

  • 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.

  • 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

Instances details
Eq Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

Methods

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

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

Read Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

Show Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

Methods

showsPrec :: Int -> Tool -> ShowS #

show :: Tool -> String #

showList :: [Tool] -> ShowS #

Generic Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

Associated Types

type Rep Tool :: Type -> Type #

Methods

from :: Tool -> Rep Tool x #

to :: Rep Tool x -> Tool #

NFData Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

Methods

rnf :: Tool -> () #

Hashable Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

Methods

hashWithSalt :: Int -> Tool -> Int #

hash :: Tool -> Int #

ToJSON Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

FromJSON Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

type Rep Tool Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.Tool

type Rep Tool = D1 ('MetaData "Tool" "Amazonka.RobOMaker.Types.Tool" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "Tool'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "streamOutputToCloudWatch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "exitBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExitBehavior))) :*: (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 Source #

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:streamOutputToCloudWatch:Tool', tool_streamOutputToCloudWatch - Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

$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: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_streamOutputToCloudWatch :: Lens' Tool (Maybe Bool) Source #

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

tool_exitBehavior :: Lens' Tool (Maybe ExitBehavior) Source #

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_streamUI :: Lens' Tool (Maybe Bool) Source #

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 Source #

The name of the tool.

tool_command :: Lens' Tool Text Source #

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