Interface Options.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Options.Builder,
,Options> SdkBuilder<Options.Builder,
,Options> SdkPojo
- Enclosing class:
Options
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies whether to preserve metadata indicating the last time a file was read or written to.Specifies whether to preserve metadata indicating the last time a file was read or written to.bytesPerSecond
(Long bytesPerSecond) Limits the bandwidth used by a DataSync task.Specifies the POSIX group ID (GID) of the file's owners.Specifies the POSIX group ID (GID) of the file's owners.Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group.Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group.Specifies whether to preserve metadata indicating the last time that a file was written to before thePREPARING
phase of your task execution.Specifies whether to preserve metadata indicating the last time that a file was written to before thePREPARING
phase of your task execution.objectTags
(String objectTags) Specifies whether you want DataSync toPRESERVE
object tags (default behavior) when transferring between object storage systems.objectTags
(ObjectTags objectTags) Specifies whether you want DataSync toPRESERVE
object tags (default behavior) when transferring between object storage systems.overwriteMode
(String overwriteMode) Specifies whether DataSync should modify or preserve data at the destination location.overwriteMode
(OverwriteMode overwriteMode) Specifies whether DataSync should modify or preserve data at the destination location.posixPermissions
(String posixPermissions) Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.posixPermissions
(PosixPermissions posixPermissions) Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.preserveDeletedFiles
(String preserveDeletedFiles) Specifies whether files in the destination location that don't exist in the source should be preserved.preserveDeletedFiles
(PreserveDeletedFiles preserveDeletedFiles) Specifies whether files in the destination location that don't exist in the source should be preserved.preserveDevices
(String 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.preserveDevices
(PreserveDevices 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.securityDescriptorCopyFlags
(String securityDescriptorCopyFlags) Specifies which components of the SMB security descriptor are copied from source to destination objects.securityDescriptorCopyFlags
(SmbSecurityDescriptorCopyFlags securityDescriptorCopyFlags) Specifies which components of the SMB security descriptor are copied from source to destination objects.taskQueueing
(String taskQueueing) Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks.taskQueueing
(TaskQueueing taskQueueing) Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks.transferMode
(String 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).transferMode
(TransferMode 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).Specifies the POSIX user ID (UID) of the file's owner.Specifies the POSIX user ID (UID) of the file's owner.verifyMode
(String verifyMode) Specifies how and when DataSync checks the integrity of your data during a transfer.verifyMode
(VerifyMode verifyMode) Specifies how and when DataSync checks the integrity of your data during a transfer.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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
.- Parameters:
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
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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
.- Parameters:
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
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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
.- Parameters:
mtime
- Specifies whether to preserve metadata indicating the last time that a file was written to before thePREPARING
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
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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
.- Parameters:
mtime
- Specifies whether to preserve metadata indicating the last time that a file was written to before thePREPARING
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
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
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.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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
).- Parameters:
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 to1048576
(=1024*1024
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskQueueing
Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is
ENABLED
by default.- Parameters:
taskQueueing
- Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This isENABLED
by default.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskQueueing
Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is
ENABLED
by default.- Parameters:
taskQueueing
- Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This isENABLED
by default.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
securityDescriptorCopyFlags
Options.Builder securityDescriptorCopyFlags(SmbSecurityDescriptorCopyFlags 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
objectTags
- Specifies whether you want DataSync toPRESERVE
object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify theNONE
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.- Parameters:
objectTags
- Specifies whether you want DataSync toPRESERVE
object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify theNONE
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-