/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Configures your DataSync task settings. These options include how DataSync
* handles files, objects, and their associated metadata. You also can specify how
* DataSync verifies data integrity, set bandwidth limits for your task, among
* other options. Each task setting has a default value. Unless you need to,
* you don't have to configure any of these Options
before starting
* your task.See Also:
AWS
* API Reference
Specifies how and when DataSync checks the integrity of your data during a * transfer.
Default value: POINT_IN_TIME_CONSISTENT
* 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
: 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.
Specifies how and when DataSync checks the integrity of your data during a * transfer.
Default value: POINT_IN_TIME_CONSISTENT
* 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
: 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.
Specifies how and when DataSync checks the integrity of your data during a * transfer.
Default value: POINT_IN_TIME_CONSISTENT
* 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
: 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.
Specifies how and when DataSync checks the integrity of your data during a * transfer.
Default value: POINT_IN_TIME_CONSISTENT
* 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
: 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.
Specifies how and when DataSync checks the integrity of your data during a * transfer.
Default value: POINT_IN_TIME_CONSISTENT
* 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
: 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.
Specifies how and when DataSync checks the integrity of your data during a * transfer.
Default value: POINT_IN_TIME_CONSISTENT
* 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
: 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.
Specifies whether data at the destination location should be overwritten or
* preserved. If set to NEVER
, a destination file for example 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 Amazon S3 storage * cost. For detailed information, see Considerations * when working with Amazon S3 storage classes in DataSync.
*/ inline const OverwriteMode& GetOverwriteMode() const{ return m_overwriteMode; } /** *Specifies whether data at the destination location should be overwritten or
* preserved. If set to NEVER
, a destination file for example 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 Amazon S3 storage * cost. For detailed information, see Considerations * when working with Amazon S3 storage classes in DataSync.
*/ inline bool OverwriteModeHasBeenSet() const { return m_overwriteModeHasBeenSet; } /** *Specifies whether data at the destination location should be overwritten or
* preserved. If set to NEVER
, a destination file for example 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 Amazon S3 storage * cost. For detailed information, see Considerations * when working with Amazon S3 storage classes in DataSync.
*/ inline void SetOverwriteMode(const OverwriteMode& value) { m_overwriteModeHasBeenSet = true; m_overwriteMode = value; } /** *Specifies whether data at the destination location should be overwritten or
* preserved. If set to NEVER
, a destination file for example 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 Amazon S3 storage * cost. For detailed information, see Considerations * when working with Amazon S3 storage classes in DataSync.
*/ inline void SetOverwriteMode(OverwriteMode&& value) { m_overwriteModeHasBeenSet = true; m_overwriteMode = std::move(value); } /** *Specifies whether data at the destination location should be overwritten or
* preserved. If set to NEVER
, a destination file for example 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 Amazon S3 storage * cost. For detailed information, see Considerations * when working with Amazon S3 storage classes in DataSync.
*/ inline Options& WithOverwriteMode(const OverwriteMode& value) { SetOverwriteMode(value); return *this;} /** *Specifies whether data at the destination location should be overwritten or
* preserved. If set to NEVER
, a destination file for example 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 Amazon S3 storage * cost. For detailed information, see Considerations * when working with Amazon S3 storage classes in DataSync.
*/ inline Options& WithOverwriteMode(OverwriteMode&& value) { SetOverwriteMode(std::move(value)); return *this;} /** *Specifies whether to preserve metadata indicating the last time a 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 of
* the task execution).
The behavior of Atime
isn't
* fully standard across platforms, so 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
.
Specifies whether to preserve metadata indicating the last time a 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 of
* the task execution).
The behavior of Atime
isn't
* fully standard across platforms, so 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
.
Specifies whether to preserve metadata indicating the last time a 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 of
* the task execution).
The behavior of Atime
isn't
* fully standard across platforms, so 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
.
Specifies whether to preserve metadata indicating the last time a 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 of
* the task execution).
The behavior of Atime
isn't
* fully standard across platforms, so 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
.
Specifies whether to preserve metadata indicating the last time a 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 of
* the task execution).
The behavior of Atime
isn't
* fully standard across platforms, so 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
.
Specifies whether to preserve metadata indicating the last time a 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 of
* the task execution).
The behavior of Atime
isn't
* fully standard across platforms, so 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
.
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.
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
.
*
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.
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
.
*
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.
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
.
*
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.
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
.
*
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.
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
.
*
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.
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
.
*
Specifies the POSIX user ID (UID) of the file's owner.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX user ID (UID) of the file's owner.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX user ID (UID) of the file's owner.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX user ID (UID) of the file's owner.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX user ID (UID) of the file's owner.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX user ID (UID) of the file's owner.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX group ID (GID) of the file's owners.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX group ID (GID) of the file's owners.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX group ID (GID) of the file's owners.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX group ID (GID) of the file's owners.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX group ID (GID) of the file's owners.
For more * information, see Metadata * copied by DataSync.
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.
Specifies the POSIX group ID (GID) of the file's owners.
For more * information, see Metadata * copied by DataSync.
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.
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.
Default
* value: PRESERVE
PRESERVE
: Ignore such
* destination files (recommended).
REMOVE
: Delete
* destination files that aren’t present in the source.
If you set
* this parameter to 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.
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.
Default
* value: PRESERVE
PRESERVE
: Ignore such
* destination files (recommended).
REMOVE
: Delete
* destination files that aren’t present in the source.
If you set
* this parameter to 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.
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.
Default
* value: PRESERVE
PRESERVE
: Ignore such
* destination files (recommended).
REMOVE
: Delete
* destination files that aren’t present in the source.
If you set
* this parameter to 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.
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.
Default
* value: PRESERVE
PRESERVE
: Ignore such
* destination files (recommended).
REMOVE
: Delete
* destination files that aren’t present in the source.
If you set
* this parameter to 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.
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.
Default
* value: PRESERVE
PRESERVE
: Ignore such
* destination files (recommended).
REMOVE
: Delete
* destination files that aren’t present in the source.
If you set
* this parameter to 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.
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.
Default
* value: PRESERVE
PRESERVE
: Ignore such
* destination files (recommended).
REMOVE
: Delete
* destination files that aren’t present in the source.
If you set
* this parameter to 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.
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.
DataSync can't copy the actual contents of these * devices because they're 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
* currently isn't supported for Amazon EFS.
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.
DataSync can't copy the actual contents of these * devices because they're 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
* currently isn't supported for Amazon EFS.
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.
DataSync can't copy the actual contents of these * devices because they're 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
* currently isn't supported for Amazon EFS.
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.
DataSync can't copy the actual contents of these * devices because they're 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
* currently isn't supported for Amazon EFS.
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.
DataSync can't copy the actual contents of these * devices because they're 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
* currently isn't supported for Amazon EFS.
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.
DataSync can't copy the actual contents of these * devices because they're 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
* currently isn't supported for Amazon EFS.
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.
Default value: PRESERVE
* PRESERVE
: Preserve POSIX-style permissions (recommended).
* NONE
: Ignore permissions.
DataSync can preserve * extant permissions of a source location.
*/ inline const PosixPermissions& GetPosixPermissions() const{ return m_posixPermissions; } /** *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.
Default value: PRESERVE
* PRESERVE
: Preserve POSIX-style permissions (recommended).
* NONE
: Ignore permissions.
DataSync can preserve * extant permissions of a source location.
*/ inline bool PosixPermissionsHasBeenSet() const { return m_posixPermissionsHasBeenSet; } /** *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.
Default value: PRESERVE
* PRESERVE
: Preserve POSIX-style permissions (recommended).
* NONE
: Ignore permissions.
DataSync can preserve * extant permissions of a source location.
*/ inline void SetPosixPermissions(const PosixPermissions& value) { m_posixPermissionsHasBeenSet = true; m_posixPermissions = value; } /** *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.
Default value: PRESERVE
* PRESERVE
: Preserve POSIX-style permissions (recommended).
* NONE
: Ignore permissions.
DataSync can preserve * extant permissions of a source location.
*/ inline void SetPosixPermissions(PosixPermissions&& value) { m_posixPermissionsHasBeenSet = true; m_posixPermissions = std::move(value); } /** *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.
Default value: PRESERVE
* PRESERVE
: Preserve POSIX-style permissions (recommended).
* NONE
: Ignore permissions.
DataSync can preserve * extant permissions of a source location.
*/ inline Options& WithPosixPermissions(const PosixPermissions& value) { SetPosixPermissions(value); return *this;} /** *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.
Default value: PRESERVE
* PRESERVE
: Preserve POSIX-style permissions (recommended).
* NONE
: Ignore permissions.
DataSync can preserve * extant permissions of a source location.
*/ inline Options& WithPosixPermissions(PosixPermissions&& value) { SetPosixPermissions(std::move(value)); return *this;} /** *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
).
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
).
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
).
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
).
Specifies whether your transfer tasks should be put into a queue during
* certain scenarios when running
* multiple tasks. This is ENABLED
by default.
Specifies whether your transfer tasks should be put into a queue during
* certain scenarios when running
* multiple tasks. This is ENABLED
by default.
Specifies whether your transfer tasks should be put into a queue during
* certain scenarios when running
* multiple tasks. This is ENABLED
by default.
Specifies whether your transfer tasks should be put into a queue during
* certain scenarios when running
* multiple tasks. This is ENABLED
by default.
Specifies whether your transfer tasks should be put into a queue during
* certain scenarios when running
* multiple tasks. This is ENABLED
by default.
Specifies whether your transfer tasks should be put into a queue during
* certain scenarios when running
* multiple tasks. This is ENABLED
by default.
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch * Logs log group. To specify the log group, see CloudWatchLogGroupArn.
*If you set LogLevel
to OFF
, no logs are published.
* BASIC
publishes logs on errors for individual files transferred.
* TRANSFER
publishes logs for every file or object that is
* transferred and integrity checked.
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch * Logs log group. To specify the log group, see CloudWatchLogGroupArn.
*If you set LogLevel
to OFF
, no logs are published.
* BASIC
publishes logs on errors for individual files transferred.
* TRANSFER
publishes logs for every file or object that is
* transferred and integrity checked.
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch * Logs log group. To specify the log group, see CloudWatchLogGroupArn.
*If you set LogLevel
to OFF
, no logs are published.
* BASIC
publishes logs on errors for individual files transferred.
* TRANSFER
publishes logs for every file or object that is
* transferred and integrity checked.
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch * Logs log group. To specify the log group, see CloudWatchLogGroupArn.
*If you set LogLevel
to OFF
, no logs are published.
* BASIC
publishes logs on errors for individual files transferred.
* TRANSFER
publishes logs for every file or object that is
* transferred and integrity checked.
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch * Logs log group. To specify the log group, see CloudWatchLogGroupArn.
*If you set LogLevel
to OFF
, no logs are published.
* BASIC
publishes logs on errors for individual files transferred.
* TRANSFER
publishes logs for every file or object that is
* transferred and integrity checked.
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch * Logs log group. To specify the log group, see CloudWatchLogGroupArn.
*If you set LogLevel
to OFF
, no logs are published.
* BASIC
publishes logs on errors for individual files transferred.
* TRANSFER
publishes logs for every file or object that is
* transferred and integrity checked.
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
: 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 what's in the destination).
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
: 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 what's in the destination).
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
: 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 what's in the destination).
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
: 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 what's in the destination).
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
: 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 what's in the destination).
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
: 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 what's in the destination).
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.
Default value: OWNER_DACL
*
OWNER_DACL
: 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 that ensures sufficient permissions to files, folders, and metadata, see user.
* 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.
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.
Default value: OWNER_DACL
*
OWNER_DACL
: 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 that ensures sufficient permissions to files, folders, and metadata, see user.
* 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.
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.
Default value: OWNER_DACL
*
OWNER_DACL
: 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 that ensures sufficient permissions to files, folders, and metadata, see user.
* 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.
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.
Default value: OWNER_DACL
*
OWNER_DACL
: 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 that ensures sufficient permissions to files, folders, and metadata, see user.
* 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.
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.
Default value: OWNER_DACL
*
OWNER_DACL
: 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 that ensures sufficient permissions to files, folders, and metadata, see user.
* 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.
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.
Default value: OWNER_DACL
*
OWNER_DACL
: 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 that ensures sufficient permissions to files, folders, and metadata, see user.
* 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.
Specifies whether object tags are preserved when transferring between object
* storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE
value.
Default Value: PRESERVE
Specifies whether object tags are preserved when transferring between object
* storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE
value.
Default Value: PRESERVE
Specifies whether object tags are preserved when transferring between object
* storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE
value.
Default Value: PRESERVE
Specifies whether object tags are preserved when transferring between object
* storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE
value.
Default Value: PRESERVE
Specifies whether object tags are preserved when transferring between object
* storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE
value.
Default Value: PRESERVE
Specifies whether object tags are preserved when transferring between object
* storage systems. If you want your DataSync task to ignore object tags, specify
* the NONE
value.
Default Value: PRESERVE