Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RobOMaker.Types.UploadConfiguration

Description

Documentation

data UploadConfiguration Source #

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

See: newUploadConfiguration smart constructor.

Constructors

UploadConfiguration'

Fields

name :: Text
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.
path :: Text
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.
uploadBehavior :: 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.

Instances

Instances details

Eq UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration Methods (==) :: UploadConfiguration -> UploadConfiguration -> Bool # (/=) :: UploadConfiguration -> UploadConfiguration -> Bool #
Read UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration Methods readsPrec :: Int -> ReadS UploadConfiguration # readList :: ReadS [UploadConfiguration] # readPrec :: ReadPrec UploadConfiguration # readListPrec :: ReadPrec [UploadConfiguration] #
Show UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration Methods showsPrec :: Int -> UploadConfiguration -> ShowS # show :: UploadConfiguration -> String # showList :: [UploadConfiguration] -> ShowS #
Generic UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration Associated Types type Rep UploadConfiguration :: Type -> Type # Methods from :: UploadConfiguration -> Rep UploadConfiguration x # to :: Rep UploadConfiguration x -> UploadConfiguration #
NFData UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration Methods rnf :: UploadConfiguration -> () #
Hashable UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration Methods hashWithSalt :: Int -> UploadConfiguration -> Int # hash :: UploadConfiguration -> Int #
ToJSON UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration Methods toJSON :: UploadConfiguration -> Value # toEncoding :: UploadConfiguration -> Encoding # toJSONList :: [UploadConfiguration] -> Value # toEncodingList :: [UploadConfiguration] -> Encoding #
FromJSON UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration Methods parseJSON :: Value -> Parser UploadConfiguration # parseJSONList :: Value -> Parser [UploadConfiguration] #
type Rep UploadConfiguration Source #
Instance details Defined in Amazonka.RobOMaker.Types.UploadConfiguration type Rep UploadConfiguration = D1 ('MetaData "UploadConfiguration" "Amazonka.RobOMaker.Types.UploadConfiguration" "libZSservicesZSamazonka-robomakerZSamazonka-robomaker" 'False) (C1 ('MetaCons "UploadConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "uploadBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadBehavior))))

newUploadConfiguration Source #

Arguments

:: Text	`$sel:name:UploadConfiguration'`
-> Text	`$sel:path:UploadConfiguration'`
-> UploadBehavior	`$sel:uploadBehavior:UploadConfiguration'`
-> UploadConfiguration

Create a value of UploadConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:UploadConfiguration', uploadConfiguration_name - 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.

$sel:path:UploadConfiguration', uploadConfiguration_path - 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.

$sel:uploadBehavior:UploadConfiguration', uploadConfiguration_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.

uploadConfiguration_name :: Lens' UploadConfiguration Text Source #

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.

uploadConfiguration_path :: Lens' UploadConfiguration Text Source #

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.

uploadConfiguration_uploadBehavior :: Lens' UploadConfiguration UploadBehavior Source #

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.