You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SimulationJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  output_location: {
    s3_bucket: "S3Bucket",
    s3_prefix: "S3Key",
  },
  logging_config: {
    record_all_ros_topics: false, # required
  },
  max_job_duration_in_seconds: 1, # required
  iam_role: "IamRole",
  failure_behavior: "Fail", # accepts Fail, Continue
  use_default_applications: false,
  robot_applications: [
    {
      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,
      },
    },
  ],
  simulation_applications: [
    {
      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,
      },
      world_configs: [
        {
          world: "Arn",
        },
      ],
    },
  ],
  data_sources: [
    {
      name: "Name", # required
      s3_bucket: "S3Bucket", # required
      s3_keys: ["S3Key"], # required
    },
  ],
  vpc_config: {
    subnets: ["NonEmptyString"], # required
    security_groups: ["NonEmptyString"],
    assign_public_ip: false,
  },
  compute: {
    simulation_unit_limit: 1,
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Information about a simulation job request.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#compute ⇒ Types::Compute

Compute information for the simulation job

Returns:

#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.

There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

Returns:

#failure_behavior ⇒ String

The failure behavior the simulation job.

Continue

Restart the simulation job in the same host instance.

Fail

Stop the simulation job and terminate the instance.

Possible values:

  • Fail
  • Continue

Returns:

  • (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. This is how credentials are passed in to your simulation job.

Returns:

  • (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.

Returns:

#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) —

    The maximum simulation job duration in seconds.

#output_location ⇒ Types::OutputLocation

The output location.

Returns:

#robot_applications ⇒ Array<Types::RobotApplicationConfig>

The robot applications to use in the simulation job.

Returns:

#simulation_applications ⇒ Array<Types::SimulationApplicationConfig>

The simulation applications to use in the simulation job.

Returns:

#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>) —

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

#use_default_applications ⇒ Boolean

Boolean indicating whether to use default simulation tool applications.

Returns:

  • (Boolean) —

    Boolean indicating whether to use default simulation tool applications.

#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) —

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