You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DataSync::Types::Options

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Options as input to an Aws::Client method, you can use a vanilla Hash:

{
  verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
  overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
  atime: "NONE", # accepts NONE, BEST_EFFORT
  mtime: "NONE", # accepts NONE, PRESERVE
  uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
  gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
  preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
  preserve_devices: "NONE", # accepts NONE, PRESERVE
  posix_permissions: "NONE", # accepts NONE, BEST_EFFORT, PRESERVE
  bytes_per_second: 1,
  task_queueing: "ENABLED", # accepts ENABLED, DISABLED
}

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#atimeString

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.

Possible values:

  • NONE
  • BEST_EFFORT

Returns:

  • (String)

    A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to).

#bytes_per_secondInteger

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).

Returns:

  • (Integer)

    A value that limits the bandwidth used by AWS DataSync.

#gidString

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.

Possible values:

  • NONE
  • INT_VALUE
  • NAME
  • BOTH

Returns:

  • (String)

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

#mtimeString

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.

Possible values:

  • NONE
  • PRESERVE

Returns:

  • (String)

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

#overwrite_modeString

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.

Possible values:

  • ALWAYS
  • NEVER

Returns:

  • (String)

    A value that determines whether files at the destination should be overwritten or preserved when copying files.

#posix_permissionsString

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.

Possible values:

  • NONE
  • BEST_EFFORT
  • PRESERVE

Returns:

  • (String)

    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.

#preserve_deleted_filesString

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.

Possible values:

  • PRESERVE
  • REMOVE

Returns:

  • (String)

    A value that specifies whether files in the destination that don\'t exist in the source file system should be preserved.

#preserve_devicesString

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.

Possible values:

  • NONE
  • PRESERVE

Returns:

  • (String)

    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.

#task_queueingString

A value that determines whether tasks should be queued before executing the tasks. If set to Enabled, the tasks will 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 task-queue.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    A value that determines whether tasks should be queued before executing the tasks.

#uidString

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.

Possible values:

  • NONE
  • INT_VALUE
  • NAME
  • BOTH

Returns:

  • (String)

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

#verify_modeString

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.

Default value: POINT_IN_TIME_CONSISTENT.

POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.

NONE: Skip verification.

Possible values:

  • POINT_IN_TIME_CONSISTENT
  • ONLY_FILES_TRANSFERRED
  • NONE

Returns:

  • (String)

    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.