Struct SimulationJobRequest

#[non_exhaustive]
pub struct SimulationJobRequest {
    pub output_location: Option<OutputLocation>,
    pub logging_config: Option<LoggingConfig>,
    pub max_job_duration_in_seconds: i64,
    pub iam_role: Option<String>,
    pub failure_behavior: Option<FailureBehavior>,
    pub use_default_applications: Option<bool>,
    pub robot_applications: Option<Vec<RobotApplicationConfig>>,
    pub simulation_applications: Option<Vec<SimulationApplicationConfig>>,
    pub data_sources: Option<Vec<DataSourceConfig>>,
    pub vpc_config: Option<VpcConfig>,
    pub compute: Option<Compute>,
    pub tags: Option<HashMap<String, String>>,
}

Information about a simulation job request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

output_location: Option<OutputLocation>

The output location.

logging_config: Option<LoggingConfig>

The logging configuration.

max_job_duration_in_seconds: i64

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

iam_role: Option<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.

failure_behavior: Option<FailureBehavior>

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.

use_default_applications: Option<bool>

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

robot_applications: Option<Vec<RobotApplicationConfig>>

The robot applications to use in the simulation job.

simulation_applications: Option<Vec<SimulationApplicationConfig>>

The simulation applications to use in the simulation job.

data_sources: Option<Vec<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.

vpc_config: Option<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.

compute: Option<Compute>

Compute information for the simulation job

tags: Option<HashMap<String, String>>

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

Implementations

impl SimulationJobRequest

pub fn output_location(&self) -> Option<&OutputLocation>

The output location.

pub fn logging_config(&self) -> Option<&LoggingConfig>

The logging configuration.

pub fn max_job_duration_in_seconds(&self) -> i64

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

pub fn iam_role(&self) -> Option<&str>

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.

pub fn failure_behavior(&self) -> Option<&FailureBehavior>

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.

pub fn use_default_applications(&self) -> Option<bool>

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

pub fn robot_applications(&self) -> &[RobotApplicationConfig]

The robot applications to use in the simulation job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .robot_applications.is_none().

pub fn simulation_applications(&self) -> &[SimulationApplicationConfig]

The simulation applications to use in the simulation job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .simulation_applications.is_none().

pub fn data_sources(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .data_sources.is_none().

pub fn vpc_config(&self) -> Option<&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.

pub fn compute(&self) -> Option<&Compute>

Compute information for the simulation job

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

impl SimulationJobRequest

pub fn builder() -> SimulationJobRequestBuilder

Creates a new builder-style object to manufacture SimulationJobRequest.

Trait Implementations

impl Clone for SimulationJobRequest

fn clone(&self) -> SimulationJobRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SimulationJobRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SimulationJobRequest

fn eq(&self, other: &SimulationJobRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SimulationJobRequest