tasks

Creates, updates, deletes or gets a task resource or lists tasks in a region

Overview

Name	tasks
Type	Resource
Description	Resource schema for AWS::DataSync::Task.
Id	awscc.datasync.tasks

Fields

get (all properties)

Name	Datatype	Description
▶excludes	array
includes	array
▶tags	array	An array of key-value pairs to apply to this resource.
cloud_watch_log_group_arn	string	The ARN of the Amazon CloudWatch log group that is used to monitor and log events in the task.
destination_location_arn	string	The ARN of an AWS storage resource's location.
name	string	The name of a task. This value is a text reference that is used to identify the task in the console.
▶options	object	Represents the options that are available to control the behavior of a StartTaskExecution operation.
▶task_report_config	object	Specifies how you want to configure a task report, which provides detailed information about for your Datasync transfer.
▶manifest_config	object	Configures a manifest, which is a list of files or objects that you want DataSync to transfer.
▶schedule	object	Specifies the schedule you want your task to use for repeated executions.
source_location_arn	string	The ARN of the source location for the task.
task_arn	string	The ARN of the task.
task_mode	string	Specifies the task mode for the task.
status	string	The status of the task that was described.
source_network_interface_arns	array	The Amazon Resource Names (ARNs) of the source ENIs (Elastic Network Interfaces) that were created for your subnet.
destination_network_interface_arns	array	The Amazon Resource Names (ARNs) of the destination ENIs (Elastic Network Interfaces) that were created for your subnet.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
task_arn	string	The ARN of the task.
region	string	AWS region.

For more information, see AWS::DataSync::Task.

Methods

Name	Resource	Accessible by	Required Params
create_resource	tasks	INSERT	DestinationLocationArn, SourceLocationArn, region
delete_resource	tasks	DELETE	Identifier, region
update_resource	tasks	UPDATE	Identifier, PatchDocument, region
list_resources	tasks_list_only	SELECT	region
get_resource	tasks	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual task.

SELECT
  region,
  excludes,
  includes,
  tags,
  cloud_watch_log_group_arn,
  destination_location_arn,
  name,
  options,
  task_report_config,
  manifest_config,
  schedule,
  source_location_arn,
  task_arn,
  task_mode,
  status,
  source_network_interface_arns,
  destination_network_interface_arns
FROM awscc.datasync.tasks
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ task_arn }}';

list (identifiers only)

Lists all tasks in a region.

SELECT
  region,
  task_arn
