Class: Aws::RoboMaker::Types::LaunchConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb

Overview

Note:

When making an API call, you may pass LaunchConfig data as a hash:

{
  package_name: "Command",
  launch_file: "Command",
  environment_variables: {
    "EnvironmentVariableKey" => "EnvironmentVariableValue",
  },
  port_forwarding_config: {
    port_mappings: [
      {
        job_port: 1, # required
        application_port: 1, # required
        enable_on_public_ip: false,
      },
    ],
  },
  stream_ui: false,
  command: ["NonEmptyString"],
}

Information about a launch configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#commandArray<String>

If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.

If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.

Returns:

  • (Array<String>)


3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3798

class LaunchConfig < Struct.new(
  :package_name,
  :launch_file,
  :environment_variables,
  :port_forwarding_config,
  :stream_ui,
  :command)
  SENSITIVE = []
  include Aws::Structure
end

#environment_variablesHash<String,String>

The environment variables for the application launch.

Returns:

  • (Hash<String,String>)


3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3798

class LaunchConfig < Struct.new(
  :package_name,
  :launch_file,
  :environment_variables,
  :port_forwarding_config,
  :stream_ui,
  :command)
  SENSITIVE = []
  include Aws::Structure
end

#launch_fileString

The launch file name.

Returns:

  • (String)


3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3798

class LaunchConfig < Struct.new(
  :package_name,
  :launch_file,
  :environment_variables,
  :port_forwarding_config,
  :stream_ui,
  :command)
  SENSITIVE = []
  include Aws::Structure
end

#package_nameString

The package name.

Returns:

  • (String)


3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3798

class LaunchConfig < Struct.new(
  :package_name,
  :launch_file,
  :environment_variables,
  :port_forwarding_config,
  :stream_ui,
  :command)
  SENSITIVE = []
  include Aws::Structure
end

#port_forwarding_configTypes::PortForwardingConfig

The port forwarding configuration.



3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3798

class LaunchConfig < Struct.new(
  :package_name,
  :launch_file,
  :environment_variables,
  :port_forwarding_config,
  :stream_ui,
  :command)
  SENSITIVE = []
  include Aws::Structure
end

#stream_uiBoolean

Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

Returns:

  • (Boolean)


3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 3798

class LaunchConfig < Struct.new(
  :package_name,
  :launch_file,
  :environment_variables,
  :port_forwarding_config,
  :stream_ui,
  :command)
  SENSITIVE = []
  include Aws::Structure
end