Struct aws_sdk_robomaker::model::UploadConfiguration

#[non_exhaustive]
pub struct UploadConfiguration {
    pub name: Option<String>,
    pub path: Option<String>,
    pub upload_behavior: Option<UploadBehavior>,
}

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

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.

name: Option<String>

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/ / /robot-test .

path: Option<String>

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.

upload_behavior: Option<UploadBehavior>

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.

Implementations

impl UploadConfiguration

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

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/ / /robot-test .

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

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.

pub fn upload_behavior(&self) -> Option<&UploadBehavior>

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.

impl UploadConfiguration

pub fn builder() -> Builder

Creates a new builder-style object to manufacture UploadConfiguration

Trait Implementations

impl Clone for UploadConfiguration

fn clone(&self) -> UploadConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UploadConfiguration

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

Formats the value using the given formatter.

impl PartialEq<UploadConfiguration> for UploadConfiguration

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for UploadConfiguration