FROM awscc.datasync.tasks_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new task resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.datasync.tasks (
  DestinationLocationArn,
  SourceLocationArn,
  region
)
SELECT
  '{{ destination_location_arn }}',
  '{{ source_location_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.datasync.tasks (
  Excludes,
  Includes,
  Tags,
  CloudWatchLogGroupArn,
  DestinationLocationArn,
  Name,
  Options,
  TaskReportConfig,
  ManifestConfig,
  Schedule,
  SourceLocationArn,
  TaskMode,
  region
)
SELECT
  '{{ excludes }}',
  '{{ includes }}',
  '{{ tags }}',
  '{{ cloud_watch_log_group_arn }}',
  '{{ destination_location_arn }}',
  '{{ name }}',
  '{{ options }}',
  '{{ task_report_config }}',
  '{{ manifest_config }}',
  '{{ schedule }}',
  '{{ source_location_arn }}',
  '{{ task_mode }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: task
    props:
      - name: excludes
        value:
          - filter_type: '{{ filter_type }}'
            value: '{{ value }}'
      - name: includes
        value:
          - null
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'
      - name: cloud_watch_log_group_arn
        value: '{{ cloud_watch_log_group_arn }}'
      - name: destination_location_arn
        value: '{{ destination_location_arn }}'
      - name: name
        value: '{{ name }}'
      - name: options
        value:
          atime: '{{ atime }}'
          bytes_per_second: '{{ bytes_per_second }}'
          gid: '{{ gid }}'
          log_level: '{{ log_level }}'
          mtime: '{{ mtime }}'
          overwrite_mode: '{{ overwrite_mode }}'
          posix_permissions: '{{ posix_permissions }}'
          preserve_deleted_files: '{{ preserve_deleted_files }}'
          preserve_devices: '{{ preserve_devices }}'
          security_descriptor_copy_flags: '{{ security_descriptor_copy_flags }}'
          task_queueing: '{{ task_queueing }}'
          transfer_mode: '{{ transfer_mode }}'
          uid: '{{ uid }}'
          verify_mode: '{{ verify_mode }}'
          object_tags: '{{ object_tags }}'
      - name: task_report_config
        value:
          destination:
            s3:
              subdirectory: '{{ subdirectory }}'
              bucket_access_role_arn: '{{ bucket_access_role_arn }}'
              s3_bucket_arn: '{{ s3_bucket_arn }}'
          output_type: '{{ output_type }}'
          report_level: '{{ report_level }}'
          object_version_ids: '{{ object_version_ids }}'
          overrides:
            transferred:
              report_level: '{{ report_level }}'
            verified:
              report_level: '{{ report_level }}'
            deleted:
              report_level: '{{ report_level }}'
            skipped:
              report_level: '{{ report_level }}'
      - name: manifest_config
        value:
          action: '{{ action }}'
          format: '{{ format }}'
          source:
            s3:
              manifest_object_path: '{{ manifest_object_path }}'
              bucket_access_role_arn: '{{ bucket_access_role_arn }}'
              s3_bucket_arn: '{{ s3_bucket_arn }}'
              manifest_object_version_id: '{{ manifest_object_version_id }}'
      - name: schedule
        value:
          schedule_expression: '{{ schedule_expression }}'
          status: '{{ status }}'
      - name: source_location_arn
        value: '{{ source_location_arn }}'
      - name: task_mode
        value: '{{ task_mode }}'

UPDATE example

Use the following StackQL query and manifest file to update a task resource, using stack-deploy.

/*+ update */
UPDATE awscc.datasync.tasks
SET PatchDocument = string('{{ {
    "Excludes": excludes,
    "Includes": includes,
    "Tags": tags,
    "CloudWatchLogGroupArn": cloud_watch_log_group_arn,
    "Name": name,
    "Options": options,
    "TaskReportConfig": task_report_config,
    "ManifestConfig": manifest_config,
    "Schedule": schedule
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ task_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.datasync.tasks
WHERE
  Identifier = '{{ task_arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the tasks resource, the following permissions are required:

Create

datasync:CreateTask,
datasync:DescribeTask,
datasync:ListTagsForResource,
datasync:TagResource,
s3:ListAllMyBuckets,
s3:ListBucket,
s3:GetObject,
s3:GetObjectVersion,
ec2:DescribeNetworkInterfaces,
ec2:CreateNetworkInterface,
ec2:DeleteNetworkInterface,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
ec2:CreateNetworkInterfacePermission,
fsx:DescribeFileSystems,
elasticfilesystem:DescribeFileSystems,
elasticfilesystem:DescribeMountTargets,
logs:DescribeLogGroups,
iam:GetRole,
iam:PassRole,
iam:AssumeRole

Read

datasync:DescribeTask,
datasync:ListTagsForResource

Update

datasync:UpdateTask,
datasync:DescribeTask,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource,
logs:DescribeLogGroups,
iam:PassRole

Delete

datasync:DeleteTask,
ec2:DescribeNetworkInterfaces,
ec2:DeleteNetworkInterface,
ec2:DescribeSecurityGroups,
ec2:DescribeSubnets,
fsx:DescribeFileSystems,
elasticfilesystem:DescribeFileSystems,
elasticfilesystem:DescribeMountTargets,
iam:GetRole

List

datasync:ListTasks