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

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 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",
    },
  ],
}

CreateTaskRequest

Constant Summary collapse

SENSITIVE =
[]

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)


940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#destination_location_arnString

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

Returns:

  • (String)


940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :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:



940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :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:



940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#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 StartTaskExecution operation.

Returns:



940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#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 Scheduling your task.

Returns:



940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

#source_location_arnString

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

Returns:

  • (String)


940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end

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



940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 940

class CreateTaskRequest < Struct.new(
  :source_location_arn,
  :destination_location_arn,
  :cloud_watch_log_group_arn,
  :name,
  :options,
  :excludes,
  :schedule,
  :tags,
  :includes)
  SENSITIVE = []
  include Aws::Structure
end