AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DataSync::Types::CreateTaskRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateTaskRequest as input to an Aws::Client method, you can use a vanilla 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
  },
  excludes: [
    {
      filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
      value: "FilterValue",
    },
  ],
  schedule: {
    schedule_expression: "ScheduleExpressionCron", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

CreateTaskRequest

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_log_group_arnString

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

Returns:

  • (String)

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

#destination_location_arnString

The Amazon Resource Name (ARN) of an AWS storage resource\'s location.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of an AWS storage resource\'s location.

#excludesArray<Types::FilterRule>

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

Returns:

  • (Array<Types::FilterRule>)

    A list of filter rules that determines which files to exclude from a task.

#nameString

The name of a task. This value is a text reference that is used to identify the task in the console.

Returns:

  • (String)

    The name of a task.

#optionsTypes::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 operation.

Returns:

  • (Types::Options)

    The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution.

#scheduleTypes::TaskSchedule

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 task-scheduling.

Returns:

  • (Types::TaskSchedule)

    Specifies a schedule used to periodically transfer files from a source to a destination location.

#source_location_arnString

The Amazon Resource Name (ARN) of the source location for the task.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the source location for the task.

#tagsArray<Types::TagListEntry>

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Returns:

  • (Array<Types::TagListEntry>)

    The key-value pair that represents the tag that you want to add to the resource.