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

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

Overview

CreateTaskRequest

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_log_group_arn ⇒ String

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you don’t need to specify anything. DataSync automatically sends logs to a CloudWatch log group named ‘/aws/datasync`.

Returns:

  • (String) 


1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#destination_location_arn ⇒ String

Specifies the ARN of your transfer’s destination location.

Returns:

  • (String) 


1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#excludes ⇒ Array<Types::FilterRule>

Specifies exclude filters that define the files, objects, and folders in your source location that you don’t want DataSync to transfer. For more information and examples, see [Specifying what DataSync transfers by using filters].

[1]: docs.aws.amazon.com/datasync/latest/userguide/filtering.html

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#includes ⇒ Array<Types::FilterRule>

Specifies include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see [Specifying what DataSync transfers by using filters].

[1]: docs.aws.amazon.com/datasync/latest/userguide/filtering.html

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#manifest_config ⇒ Types::ManifestConfig

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest].

When using this parameter, your caller identity (the role that you’re using DataSync with) must have the ‘iam:PassRole` permission. The [AWSDataSyncFullAccess] policy includes this permission.

[1]: docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html [2]: docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#name ⇒ String

Specifies the name of your task.

Returns:

  • (String) 


1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#options ⇒ Types::Options

Specifies your task’s settings, such as preserving file metadata, verifying data integrity, among other options.

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#schedule ⇒ Types::TaskSchedule

Specifies a schedule for when you want your task to run. For more information, see [Scheduling your task].

[1]: docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#source_location_arn ⇒ String

Specifies the ARN of your transfer’s source location.

Returns:

  • (String) 


1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#tags ⇒ Array<Types::TagListEntry>

Specifies the tags that you want to apply to your task.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#task_mode ⇒ String

Specifies one of the following task modes for your data transfer:

  • ‘ENHANCED` - Transfer virtually unlimited numbers of objects with higher performance than Basic mode. Enhanced mode tasks optimize the data transfer process by listing, preparing, transferring, and verifying data in parallel. Enhanced mode is currently available for transfers between Amazon S3 locations.

    <note markdown=“1”> To create an Enhanced mode task, the IAM role that you use to call the ‘CreateTask` operation must have the `iam:CreateServiceLinkedRole` permission.

    </note>

  • ‘BASIC` (default) - Transfer files or objects between Amazon Web Services storage and all other supported DataSync locations. Basic mode tasks are subject to [quotas] on the number of files, objects, and directories in a dataset. Basic mode sequentially prepares, transfers, and verifies data, making it slower than Enhanced mode for most workloads.

For more information, see [Understanding task mode differences].

[1]: docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html [2]: docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences

Returns:

  • (String) 


1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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

#task_report_config ⇒ Types::TaskReportConfig

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports].

When using this parameter, your caller identity (the role that you’re using DataSync with) must have the ‘iam:PassRole` permission. The [AWSDataSyncFullAccess] policy includes this permission.

[1]: docs.aws.amazon.com/datasync/latest/userguide/task-reports.html [2]: docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess

Returns:



1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
 
# File 'lib/aws-sdk-datasync/types.rb', line 1413

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