Package software.amazon.awscdk.services.datasync

Interface CfnTask.OptionsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnTask.OptionsProperty.Jsii$Proxy
Enclosing class:
CfnTask
@Stability(Stable) public static interface CfnTask.OptionsProperty extends software.amazon.jsii.JsiiSerializable
Represents the options that are available to control the behavior of a StartTaskExecution operation. This behavior includes preserving metadata, such as user ID (UID), group ID (GID), and file permissions; overwriting files in the destination; data integrity verification; and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution , the default value is used. You can override the default options on each task execution by specifying an overriding Options value to StartTaskExecution .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 OptionsProperty optionsProperty = OptionsProperty.builder()
         .atime("atime")
         .bytesPerSecond(123)
         .gid("gid")
         .logLevel("logLevel")
         .mtime("mtime")
         .objectTags("objectTags")
         .overwriteMode("overwriteMode")
         .posixPermissions("posixPermissions")
         .preserveDeletedFiles("preserveDeletedFiles")
         .preserveDevices("preserveDevices")
         .securityDescriptorCopyFlags("securityDescriptorCopyFlags")
         .taskQueueing("taskQueueing")
         .transferMode("transferMode")
         .uid("uid")
         .verifyMode("verifyMode")
         .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    CfnTask.OptionsProperty.Builder
    A builder for CfnTask.OptionsProperty
    static final class 
    CfnTask.OptionsProperty.Jsii$Proxy
    An implementation for CfnTask.OptionsProperty

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnTask.OptionsProperty.Builder
    builder()
     
    default String
    getAtime()
    A file metadata value that shows the last time that a file was accessed (that is, when the file was read or written to).
    default Number
    getBytesPerSecond()
    A value that limits the bandwidth used by AWS DataSync .
    default String
    getGid()
    The group ID (GID) of the file's owners.
    default String
    getLogLevel()
    Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group.
    default String
    getMtime()
    A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
    default String
    getObjectTags()
    Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems.
    default String
    getOverwriteMode()
    Specifies whether DataSync should modify or preserve data at the destination location.
    default String
    getPosixPermissions()
    A value that determines which users or groups can access a file for a specific purpose, such as reading, writing, or execution of the file.
    default String
    getPreserveDeletedFiles()
    A value that specifies whether files in the destination that don't exist in the source file system are preserved.
    default String
    getPreserveDevices()
    A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination.
    default String
    getSecurityDescriptorCopyFlags()
    A value that determines which components of the SMB security descriptor are copied from source to destination objects.
    default String
    getTaskQueueing()
    Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks .
    default String
    getTransferMode()
    A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing it to the destination location.
    default String
    getUid()
    The user ID (UID) of the file's owner.
    default String
    getVerifyMode()
    A value that determines whether a data integrity verification is performed at the end of a task execution after all data and metadata have been transferred.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson