AWS SDK for C++  1.8.74
AWS SDK for C++
Public Member Functions | List of all members
Aws::DataSync::Model::Options Class Reference

#include <Options.h>

Public Member Functions

 Options ()
 
 Options (Aws::Utils::Json::JsonView jsonValue)
 
Optionsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const VerifyModeGetVerifyMode () const
 
bool VerifyModeHasBeenSet () const
 
void SetVerifyMode (const VerifyMode &value)
 
void SetVerifyMode (VerifyMode &&value)
 
OptionsWithVerifyMode (const VerifyMode &value)
 
OptionsWithVerifyMode (VerifyMode &&value)
 
const OverwriteModeGetOverwriteMode () const
 
bool OverwriteModeHasBeenSet () const
 
void SetOverwriteMode (const OverwriteMode &value)
 
void SetOverwriteMode (OverwriteMode &&value)
 
OptionsWithOverwriteMode (const OverwriteMode &value)
 
OptionsWithOverwriteMode (OverwriteMode &&value)
 
const AtimeGetAtime () const
 
bool AtimeHasBeenSet () const
 
void SetAtime (const Atime &value)
 
void SetAtime (Atime &&value)
 
OptionsWithAtime (const Atime &value)
 
OptionsWithAtime (Atime &&value)
 
const MtimeGetMtime () const
 
bool MtimeHasBeenSet () const
 
void SetMtime (const Mtime &value)
 
void SetMtime (Mtime &&value)
 
OptionsWithMtime (const Mtime &value)
 
OptionsWithMtime (Mtime &&value)
 
const UidGetUid () const
 
bool UidHasBeenSet () const
 
void SetUid (const Uid &value)
 
void SetUid (Uid &&value)
 
OptionsWithUid (const Uid &value)
 
OptionsWithUid (Uid &&value)
 
const GidGetGid () const
 
bool GidHasBeenSet () const
 
void SetGid (const Gid &value)
 
void SetGid (Gid &&value)
 
OptionsWithGid (const Gid &value)
 
OptionsWithGid (Gid &&value)
 
const PreserveDeletedFilesGetPreserveDeletedFiles () const
 
bool PreserveDeletedFilesHasBeenSet () const
 
void SetPreserveDeletedFiles (const PreserveDeletedFiles &value)
 
void SetPreserveDeletedFiles (PreserveDeletedFiles &&value)
 
OptionsWithPreserveDeletedFiles (const PreserveDeletedFiles &value)
 
OptionsWithPreserveDeletedFiles (PreserveDeletedFiles &&value)
 
const PreserveDevicesGetPreserveDevices () const
 
bool PreserveDevicesHasBeenSet () const
 
void SetPreserveDevices (const PreserveDevices &value)
 
void SetPreserveDevices (PreserveDevices &&value)
 
OptionsWithPreserveDevices (const PreserveDevices &value)
 
OptionsWithPreserveDevices (PreserveDevices &&value)
 
const PosixPermissionsGetPosixPermissions () const
 
bool PosixPermissionsHasBeenSet () const
 
void SetPosixPermissions (const PosixPermissions &value)
 
void SetPosixPermissions (PosixPermissions &&value)
 
OptionsWithPosixPermissions (const PosixPermissions &value)
 
OptionsWithPosixPermissions (PosixPermissions &&value)
 
long long GetBytesPerSecond () const
 
bool BytesPerSecondHasBeenSet () const
 
void SetBytesPerSecond (long long value)
 
OptionsWithBytesPerSecond (long long value)
 
const TaskQueueingGetTaskQueueing () const
 
bool TaskQueueingHasBeenSet () const
 
void SetTaskQueueing (const TaskQueueing &value)
 
void SetTaskQueueing (TaskQueueing &&value)
 
OptionsWithTaskQueueing (const TaskQueueing &value)
 
OptionsWithTaskQueueing (TaskQueueing &&value)
 
const LogLevelGetLogLevel () const
 
bool LogLevelHasBeenSet () const
 
