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

Inherits:

Struct

• Object
• Struct
• Aws::RoboMaker::Types::SimulationJobRequest

Includes:

Structure

Defined in:

lib/aws-sdk-robomaker/types.rb

Overview

Information about a simulation job request.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #compute ⇒ Types::Compute

  Compute information for the simulation job.

• #data_sources ⇒ Array<Types::DataSourceConfig>

  Specify data sources to mount read-only files from S3 into your simulation.

• #failure_behavior ⇒ String

  The failure behavior the simulation job.

• #iam_role ⇒ String

  The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

• #logging_config ⇒ Types::LoggingConfig

  The logging configuration.

• #max_job_duration_in_seconds ⇒ Integer

  The maximum simulation job duration in seconds.

• #output_location ⇒ Types::OutputLocation

  The output location.

• #robot_applications ⇒ Array<Types::RobotApplicationConfig>

  The robot applications to use in the simulation job.

• #simulation_applications ⇒ Array<Types::SimulationApplicationConfig>

  The simulation applications to use in the simulation job.

• #tags ⇒ Hash<String,String>

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

• #use_default_applications ⇒ Boolean

  A Boolean indicating whether to use default applications in the simulation job.

• #vpc_config ⇒ Types::VPCConfig

  If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs.

Instance Attribute Details

#compute ⇒ Types::Compute

Compute information for the simulation job

Returns:

• (Types::Compute)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_sources ⇒ Array<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:

• (Array<Types::DataSourceConfig>)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_behavior ⇒ String

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)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_role ⇒ String

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)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_config ⇒ Types::LoggingConfig

The logging configuration.

Returns:

• (Types::LoggingConfig)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_location ⇒ Types::OutputLocation

The output location.

Returns:

• (Types::OutputLocation)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_applications ⇒ Array<Types::RobotApplicationConfig>

The robot applications to use in the simulation job.

Returns:

• (Array<Types::RobotApplicationConfig>)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_applications ⇒ Array<Types::SimulationApplicationConfig>

The simulation applications to use in the simulation job.

Returns:

• (Array<Types::SimulationApplicationConfig>)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_applications ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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_config ⇒ Types::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:

• (Types::VPCConfig)

# File 'lib/aws-sdk-robomaker/types.rb', line 4822

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