Class: Aws::RoboMaker::Types::RobotApplicationConfig

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

{
  application: "Arn", # required
  application_version: "Version",
  launch_config: { # required
    package_name: "Command", # required
    launch_file: "Command", # required
    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,
  },
  upload_configurations: [
    {
      name: "Name", # required
      path: "Path", # required
      upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
    },
  ],
  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,
}

Application configuration information for a robot.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#applicationString

The application information for the robot application.

Returns:

  • (String)


4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4893

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

#application_versionString

The version of the robot application.

Returns:

  • (String)


4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4893

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

#launch_configTypes::LaunchConfig

The launch configuration for the robot application.

Returns:



4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4893

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

#toolsArray<Types::Tool>

Information about tools configured for the robot application.

Returns:



4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4893

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

#upload_configurationsArray<Types::UploadConfiguration>

The upload configurations for the robot application.

Returns:



4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4893

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

#use_default_toolsBoolean

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

Returns:

  • (Boolean)


4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4893

class RobotApplicationConfig < Struct.new(
  :application,
  :application_version,
  :launch_config,
  :upload_configurations,
  :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.

Returns:

  • (Boolean)


4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 4893

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