void SetLogLevel (const LogLevel &value)
 
void SetLogLevel (LogLevel &&value)
 
OptionsWithLogLevel (const LogLevel &value)
 
OptionsWithLogLevel (LogLevel &&value)
 
const TransferModeGetTransferMode () const
 
bool TransferModeHasBeenSet () const
 
void SetTransferMode (const TransferMode &value)
 
void SetTransferMode (TransferMode &&value)
 
OptionsWithTransferMode (const TransferMode &value)
 
OptionsWithTransferMode (TransferMode &&value)
 

Detailed Description

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

See Also:

AWS API Reference

Definition at line 50 of file Options.h.

Constructor & Destructor Documentation

◆ Options() [1/2]

Aws::DataSync::Model::Options::Options ( )

◆ Options() [2/2]

Aws::DataSync::Model::Options::Options ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AtimeHasBeenSet()

bool Aws::DataSync::Model::Options::AtimeHasBeenSet ( ) const
inline

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

Definition at line 251 of file Options.h.

◆ BytesPerSecondHasBeenSet()

bool Aws::DataSync::Model::Options::BytesPerSecondHasBeenSet ( ) const
inline

A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

Definition at line 692 of file Options.h.

◆ GetAtime()

const Atime& Aws::DataSync::Model::Options::GetAtime ( ) const
inline

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

Definition at line 236 of file Options.h.

◆ GetBytesPerSecond()

long long Aws::DataSync::Model::Options::GetBytesPerSecond ( ) const
inline

A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

Definition at line 685 of file Options.h.

◆ GetGid()

const Gid& Aws::DataSync::Model::Options::GetGid ( ) const
inline

The group ID (GID) of the file's owners.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

Definition at line 436 of file Options.h.

◆ GetLogLevel()

const LogLevel& Aws::DataSync::Model::Options::GetLogLevel ( ) const
inline

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

Definition at line 774 of file Options.h.

◆ GetMtime()

const Mtime& Aws::DataSync::Model::Options::GetMtime ( ) const
inline

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

Definition at line 323 of file Options.h.

◆ GetOverwriteMode()

const OverwriteMode& Aws::DataSync::Model::Options::GetOverwriteMode ( ) const
inline

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Definition at line 160 of file Options.h.

◆ GetPosixPermissions()

const PosixPermissions& Aws::DataSync::Model::Options::GetPosixPermissions ( ) const
inline

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

Definition at line 632 of file Options.h.

◆ GetPreserveDeletedFiles()

const PreserveDeletedFiles& Aws::DataSync::Model::Options::GetPreserveDeletedFiles ( ) const
inline

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

Definition at line 489 of file Options.h.

◆ GetPreserveDevices()

const PreserveDevices& Aws::DataSync::Model::Options::GetPreserveDevices ( ) const
inline

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

Definition at line 562 of file Options.h.

◆ GetTaskQueueing()

const TaskQueueing& Aws::DataSync::Model::Options::GetTaskQueueing ( ) const
inline

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see queue-task-execution.

Definition at line 716 of file Options.h.

◆ GetTransferMode()

const TransferMode& Aws::DataSync::Model::Options::GetTransferMode ( ) const
inline

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.

Definition at line 846 of file Options.h.

◆ GetUid()

const Uid& Aws::DataSync::Model::Options::GetUid ( ) const
inline

The user ID (UID) of the file's owner.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

Definition at line 387 of file Options.h.

◆ GetVerifyMode()

const VerifyMode& Aws::DataSync::Model::Options::GetVerifyMode ( ) const
inline

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see create-task

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

Definition at line 72 of file Options.h.

◆ GidHasBeenSet()

bool Aws::DataSync::Model::Options::GidHasBeenSet ( ) const
inline

The group ID (GID) of the file's owners.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

Definition at line 444 of file Options.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::DataSync::Model::Options::Jsonize ( ) const

◆ LogLevelHasBeenSet()

bool Aws::DataSync::Model::Options::LogLevelHasBeenSet ( ) const
inline

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

