Class Options
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Options.Builder,
Options>
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.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Atime
atime()
Specifies whether to preserve metadata indicating the last time a file was read or written to.final String
Specifies whether to preserve metadata indicating the last time a file was read or written to.static Options.Builder
builder()
final Long
Limits the bandwidth used by a DataSync task.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final Gid
gid()
Specifies the POSIX group ID (GID) of the file's owners.final String
Specifies the POSIX group ID (GID) of the file's owners.final int
hashCode()
final LogLevel
logLevel()
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group.final String
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group.final Mtime
mtime()
Specifies whether to preserve metadata indicating the last time that a file was written to before thePREPARING
phase of your task execution.final String
Specifies whether to preserve metadata indicating the last time that a file was written to before thePREPARING
phase of your task execution.final ObjectTags
Specifies whether you want DataSync toPRESERVE
object tags (default behavior) when transferring between object storage systems.final String
Specifies whether you want DataSync toPRESERVE
object tags (default behavior) when transferring between object storage systems.final OverwriteMode
Specifies whether DataSync should modify or preserve data at the destination location.final String
Specifies whether DataSync should modify or preserve data at the destination location.final PosixPermissions
Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.final String
Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.final PreserveDeletedFiles
Specifies whether files in the destination location that don't exist in the source should be preserved.final String
Specifies whether files in the destination location that don't exist in the source should be preserved.final PreserveDevices
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.final 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.Specifies which components of the SMB security descriptor are copied from source to destination objects.final String
Specifies which components of the SMB security descriptor are copied from source to destination objects.static Class
<? extends Options.Builder> final TaskQueueing
Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks.final String
Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TransferMode
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).final 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).final Uid
uid()
Specifies the POSIX user ID (UID) of the file's owner.final String
Specifies the POSIX user ID (UID) of the file's owner.final VerifyMode
Specifies how and when DataSync checks the integrity of your data during a transfer.final String
Specifies how and when DataSync checks the integrity of your data during a transfer.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
verifyMode
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.
If the service returns an enum value that is not available in the current SDK version,
verifyMode
will returnVerifyMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromverifyModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
verifyModeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
verifyMode
will returnVerifyMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromverifyModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
overwriteMode
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.
If the service returns an enum value that is not available in the current SDK version,
overwriteMode
will returnOverwriteMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoverwriteModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
overwriteModeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
overwriteMode
will returnOverwriteMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoverwriteModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
atime
Specifies whether to preserve metadata indicating the last time a file was read or written to.
The behavior of
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
.
If
Atime
is set toBEST_EFFORT
,Mtime
must be set toPRESERVE
.If
Atime
is set toNONE
,Mtime
must also beNONE
.If the service returns an enum value that is not available in the current SDK version,
atime
will returnAtime.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromatimeAsString()
.- Returns:
- Specifies whether to preserve metadata indicating the last time a file was read or written to.
The behavior of
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
.
If
Atime
is set toBEST_EFFORT
,Mtime
must be set toPRESERVE
.If
Atime
is set toNONE
,Mtime
must also beNONE
. -
- See Also:
-
-
atimeAsString
Specifies whether to preserve metadata indicating the last time a file was read or written to.
The behavior of
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
.
If
Atime
is set toBEST_EFFORT
,Mtime
must be set toPRESERVE
.If
Atime
is set toNONE
,Mtime
must also beNONE
.If the service returns an enum value that is not available in the current SDK version,
atime
will returnAtime.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromatimeAsString()
.- Returns:
- Specifies whether to preserve metadata indicating the last time a file was read or written to.
The behavior of
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
.
If
Atime
is set toBEST_EFFORT
,Mtime
must be set toPRESERVE
.If
Atime
is set toNONE
,Mtime
must also beNONE
. -
- See Also:
-
-
mtime
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
.
If
Mtime
is set toPRESERVE
,Atime
must be set toBEST_EFFORT
.If
Mtime
is set toNONE
,Atime
must also be set toNONE
.If the service returns an enum value that is not available in the current SDK version,
mtime
will returnMtime.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommtimeAsString()
.- Returns:
- 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
.
If
Mtime
is set toPRESERVE
,Atime
must be set toBEST_EFFORT
.If
Mtime
is set toNONE
,Atime
must also be set toNONE
. -
- See Also:
-
-
mtimeAsString
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
.
If
Mtime
is set toPRESERVE
,Atime
must be set toBEST_EFFORT
.If
Mtime
is set toNONE
,Atime
must also be set toNONE
.If the service returns an enum value that is not available in the current SDK version,
mtime
will returnMtime.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommtimeAsString()
.- Returns:
- 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
.
If
Mtime
is set toPRESERVE
,Atime
must be set toBEST_EFFORT
.If
Mtime
is set toNONE
,Atime
must also be set toNONE
. -
- See Also:
-
-
uid
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.
If the service returns an enum value that is not available in the current SDK version,
uid
will returnUid.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuidAsString()
.- Returns:
- 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.
-
- See Also:
-
-
uidAsString
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.
If the service returns an enum value that is not available in the current SDK version,
uid
will returnUid.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuidAsString()
.- Returns:
- 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.
-
- See Also:
-
-
gid
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.
If the service returns an enum value that is not available in the current SDK version,
gid
will returnGid.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgidAsString()
.- Returns:
- 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.
-
- See Also:
-
-
gidAsString
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.
If the service returns an enum value that is not available in the current SDK version,
gid
will returnGid.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromgidAsString()
.- Returns:
- 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.
-
- See Also:
-
-
preserveDeletedFiles
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.
If you set this parameter to
REMOVE
, you can't setTransferMode
toALL
. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.If the service returns an enum value that is not available in the current SDK version,
preserveDeletedFiles
will returnPreserveDeletedFiles.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompreserveDeletedFilesAsString()
.- Returns:
- 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.
If you set this parameter to
REMOVE
, you can't setTransferMode
toALL
. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete. -
- See Also:
-
-
preserveDeletedFilesAsString
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.
If you set this parameter to
REMOVE
, you can't setTransferMode
toALL
. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.If the service returns an enum value that is not available in the current SDK version,
preserveDeletedFiles
will returnPreserveDeletedFiles.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompreserveDeletedFilesAsString()
.- Returns:
- 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.
If you set this parameter to
REMOVE
, you can't setTransferMode
toALL
. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete. -
- See Also:
-
-
preserveDevices
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.
-
NONE
(default) - Ignores special devices (recommended). -
PRESERVE
- Preserves character and block device metadata. This option currently isn't supported for Amazon EFS.
If the service returns an enum value that is not available in the current SDK version,
preserveDevices
will returnPreserveDevices.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompreserveDevicesAsString()
.- Returns:
- 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.
-
NONE
(default) - Ignores special devices (recommended). -
PRESERVE
- Preserves character and block device metadata. This option currently isn't supported for Amazon EFS.
-
- See Also:
-
-
preserveDevicesAsString
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.
-
NONE
(default) - Ignores special devices (recommended). -
PRESERVE
- Preserves character and block device metadata. This option currently isn't supported for Amazon EFS.
If the service returns an enum value that is not available in the current SDK version,
preserveDevices
will returnPreserveDevices.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompreserveDevicesAsString()
.- Returns:
- 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.
-
NONE
(default) - Ignores special devices (recommended). -
PRESERVE
- Preserves character and block device metadata. This option currently isn't supported for Amazon EFS.
-
- See Also:
-
-
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.
-
PRESERVE
(default) - Preserves POSIX-style permissions, which is recommended. -
NONE
- Ignores POSIX-style permissions.
DataSync can preserve extant permissions of a source location.
If the service returns an enum value that is not available in the current SDK version,
posixPermissions
will returnPosixPermissions.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromposixPermissionsAsString()
.- Returns:
- 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.
DataSync can preserve extant permissions of a source location.
-
- See Also:
-
-
posixPermissionsAsString
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.
DataSync can preserve extant permissions of a source location.
If the service returns an enum value that is not available in the current SDK version,
posixPermissions
will returnPosixPermissions.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromposixPermissionsAsString()
.- Returns:
- 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.
DataSync can preserve extant permissions of a source location.
-
- See Also:
-
-
bytesPerSecond
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
).- Returns:
- 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
).
-
taskQueueing
Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is
ENABLED
by default.If the service returns an enum value that is not available in the current SDK version,
taskQueueing
will returnTaskQueueing.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskQueueingAsString()
.- Returns:
- Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
multiple tasks. This is
ENABLED
by default. - See Also:
-
taskQueueingAsString
Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is
ENABLED
by default.If the service returns an enum value that is not available in the current SDK version,
taskQueueing
will returnTaskQueueing.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtaskQueueingAsString()
.- Returns:
- Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
multiple tasks. This is
ENABLED
by default. - See Also:
-
logLevel
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.
If the service returns an enum value that is not available in the current SDK version,
logLevel
will returnLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogLevelAsString()
.- Returns:
- 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.
-
- See Also:
-
-
logLevelAsString
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.
If the service returns an enum value that is not available in the current SDK version,
logLevel
will returnLogLevel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlogLevelAsString()
.- Returns:
- 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.
-
- See Also:
-
-
transferMode
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.
If the service returns an enum value that is not available in the current SDK version,
transferMode
will returnTransferMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtransferModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
transferModeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
transferMode
will returnTransferMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtransferModeAsString()
.- Returns:
- 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.
-
- See Also:
-
-
securityDescriptorCopyFlags
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.
If the service returns an enum value that is not available in the current SDK version,
securityDescriptorCopyFlags
will returnSmbSecurityDescriptorCopyFlags.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsecurityDescriptorCopyFlagsAsString()
.- Returns:
- 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.
-
- See Also:
-
-
securityDescriptorCopyFlagsAsString
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.
If the service returns an enum value that is not available in the current SDK version,
securityDescriptorCopyFlags
will returnSmbSecurityDescriptorCopyFlags.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsecurityDescriptorCopyFlagsAsString()
.- Returns:
- 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.
-
- See Also:
-
-
objectTags
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 theNONE
value.If the service returns an enum value that is not available in the current SDK version,
objectTags
will returnObjectTags.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectTagsAsString()
.- Returns:
- 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 theNONE
value. - See Also:
-
objectTagsAsString
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 theNONE
value.If the service returns an enum value that is not available in the current SDK version,
objectTags
will returnObjectTags.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectTagsAsString()
.- Returns:
- 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 theNONE
value. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Options.Builder,
Options> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-