Class: Aws::DataSync::Types::Options
- Inherits:
-
Struct
- Object
- Struct
- Aws::DataSync::Types::Options
- Defined in:
- gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb
Overview
Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.
Each option has a default value. Unless you need to, you don't have to configure any of these options before starting your task.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#atime ⇒ String
Specifies whether to preserve metadata indicating the last time a file was read or written to.
-
#bytes_per_second ⇒ Integer
Limits the bandwidth used by a DataSync task.
-
#gid ⇒ String
Specifies the POSIX group ID (GID) of the file's owners.
-
#log_level ⇒ String
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group.
-
#mtime ⇒ String
Specifies whether to preserve metadata indicating the last time that a file was written to before the
PREPARING
phase of your task execution. -
#object_tags ⇒ String
Specifies whether you want DataSync to
PRESERVE
object tags (default behavior) when transferring between object storage systems. -
#overwrite_mode ⇒ String
Specifies whether DataSync should modify or preserve data at the destination location.
-
#posix_permissions ⇒ String
Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
-
#preserve_deleted_files ⇒ String
Specifies whether files in the destination location that don't exist in the source should be preserved.
-
#preserve_devices ⇒ String
Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination.
-
#security_descriptor_copy_flags ⇒ String
Specifies which components of the SMB security descriptor are copied from source to destination objects.
-
#task_queueing ⇒ String
Specifies whether your transfer tasks should be put into a queue during certain scenarios when [running multiple tasks][1].
-
#transfer_mode ⇒ String
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).
-
#uid ⇒ String
Specifies the POSIX user ID (UID) of the file's owner.
-
#verify_mode ⇒ String
Specifies how and when DataSync checks the integrity of your data during a transfer.
Instance Attribute Details
#atime ⇒ String
Specifies whether to preserve metadata indicating the last time a file was read or written to.
Atime
isn't fully standard across platforms, so
DataSync can only do this on a best-effort basis.
BEST_EFFORT
(default) - DataSync attempts to preserve the originalAtime
attribute on all source files (that is, the version before thePREPARING
phase of the task execution). This option is recommended.NONE
- IgnoresAtime
.
Atime
is set to BEST_EFFORT
, Mtime
must be set to
PRESERVE
.
If Atime
is set to NONE
, Mtime
must also be NONE
.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#bytes_per_second ⇒ Integer
Limits the bandwidth used by a DataSync task. For example, if you
want DataSync to use a maximum of 1 MB, set this value to 1048576
(=1024*1024
).
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#gid ⇒ String
Specifies the POSIX group ID (GID) of the file's owners.
INT_VALUE
(default) - Preserves the integer value of user ID (UID) and GID, which is recommended.NONE
- Ignores UID and GID.
For more information, see Metadata copied by DataSync.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#log_level ⇒ String
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn.
BASIC
- Publishes logs with only basic information (such as transfer errors).TRANSFER
- Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.OFF
- No logs are published.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#mtime ⇒ String
Specifies whether to preserve metadata indicating the last time that
a file was written to before the PREPARING
phase of your task
execution. This option is required when you need to run the a task
more than once.
PRESERVE
(default) - Preserves originalMtime
, which is recommended.NONE
- IgnoresMtime
.
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
.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#object_tags ⇒ String
Specifies whether you want DataSync to PRESERVE
object tags
(default behavior) when transferring between object storage systems.
If you want your DataSync task to ignore object tags, specify the
NONE
value.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#overwrite_mode ⇒ String
Specifies whether DataSync should modify or preserve data at the destination location.
ALWAYS
(default) - DataSync modifies data in the destination location when source data (including metadata) has changed.If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.
NEVER
- DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#posix_permissions ⇒ String
Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
For more information, see Metadata copied by DataSync.
PRESERVE
(default) - Preserves POSIX-style permissions, which is recommended.NONE
- Ignores POSIX-style permissions.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#preserve_deleted_files ⇒ String
Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync.
PRESERVE
(default) - Ignores such destination files, which is recommended.REMOVE
- Deletes destination files that aren’t present in the source.
REMOVE
, you can't set TransferMode
to ALL
. When you transfer all data, DataSync doesn't scan your
destination location and doesn't know what to delete.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#preserve_devices ⇒ String
Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.
NONE
(default) - Ignores special devices (recommended).PRESERVE
- Preserves character and block device metadata. This option currently isn't supported for Amazon EFS.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#security_descriptor_copy_flags ⇒ String
Specifies which components of the SMB security descriptor are copied from source to destination objects.
This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see how DataSync handles metadata.
OWNER_DACL
(default) - For each copied object, DataSync copies the following metadata:The object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
DataSync won't copy NTFS system access control lists (SACLs) with this option.
OWNER_DACL_SACL
- For each copied object, DataSync copies the following metadata:The object owner.
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
SACLs, which are used by administrators to log attempts to access a secured object.
Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).
NONE
- None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#task_queueing ⇒ String
Specifies whether your transfer tasks should be put into a queue
during certain scenarios when running multiple tasks. This is
ENABLED
by default.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#transfer_mode ⇒ String
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).
CHANGED
(default) - DataSync copies only data or metadata that is new or different content from the source location to the destination location.ALL
- DataSync copies everything in the source to the destination without comparing differences between the locations.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#uid ⇒ String
Specifies the POSIX user ID (UID) of the file's owner.
INT_VALUE
(default) - Preserves the integer value of UID and group ID (GID), which is recommended.NONE
- Ignores UID and GID.
For more information, see Metadata copied by DataSync.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |
#verify_mode ⇒ String
Specifies how and when DataSync checks the integrity of your data during a transfer.
ONLY_FILES_TRANSFERRED
(recommended) - DataSync calculates the checksum of transferred files and metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on those files at the destination.We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.
POINT_IN_TIME_CONSISTENT
(default) - At the end of the transfer, DataSync scans the entire source and destination to verify that both locations are fully synchronized.You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.
NONE
- DataSync doesn't run additional verification at the end of the transfer. All data transmissions are still integrity-checked with checksum verification during the transfer.
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 |
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 4428 class Options < Struct.new( :verify_mode, :overwrite_mode, :atime, :mtime, :uid, :gid, :preserve_deleted_files, :preserve_devices, :posix_permissions, :bytes_per_second, :task_queueing, :log_level, :transfer_mode, :security_descriptor_copy_flags, :object_tags) SENSITIVE = [] include Aws::Structure end |