Definition at line 786 of file Options.h.

◆ MtimeHasBeenSet()

bool Aws::DataSync::Model::Options::MtimeHasBeenSet ( ) const
inline

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

Definition at line 334 of file Options.h.

◆ operator=()

Options& Aws::DataSync::Model::Options::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OverwriteModeHasBeenSet()

bool Aws::DataSync::Model::Options::OverwriteModeHasBeenSet ( ) const
inline

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Definition at line 172 of file Options.h.

◆ PosixPermissionsHasBeenSet()

bool Aws::DataSync::Model::Options::PosixPermissionsHasBeenSet ( ) const
inline

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

Definition at line 641 of file Options.h.

◆ PreserveDeletedFilesHasBeenSet()

bool Aws::DataSync::Model::Options::PreserveDeletedFilesHasBeenSet ( ) const
inline

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

Definition at line 501 of file Options.h.

◆ PreserveDevicesHasBeenSet()

bool Aws::DataSync::Model::Options::PreserveDevicesHasBeenSet ( ) const
inline

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

Definition at line 574 of file Options.h.

◆ SetAtime() [1/2]

void Aws::DataSync::Model::Options::SetAtime ( const Atime value)
inline

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

Definition at line 266 of file Options.h.

◆ SetAtime() [2/2]

void Aws::DataSync::Model::Options::SetAtime ( Atime &&  value)
inline

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

Definition at line 281 of file Options.h.

◆ SetBytesPerSecond()

void Aws::DataSync::Model::Options::SetBytesPerSecond ( long long  value)
inline

A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

Definition at line 699 of file Options.h.

◆ SetGid() [1/2]

void Aws::DataSync::Model::Options::SetGid ( const Gid value)
inline

The group ID (GID) of the file's owners.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

Definition at line 452 of file Options.h.

◆ SetGid() [2/2]

void Aws::DataSync::Model::Options::SetGid ( Gid &&  value)
inline

The group ID (GID) of the file's owners.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

Definition at line 460 of file Options.h.

◆ SetLogLevel() [1/2]

void Aws::DataSync::Model::Options::SetLogLevel ( const LogLevel value)
inline

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

Definition at line 798 of file Options.h.

◆ SetLogLevel() [2/2]

void Aws::DataSync::Model::Options::SetLogLevel ( LogLevel &&  value)
inline

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

Definition at line 810 of file Options.h.

◆ SetMtime() [1/2]

void Aws::DataSync::Model::Options::SetMtime ( const Mtime value)
inline

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

Definition at line 345 of file Options.h.

◆ SetMtime() [2/2]

void Aws::DataSync::Model::Options::SetMtime ( Mtime &&  value)
inline

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

Definition at line 356 of file Options.h.

◆ SetOverwriteMode() [1/2]

void Aws::DataSync::Model::Options::SetOverwriteMode ( const OverwriteMode value)
inline

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Definition at line 184 of file Options.h.

◆ SetOverwriteMode() [2/2]

void Aws::DataSync::Model::Options::SetOverwriteMode ( OverwriteMode &&  value)
inline

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Definition at line 196 of file Options.h.

◆ SetPosixPermissions() [1/2]

void Aws::DataSync::Model::Options::SetPosixPermissions ( const PosixPermissions value)
inline

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

Definition at line 650 of file Options.h.

◆ SetPosixPermissions() [2/2]

void Aws::DataSync::Model::Options::SetPosixPermissions ( PosixPermissions &&  value)
inline

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

Definition at line 659 of file Options.h.

◆ SetPreserveDeletedFiles() [1/2]

void Aws::DataSync::Model::Options::SetPreserveDeletedFiles ( const PreserveDeletedFiles value)
inline

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

Definition at line 513 of file Options.h.

◆ SetPreserveDeletedFiles() [2/2]

void Aws::DataSync::Model::Options::SetPreserveDeletedFiles ( PreserveDeletedFiles &&  value)
inline

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

