Class: Aws::DataSync::Types::UpdateTaskRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb

Overview

Note:

When making an API call, you may pass UpdateTaskRequest data as a hash:

{
  task_arn: "TaskArn", # required
  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
  },
  name: "TagValue",
  cloud_watch_log_group_arn: "LogGroupArn",
  includes: [
    {
      filter_type: "SIMPLE_PATTERN", # accepts SIMPLE_PATTERN
      value: "FilterValue",
    },
  ],
}

UpdateTaskResponse

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_log_group_arnString

The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.

Returns:

  • (String)


3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3608

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

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



3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3608

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#includesArray<Types::FilterRule>

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"

Returns:



3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3608

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the task to update.

Returns:

  • (String)


3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3608

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#optionsTypes::Options

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also 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 defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

Returns:



3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3608

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#scheduleTypes::TaskSchedule

Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see Scheduling your task.

Returns:



3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3608

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#task_arnString

The Amazon Resource Name (ARN) of the resource name of the task to update.

Returns:

  • (String)


3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 3608

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end