Class: Aws::RoboMaker::Types::UploadConfiguration

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

Overview

Note:

When making an API call, you may pass UploadConfiguration data as a hash:

{
  name: "Name", # required
  path: "Path", # required
  upload_behavior: "UPLOAD_ON_TERMINATE", # required, accepts UPLOAD_ON_TERMINATE, UPLOAD_ROLLING_AUTO_REMOVE
}

Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

Returns:

  • (String)


7011
7012
7013
7014
7015
7016
7017
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 7011

class UploadConfiguration < Struct.new(
  :name,
  :path,
  :upload_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#pathString

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

Returns:

  • (String)


7011
7012
7013
7014
7015
7016
7017
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 7011

class UploadConfiguration < Struct.new(
  :name,
  :path,
  :upload_behavior)
  SENSITIVE = []
  include Aws::Structure
end

#upload_behaviorString

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

Returns:

  • (String)


7011
7012
7013
7014
7015
7016
7017
# File 'gems/aws-sdk-robomaker/lib/aws-sdk-robomaker/types.rb', line 7011

class UploadConfiguration < Struct.new(
  :name,
  :path,
  :upload_behavior)
  SENSITIVE = []
  include Aws::Structure
end