Definition at line 525 of file Options.h.

◆ SetPreserveDevices() [1/2]

void Aws::DataSync::Model::Options::SetPreserveDevices ( const PreserveDevices value)
inline

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

Definition at line 586 of file Options.h.

◆ SetPreserveDevices() [2/2]

void Aws::DataSync::Model::Options::SetPreserveDevices ( PreserveDevices &&  value)
inline

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

Definition at line 598 of file Options.h.

◆ SetTaskQueueing() [1/2]

void Aws::DataSync::Model::Options::SetTaskQueueing ( const TaskQueueing value)
inline

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see queue-task-execution.

Definition at line 734 of file Options.h.

◆ SetTaskQueueing() [2/2]

void Aws::DataSync::Model::Options::SetTaskQueueing ( TaskQueueing &&  value)
inline

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see queue-task-execution.

Definition at line 743 of file Options.h.

◆ SetTransferMode() [1/2]

void Aws::DataSync::Model::Options::SetTransferMode ( const TransferMode value)
inline

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.

Definition at line 868 of file Options.h.

◆ SetTransferMode() [2/2]

void Aws::DataSync::Model::Options::SetTransferMode ( TransferMode &&  value)
inline

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.

Definition at line 879 of file Options.h.

◆ SetUid() [1/2]

void Aws::DataSync::Model::Options::SetUid ( const Uid value)
inline

The user ID (UID) of the file's owner.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

Definition at line 403 of file Options.h.

◆ SetUid() [2/2]

void Aws::DataSync::Model::Options::SetUid ( Uid &&  value)
inline

The user ID (UID) of the file's owner.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

Definition at line 411 of file Options.h.

◆ SetVerifyMode() [1/2]

void Aws::DataSync::Model::Options::SetVerifyMode ( const VerifyMode value)
inline

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see create-task

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

Definition at line 102 of file Options.h.

◆ SetVerifyMode() [2/2]

void Aws::DataSync::Model::Options::SetVerifyMode ( VerifyMode &&  value)
inline

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see create-task

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

Definition at line 117 of file Options.h.

◆ TaskQueueingHasBeenSet()

bool Aws::DataSync::Model::Options::TaskQueueingHasBeenSet ( ) const
inline

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see queue-task-execution.

Definition at line 725 of file Options.h.

◆ TransferModeHasBeenSet()

bool Aws::DataSync::Model::Options::TransferModeHasBeenSet ( ) const
inline

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.

Definition at line 857 of file Options.h.

◆ UidHasBeenSet()

bool Aws::DataSync::Model::Options::UidHasBeenSet ( ) const
inline

The user ID (UID) of the file's owner.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

Definition at line 395 of file Options.h.

◆ VerifyModeHasBeenSet()

bool Aws::DataSync::Model::Options::VerifyModeHasBeenSet ( ) const
inline

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see create-task

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

Definition at line 87 of file Options.h.

◆ WithAtime() [1/2]

Options& Aws::DataSync::Model::Options::WithAtime ( const Atime value)
inline

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

Definition at line 296 of file Options.h.

◆ WithAtime() [2/2]

Options& Aws::DataSync::Model::Options::WithAtime ( Atime &&  value)
inline

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

Definition at line 311 of file Options.h.

◆ WithBytesPerSecond()

Options& Aws::DataSync::Model::Options::WithBytesPerSecond ( long long  value)
inline

A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

Definition at line 706 of file Options.h.

◆ WithGid() [1/2]

Options& Aws::DataSync::Model::Options::WithGid ( const Gid value)
inline

The group ID (GID) of the file's owners.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

Definition at line 468 of file Options.h.

◆ WithGid() [2/2]

Options& Aws::DataSync::Model::Options::WithGid ( Gid &&  value)
inline

The group ID (GID) of the file's owners.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

Definition at line 476 of file Options.h.

◆ WithLogLevel() [1/2]

Options& Aws::DataSync::Model::Options::WithLogLevel ( const LogLevel value)
inline

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

