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

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

Overview

UpdateTaskResponse

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 must use ‘/aws/datasync` as your log group name. For example:

‘arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*`

For more information, see [Monitoring data transfers with CloudWatch Logs].

[1]: docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html

Returns:

  • (String) 


6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes,
  :manifest_config,
  :task_report_config)
  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:



6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

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

#includes ⇒ Array<Types::FilterRule>

Specifies include filters 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:



6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :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 IAM role that you’re using DataSync with) must have the ‘iam:PassRole` permission. The [AWSDataSyncFullAccess] policy includes this permission.

To remove a manifest configuration, specify this parameter as empty.

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



6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

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

#name ⇒ String

Specifies the name of your task.

Returns:

  • (String) 


6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

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

#options ⇒ Types::Options

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

Each option has a default value. Unless you need to, you don’t have to configure any option before calling [StartTaskExecution].

You also can override your task options for each task execution. For example, you might want to adjust the ‘LogLevel` for an individual execution.

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

Returns:



6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :includes,
  :manifest_config,
  :task_report_config)
  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:



6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

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

#task_arn ⇒ String

Specifies the ARN of the task that you want to update.

Returns:

  • (String) 


6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

class UpdateTaskRequest < Struct.new(
  :task_arn,
  :options,
  :excludes,
  :schedule,
  :name,
  :cloud_watch_log_group_arn,
  :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 IAM role that you’re using DataSync with) must have the ‘iam:PassRole` permission. The [AWSDataSyncFullAccess] policy includes this permission.

To remove a task report configuration, specify this parameter as empty.

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



6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
 
# File 'lib/aws-sdk-datasync/types.rb', line 6677

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