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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-datasync/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

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end

#destination_location_arn ⇒ String

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end

#excludes ⇒ Array<Types::FilterRule>

Specifies a list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Returns:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end

#includes ⇒ Array<Types::FilterRule>

Specifies a list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

Returns:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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

Returns:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end

#options ⇒ Types::Options

Specifies the configuration options for a task. Some options include preserving file or object metadata and verifying data integrity.

You can also override these options before starting an individual run of a task (also known as a task execution). For more information, see StartTaskExecution.

Returns:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::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:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end

#source_location_arn ⇒ String

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

Returns:

  • (String) 


1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::TagListEntry>

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task.

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

Returns:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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

Returns:



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'gems/aws-sdk-datasync/lib/aws-sdk-datasync/types.rb', line 1360

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)
  SENSITIVE = []
  include Aws::Structure
end