Definition at line 822 of file Options.h.

◆ WithLogLevel() [2/2]

Options& Aws::DataSync::Model::Options::WithLogLevel ( LogLevel &&  value)
inline

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

Definition at line 834 of file Options.h.

◆ WithMtime() [1/2]

Options& Aws::DataSync::Model::Options::WithMtime ( const Mtime value)
inline

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

Definition at line 367 of file Options.h.

◆ WithMtime() [2/2]

Options& Aws::DataSync::Model::Options::WithMtime ( Mtime &&  value)
inline

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

Definition at line 378 of file Options.h.

◆ WithOverwriteMode() [1/2]

Options& Aws::DataSync::Model::Options::WithOverwriteMode ( const OverwriteMode value)
inline

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Definition at line 208 of file Options.h.

◆ WithOverwriteMode() [2/2]

Options& Aws::DataSync::Model::Options::WithOverwriteMode ( OverwriteMode &&  value)
inline

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Definition at line 220 of file Options.h.

◆ WithPosixPermissions() [1/2]

Options& Aws::DataSync::Model::Options::WithPosixPermissions ( const PosixPermissions value)
inline

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

Definition at line 668 of file Options.h.

◆ WithPosixPermissions() [2/2]

Options& Aws::DataSync::Model::Options::WithPosixPermissions ( PosixPermissions &&  value)
inline

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

Definition at line 677 of file Options.h.

◆ WithPreserveDeletedFiles() [1/2]

Options& Aws::DataSync::Model::Options::WithPreserveDeletedFiles ( const PreserveDeletedFiles value)
inline

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

Definition at line 537 of file Options.h.

◆ WithPreserveDeletedFiles() [2/2]

Options& Aws::DataSync::Model::Options::WithPreserveDeletedFiles ( PreserveDeletedFiles &&  value)
inline

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

Definition at line 549 of file Options.h.

◆ WithPreserveDevices() [1/2]

Options& Aws::DataSync::Model::Options::WithPreserveDevices ( const PreserveDevices value)
inline

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

Definition at line 610 of file Options.h.

◆ WithPreserveDevices() [2/2]

Options& Aws::DataSync::Model::Options::WithPreserveDevices ( PreserveDevices &&  value)
inline

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

Definition at line 622 of file Options.h.

◆ WithTaskQueueing() [1/2]

Options& Aws::DataSync::Model::Options::WithTaskQueueing ( const TaskQueueing value)
inline

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see queue-task-execution.

Definition at line 752 of file Options.h.

◆ WithTaskQueueing() [2/2]

Options& Aws::DataSync::Model::Options::WithTaskQueueing ( TaskQueueing &&  value)
inline

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see queue-task-execution.

Definition at line 761 of file Options.h.

◆ WithTransferMode() [1/2]

Options& Aws::DataSync::Model::Options::WithTransferMode ( const TransferMode value)
inline

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.

Definition at line 890 of file Options.h.

◆ WithTransferMode() [2/2]

Options& Aws::DataSync::Model::Options::WithTransferMode ( TransferMode &&  value)
inline

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.

Definition at line 901 of file Options.h.

◆ WithUid() [1/2]

Options& Aws::DataSync::Model::Options::WithUid ( const Uid value)
inline

The user ID (UID) of the file's owner.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

Definition at line 419 of file Options.h.

◆ WithUid() [2/2]

Options& Aws::DataSync::Model::Options::WithUid ( Uid &&  value)
inline

The user ID (UID) of the file's owner.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

Definition at line 427 of file Options.h.

◆ WithVerifyMode() [1/2]

Options& Aws::DataSync::Model::Options::WithVerifyMode ( const VerifyMode value)
inline

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see create-task

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

Definition at line 132 of file Options.h.

◆ WithVerifyMode() [2/2]

Options& Aws::DataSync::Model::Options::WithVerifyMode ( VerifyMode &&  value)
inline

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see create-task

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

Definition at line 147 of file Options.h.


The documentation for this class was generated from the following file: