class Aws::DataSync::Types::CreateTaskRequest

CreateTaskRequest

@note When making an API call, you may pass CreateTaskRequest

data as a hash:

    {
      source_location_arn: "LocationArn", # required
      destination_location_arn: "LocationArn", # required
      cloud_watch_log_group_arn: "LogGroupArn",
      name: "TagValue",
      options: {
        verify_mode: "POINT_IN_TIME_CONSISTENT", # accepts POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED, NONE
        overwrite_mode: "ALWAYS", # accepts ALWAYS, NEVER
        atime: "NONE", # accepts NONE, BEST_EFFORT
        mtime: "NONE", # accepts NONE, PRESERVE
        uid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
        gid: "NONE", # accepts NONE, INT_VALUE, NAME, BOTH
        preserve_deleted_files: "PRESERVE", # accepts PRESERVE, REMOVE
        preserve_devices: "NONE", # accepts NONE, PRESERVE
        posix_permissions: "NONE", # accepts NONE, PRESERVE
        bytes_per_second: 1,
        task_queueing: "ENABLED", # accepts ENABLED, DISABLED
        log_level: "OFF", # accepts OFF, BASIC, TRANSFER
        transfer_mode: "CHANGED", # accepts CHANGED, ALL
        security_descriptor_copy_flags: "NONE", # accepts NONE, OWNER_DACL, OWNER_DACL_SACL
      },
      excludes: [
        {
          filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
          value: "FilterValue",
        },
      ],
      schedule: {
        schedule_expression: "ScheduleExpressionCron", # required
      },
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue",
        },
      ],
      includes: [
        {
          filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
          value: "FilterValue",
        },
      ],
    }

@!attribute [rw] source_location_arn

The Amazon Resource Name (ARN) of the source location for the task.
@return [String]

@!attribute [rw] destination_location_arn

The Amazon Resource Name (ARN) of an Amazon Web Services storage
resource's location.
@return [String]

@!attribute [rw] cloud_watch_log_group_arn

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group
that is used to monitor and log events in the task.
@return [String]

@!attribute [rw] name

The name of a task. This value is a text reference that is used to
identify the task in the console.
@return [String]

@!attribute [rw] options

The set of configuration options that control the behavior of a
single execution of the task that occurs when you call
`StartTaskExecution`. You can configure these options to preserve
metadata such as user ID (UID) and group ID (GID), file permissions,
data integrity verification, and so on.

For each individual task execution, you can override these options
by specifying the `OverrideOptions` before starting the task
execution. For more information, see the [StartTaskExecution][1]
operation.

[1]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html
@return [Types::Options]

@!attribute [rw] excludes

A list of filter rules that determines which files to exclude from a
task. The list should contain a single filter string that consists
of the patterns to exclude. The patterns are delimited by "\|"
(that is, a pipe), for example, `"/folder1|/folder2"`.
@return [Array<Types::FilterRule>]

@!attribute [rw] schedule

Specifies a schedule used to periodically transfer files from a
source to a destination location. The schedule should be specified
in UTC time. For more information, see [Scheduling your task][1].

[1]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html
@return [Types::TaskSchedule]

@!attribute [rw] tags

The key-value pair that represents the tag that you want to add to
the resource. The value can be an empty string.
@return [Array<Types::TagListEntry>]

@!attribute [rw] includes

A list of filter rules that determines which files to include when
running a task. The pattern should contain a single filter string
that consists of the patterns to include. The patterns are delimited
by "\|" (that is, a pipe). For example: `"/folder1|/folder2`"
@return [Array<Types::FilterRule>]

@see docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTaskRequest AWS API Documentation

Constants

SENSITIVE