Class: Aws::RoboMaker::Types::CreateSimulationJobRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String)


961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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

#computeTypes::Compute

Compute information for the simulation job.

Returns:



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

class CreateSimulationJobRequest < Struct.new(
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :compute)
  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:



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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

#failure_behaviorString

The failure behavior the simulation job.

Continue

: Leaves the instance running for its maximum timeout duration after

a `4XX` error code.

Fail

: Stop the simulation job and terminate the instance.

Returns:

  • (String)


961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

class CreateSimulationJobRequest < Struct.new(
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :compute)
  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)


961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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

#logging_configTypes::LoggingConfig

The logging configuration.



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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

#max_job_duration_in_secondsInteger

The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When ‘maxJobDurationInSeconds` is reached, the simulation job will status will transition to `Completed`.

Returns:

  • (Integer)


961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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

#output_locationTypes::OutputLocation

Location for output files generated by the simulation job.



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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

#robot_applicationsArray<Types::RobotApplicationConfig>

The robot application to use in the simulation job.

Returns:



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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

#simulation_applicationsArray<Types::SimulationApplicationConfig>

The simulation application to use in the simulation job.



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

class CreateSimulationJobRequest < Struct.new(
  :client_request_token,
  :output_location,
  :logging_config,
  :max_job_duration_in_seconds,
  :iam_role,
  :failure_behavior,
  :robot_applications,
  :simulation_applications,
  :data_sources,
  :tags,
  :vpc_config,
  :compute)
  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 one subnet ID.

Returns:



961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/aws-sdk-robomaker/types.rb', line 961

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