Class: Aws::RoboMaker::Types::SimulationApplicationConfig

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 SimulationApplicationConfig data as a hash:

{
  application: "Arn", # required
  application_version: "Version",
  launch_config: { # required
    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"],
  },
  upload_configurations: [
    {
      name: "Name", # required
      path: "Path", # required
      upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
    },
  ],
  world_configs: [
    {
      world: "Arn",
    },
  ],
  use_default_upload_configurations: false,
  tools: [
    {
      stream_ui: false,
      name: "Name", # required
      command: "UnrestrictedCommand", # required
      stream_output_to_cloud_watch: false,
      exit_behavior: "FAIL", # accepts FAIL, RESTART
    },
  ],
  use_default_tools: false,
}

Information about a simulation application configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#applicationString

The application information for the simulation application.

Returns:

  • (String)


5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 5397

class SimulationApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :world_configs,
  :use_default_upload_configurations,
  :tools,
  :use_default_tools)
  SENSITIVE = []
  include Aws::Structure
end

#application_versionString

The version of the simulation application.

Returns:

  • (String)


5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 5397

class SimulationApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :world_configs,
  :use_default_upload_configurations,
  :tools,
  :use_default_tools)
  SENSITIVE = []
  include Aws::Structure
end

#launch_configTypes::LaunchConfig

The launch configuration for the simulation application.

Returns:



5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 5397

class SimulationApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :world_configs,
  :use_default_upload_configurations,
  :tools,
  :use_default_tools)
  SENSITIVE = []
  include Aws::Structure
end

#toolsArray<Types::Tool>

Information about tools configured for the simulation application.

Returns:



5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 5397

class SimulationApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :world_configs,
  :use_default_upload_configurations,
  :tools,
  :use_default_tools)
  SENSITIVE = []
  include Aws::Structure
end

#upload_configurationsArray<Types::UploadConfiguration>

Information about upload configurations for the simulation application.

Returns:



5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 5397

class SimulationApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :world_configs,
  :use_default_upload_configurations,
  :tools,
  :use_default_tools)
  SENSITIVE = []
  include Aws::Structure
end

#use_default_toolsBoolean

A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

Returns:

  • (Boolean)


5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 5397

class SimulationApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :world_configs,
  :use_default_upload_configurations,
  :tools,
  :use_default_tools)
  SENSITIVE = []
  include Aws::Structure
end

#use_default_upload_configurationsBoolean

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

Returns:

  • (Boolean)


5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 5397

class SimulationApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :world_configs,
  :use_default_upload_configurations,
  :tools,
  :use_default_tools)
  SENSITIVE = []
  include Aws::Structure
end

#world_configsArray<Types::WorldConfig>

A list of world configurations.

Returns:



5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 5397

class SimulationApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :world_configs,
  :use_default_upload_configurations,
  :tools,
  :use_default_tools)
  SENSITIVE = []
  include Aws::Structure
end