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

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

Returns:

  • (String) 


1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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


1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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

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

Returns:



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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

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

Returns:



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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


1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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

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

Returns:



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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

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

Returns:



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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


1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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

Returns:



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/aws-sdk-datasync/types.rb', line 1328

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