Class: Aws::RoboMaker::Types::SimulationJobRequest

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

Overview

Information about a simulation job request.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#computeTypes::Compute

Compute information for the simulation job

Returns:



4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#data_sourcesArray<Types::DataSourceConfig>

Specify data sources to mount read-only files from S3 into your simulation. These files are available under ‘/opt/robomaker/datasources/data_source_name`.

<note markdown=“1”> There is a limit of 100 files and a combined size of 25GB for all ‘DataSourceConfig` objects.

</note>

Returns:



4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#failure_behaviorString

The failure behavior the simulation job.

Continue

: Leaves the host running for its maximum timeout duration after a

`4XX` error code.

Fail

: Stop the simulation job and terminate the instance.

Returns:

  • (String)


4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#iam_roleString

The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

Returns:

  • (String)


4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#logging_configTypes::LoggingConfig

The logging configuration.



4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_job_duration_in_secondsInteger

The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

Returns:

  • (Integer)


4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_locationTypes::OutputLocation

The output location.



4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#robot_applicationsArray<Types::RobotApplicationConfig>

The robot applications to use in the simulation job.

Returns:



4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#simulation_applicationsArray<Types::SimulationApplicationConfig>

The simulation applications to use in the simulation job.



4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A map that contains tag keys and tag values that are attached to the simulation job request.

Returns:

  • (Hash<String,String>)


4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#use_default_applicationsBoolean

A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.

Returns:

  • (Boolean)


4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::VPCConfig

If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.

Returns:



4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
# File 'lib/aws-sdk-robomaker/types.rb', line 4823

class SimulationJobRequest < Struct.new(
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :use_default_applications,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :vpc_config,
  :compute,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end