Package software.amazon.awssdk.services.datasync.model

Class Options

java.lang.Object
software.amazon.awssdk.services.datasync.model.Options
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Options.Builder,Options>
@Generated("software.amazon.awssdk:codegen") public final class Options extends Object implements SdkPojo, Serializable, 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

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    Options.Builder
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final Atime
    atime()
    Specifies whether to preserve metadata indicating the last time a file was read or written to.
    final String
    atimeAsString()
    Specifies whether to preserve metadata indicating the last time a file was read or written to.
    static Options.Builder
    builder()
     
    final Long
    bytesPerSecond()
    Limits the bandwidth used by a DataSync task.
    final boolean
    equals(Object obj)
     
    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
    gidAsString()
    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
    logLevelAsString()
    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 the PREPARING phase of your task execution.
    final String
    mtimeAsString()
    Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING phase of your task execution.
    final ObjectTags
    objectTags()
    Specifies whether object tags are preserved when transferring between object storage systems.
    final String
    objectTagsAsString()
    Specifies whether object tags are preserved when transferring between object storage systems.
    final OverwriteMode
    overwriteMode()
    Specifies whether data at the destination location should be overwritten or preserved.
    final String
    overwriteModeAsString()
    Specifies whether data at the destination location should be overwritten or preserved.
    final PosixPermissions
    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
    posixPermissionsAsString()
    Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.
    final PreserveDeletedFiles
    preserveDeletedFiles()
    Specifies whether files in the destination location that don't exist in the source should be preserved.
    final String
    preserveDeletedFilesAsString()
    Specifies whether files in the destination location that don't exist in the source should be preserved.
    final 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.
    final String
    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.
    final List<SdkField<?>>
    sdkFields()
     
    final SmbSecurityDescriptorCopyFlags
    securityDescriptorCopyFlags()
    Specifies which components of the SMB security descriptor are copied from source to destination objects.
    final String
    securityDescriptorCopyFlagsAsString()
    Specifies which components of the SMB security descriptor are copied from source to destination objects.
    static Class<? extends Options.Builder>
    serializableBuilderClass()
     
    final TaskQueueing
    taskQueueing()
    Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks.
    final String
    taskQueueingAsString()
    Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks.
    Options.Builder
    toBuilder()
    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
    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
    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).
    final Uid
    uid()
    Specifies the POSIX user ID (UID) of the file's owner.
    final String
    uidAsString()
    Specifies the POSIX user ID (UID) of the file's owner.
    final VerifyMode
    verifyMode()
    Specifies how and when DataSync checks the integrity of your data during a transfer.
    final String
    verifyModeAsString()
    Specifies how and when DataSync checks the integrity of your data during a transfer.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

    copy

  • Method Details

    • verifyMode

      public final VerifyMode verifyMode()

      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.

      If the service returns an enum value that is not available in the current SDK version, verifyMode will return VerifyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verifyModeAsString().

      Returns:
      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.

      See Also:

    • verifyModeAsString

      public final String verifyModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, verifyMode will return VerifyMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verifyModeAsString().

      Returns:
      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.

      See Also:

    • overwriteMode

      public final OverwriteMode 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.

      If the service returns an enum value that is not available in the current SDK version, overwriteMode will return OverwriteMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from overwriteModeAsString().

      Returns:
      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.

      See Also:

    • overwriteModeAsString

      public final String overwriteModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, overwriteMode will return OverwriteMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from overwriteModeAsString().

      Returns:
      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.

      See Also:

    • atime

      public final Atime atime()

      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.

      If the service returns an enum value that is not available in the current SDK version, atime will return Atime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from atimeAsString().

      Returns:
      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.

      See Also:

    • atimeAsString

      public final String atimeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, atime will return Atime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from atimeAsString().

      Returns:
      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.

      See Also:

    • mtime

      public final Mtime 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.

      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.

      If the service returns an enum value that is not available in the current SDK version, mtime will return Mtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mtimeAsString().

      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.

      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.

      See Also:

    • mtimeAsString

      public final String 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.

      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.

      If the service returns an enum value that is not available in the current SDK version, mtime will return Mtime.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mtimeAsString().

      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.

      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.

      See Also:

    • uid

      public final Uid uid()

      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.

      If the service returns an enum value that is not available in the current SDK version, uid will return Uid.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uidAsString().

      Returns:
      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.

      See Also:

    • uidAsString

      public final String uidAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, uid will return Uid.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from uidAsString().

      Returns:
      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.

      See Also:

    • gid

      public final Gid 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.

      If the service returns an enum value that is not available in the current SDK version, gid will return Gid.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gidAsString().

      Returns:
      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.

      See Also:

    • gidAsString

      public final String gidAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, gid will return Gid.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gidAsString().

      Returns:
      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.

      See Also:

    • preserveDeletedFiles

      public final PreserveDeletedFiles 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.

      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.

      If the service returns an enum value that is not available in the current SDK version, preserveDeletedFiles will return PreserveDeletedFiles.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preserveDeletedFilesAsString().

      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.

      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.

      See Also:

    • preserveDeletedFilesAsString

      public final String 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.

      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.

      If the service returns an enum value that is not available in the current SDK version, preserveDeletedFiles will return PreserveDeletedFiles.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preserveDeletedFilesAsString().

      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.

      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.

      See Also:

    • preserveDevices

      public final 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. 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.

      If the service returns an enum value that is not available in the current SDK version, preserveDevices will return PreserveDevices.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preserveDevicesAsString().

      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.

      Default value: NONE

      NONE: Ignore special devices (recommended).

      PRESERVE: Preserve character and block device metadata. This option currently isn't supported for Amazon EFS.

      See Also:

    • preserveDevicesAsString

      public final String 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.

      Default value: NONE

      NONE: Ignore special devices (recommended).

      PRESERVE: Preserve 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 return PreserveDevices.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from preserveDevicesAsString().

      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.

      Default value: NONE

      NONE: Ignore special devices (recommended).

      PRESERVE: Preserve character and block device metadata. This option currently isn't supported for Amazon EFS.

      See Also:

    • posixPermissions

      public final PosixPermissions 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.

      If the service returns an enum value that is not available in the current SDK version, posixPermissions will return PosixPermissions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from posixPermissionsAsString().

      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.

      Default value: PRESERVE

      PRESERVE: Preserve POSIX-style permissions (recommended).

      NONE: Ignore permissions.

      DataSync can preserve extant permissions of a source location.

      See Also:

    • posixPermissionsAsString

      public final String 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.

      Default value: PRESERVE

      PRESERVE: Preserve POSIX-style permissions (recommended).

      NONE: Ignore 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 return PosixPermissions.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from posixPermissionsAsString().

      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.

      Default value: PRESERVE

      PRESERVE: Preserve POSIX-style permissions (recommended).

      NONE: Ignore permissions.

      DataSync can preserve extant permissions of a source location.

      See Also:

    • bytesPerSecond

      public final Long 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

      public final TaskQueueing 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 return TaskQueueing.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskQueueingAsString().

      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

      public final String 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 return TaskQueueing.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from taskQueueingAsString().

      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

      public final LogLevel logLevel()

      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.

      If the service returns an enum value that is not available in the current SDK version, logLevel will return LogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logLevelAsString().

      Returns:
      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.

      See Also:

    • logLevelAsString

      public final String logLevelAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, logLevel will return LogLevel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from logLevelAsString().

      Returns:
      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.

      See Also:

    • transferMode

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

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

      If the service returns an enum value that is not available in the current SDK version, transferMode will return TransferMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transferModeAsString().

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

      See Also:

    • transferModeAsString

      public final String 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: 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).

      If the service returns an enum value that is not available in the current SDK version, transferMode will return TransferMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from transferModeAsString().

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

      See Also:

    • securityDescriptorCopyFlags

      public final 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.

      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.

      If the service returns an enum value that is not available in the current SDK version, securityDescriptorCopyFlags will return SmbSecurityDescriptorCopyFlags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityDescriptorCopyFlagsAsString().

      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.

      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.

      See Also:

    • securityDescriptorCopyFlagsAsString

      public final String 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.

      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.

      If the service returns an enum value that is not available in the current SDK version, securityDescriptorCopyFlags will return SmbSecurityDescriptorCopyFlags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from securityDescriptorCopyFlagsAsString().

      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.

      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.

      See Also:

    • objectTags

      public final ObjectTags objectTags()

      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

      If the service returns an enum value that is not available in the current SDK version, objectTags will return ObjectTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectTagsAsString().

      Returns:
      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

      See Also:

    • objectTagsAsString

      public final String objectTagsAsString()

      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

      If the service returns an enum value that is not available in the current SDK version, objectTags will return ObjectTags.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectTagsAsString().

      Returns:
      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

      See Also:

    • toBuilder

      public Options.Builder 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 interface ToCopyableBuilder<Options.Builder,Options>
      Returns:
      a builder for type T

    • builder

      public static Options.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Options.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.