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

The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.

Returns:

  • (String) 


6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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



6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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



6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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:



6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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

The name of the task to update.

Returns:

  • (String) 


6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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 of these options before starting your task.

Returns:



6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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 used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see [Scheduling your task].

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

Returns:



6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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

The Amazon Resource Name (ARN) of the resource name of the task to update.

Returns:

  • (String) 


6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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:



6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
 
# File 'lib/aws-sdk-datasync/types.rb', line 6141

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