Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. datasync
  5. Task
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.datasync.Task

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Manages an AWS DataSync Task, which represents a configuration for synchronization. Starting an execution of these DataSync Tasks (actually synchronizing files) is performed outside of this resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.datasync.Task("example", {
    destinationLocationArn: destination.arn,
    name: "example",
    sourceLocationArn: source.arn,
    options: {
        bytesPerSecond: -1,
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.datasync.Task("example",
    destination_location_arn=destination["arn"],
    name="example",
    source_location_arn=source["arn"],
    options={
        "bytes_per_second": -1,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewTask(ctx, "example", &datasync.TaskArgs{
			DestinationLocationArn: pulumi.Any(destination.Arn),
			Name:                   pulumi.String("example"),
			SourceLocationArn:      pulumi.Any(source.Arn),
			Options: &datasync.TaskOptionsArgs{
				BytesPerSecond: pulumi.Int(-1),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DataSync.Task("example", new()
    {
        DestinationLocationArn = destination.Arn,
        Name = "example",
        SourceLocationArn = source.Arn,
        Options = new Aws.DataSync.Inputs.TaskOptionsArgs
        {
            BytesPerSecond = -1,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.Task;
import com.pulumi.aws.datasync.TaskArgs;
import com.pulumi.aws.datasync.inputs.TaskOptionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Task("example", TaskArgs.builder()
            .destinationLocationArn(destination.arn())
            .name("example")
            .sourceLocationArn(source.arn())
            .options(TaskOptionsArgs.builder()
                .bytesPerSecond(-1)
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:datasync:Task
    properties:
      destinationLocationArn: ${destination.arn}
      name: example
      sourceLocationArn: ${source.arn}
      options:
        bytesPerSecond: -1
Copy

With Scheduling

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.datasync.Task("example", {
    destinationLocationArn: destination.arn,
    name: "example",
    sourceLocationArn: source.arn,
    schedule: {
        scheduleExpression: "cron(0 12 ? * SUN,WED *)",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.datasync.Task("example",
    destination_location_arn=destination["arn"],
    name="example",
    source_location_arn=source["arn"],
    schedule={
        "schedule_expression": "cron(0 12 ? * SUN,WED *)",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewTask(ctx, "example", &datasync.TaskArgs{
			DestinationLocationArn: pulumi.Any(destination.Arn),
			Name:                   pulumi.String("example"),
			SourceLocationArn:      pulumi.Any(source.Arn),
			Schedule: &datasync.TaskScheduleArgs{
				ScheduleExpression: pulumi.String("cron(0 12 ? * SUN,WED *)"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DataSync.Task("example", new()
    {
        DestinationLocationArn = destination.Arn,
        Name = "example",
        SourceLocationArn = source.Arn,
        Schedule = new Aws.DataSync.Inputs.TaskScheduleArgs
        {
            ScheduleExpression = "cron(0 12 ? * SUN,WED *)",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.Task;
import com.pulumi.aws.datasync.TaskArgs;
import com.pulumi.aws.datasync.inputs.TaskScheduleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Task("example", TaskArgs.builder()
            .destinationLocationArn(destination.arn())
            .name("example")
            .sourceLocationArn(source.arn())
            .schedule(TaskScheduleArgs.builder()
                .scheduleExpression("cron(0 12 ? * SUN,WED *)")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:datasync:Task
    properties:
      destinationLocationArn: ${destination.arn}
      name: example
      sourceLocationArn: ${source.arn}
      schedule:
        scheduleExpression: cron(0 12 ? * SUN,WED *)
Copy

With Filtering

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.datasync.Task("example", {
    destinationLocationArn: destination.arn,
    name: "example",
    sourceLocationArn: source.arn,
    excludes: {
        filterType: "SIMPLE_PATTERN",
        value: "/folder1|/folder2",
    },
    includes: {
        filterType: "SIMPLE_PATTERN",
        value: "/folder1|/folder2",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.datasync.Task("example",
    destination_location_arn=destination["arn"],
    name="example",
    source_location_arn=source["arn"],
    excludes={
        "filter_type": "SIMPLE_PATTERN",
        "value": "/folder1|/folder2",
    },
    includes={
        "filter_type": "SIMPLE_PATTERN",
        "value": "/folder1|/folder2",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewTask(ctx, "example", &datasync.TaskArgs{
			DestinationLocationArn: pulumi.Any(destination.Arn),
			Name:                   pulumi.String("example"),
			SourceLocationArn:      pulumi.Any(source.Arn),
			Excludes: &datasync.TaskExcludesArgs{
				FilterType: pulumi.String("SIMPLE_PATTERN"),
				Value:      pulumi.String("/folder1|/folder2"),
			},
			Includes: &datasync.TaskIncludesArgs{
				FilterType: pulumi.String("SIMPLE_PATTERN"),
				Value:      pulumi.String("/folder1|/folder2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DataSync.Task("example", new()
    {
        DestinationLocationArn = destination.Arn,
        Name = "example",
        SourceLocationArn = source.Arn,
        Excludes = new Aws.DataSync.Inputs.TaskExcludesArgs
        {
            FilterType = "SIMPLE_PATTERN",
            Value = "/folder1|/folder2",
        },
        Includes = new Aws.DataSync.Inputs.TaskIncludesArgs
        {
            FilterType = "SIMPLE_PATTERN",
            Value = "/folder1|/folder2",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.Task;
import com.pulumi.aws.datasync.TaskArgs;
import com.pulumi.aws.datasync.inputs.TaskExcludesArgs;
import com.pulumi.aws.datasync.inputs.TaskIncludesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Task("example", TaskArgs.builder()
            .destinationLocationArn(destination.arn())
            .name("example")
            .sourceLocationArn(source.arn())
            .excludes(TaskExcludesArgs.builder()
                .filterType("SIMPLE_PATTERN")
                .value("/folder1|/folder2")
                .build())
            .includes(TaskIncludesArgs.builder()
                .filterType("SIMPLE_PATTERN")
                .value("/folder1|/folder2")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:datasync:Task
    properties:
      destinationLocationArn: ${destination.arn}
      name: example
      sourceLocationArn: ${source.arn}
      excludes:
        filterType: SIMPLE_PATTERN
        value: /folder1|/folder2
      includes:
        filterType: SIMPLE_PATTERN
        value: /folder1|/folder2
Copy

With Enhanced Task Mode

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.datasync.Task("example", {
    destinationLocationArn: destination.arn,
    name: "example",
    sourceLocationArn: source.arn,
    taskMode: "ENHANCED",
    options: {
        gid: "NONE",
        posixPermissions: "NONE",
        uid: "NONE",
        verifyMode: "ONLY_FILES_TRANSFERRED",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.datasync.Task("example",
    destination_location_arn=destination["arn"],
    name="example",
    source_location_arn=source["arn"],
    task_mode="ENHANCED",
    options={
        "gid": "NONE",
        "posix_permissions": "NONE",
        "uid": "NONE",
        "verify_mode": "ONLY_FILES_TRANSFERRED",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewTask(ctx, "example", &datasync.TaskArgs{
			DestinationLocationArn: pulumi.Any(destination.Arn),
			Name:                   pulumi.String("example"),
			SourceLocationArn:      pulumi.Any(source.Arn),
			TaskMode:               pulumi.String("ENHANCED"),
			Options: &datasync.TaskOptionsArgs{
				Gid:              pulumi.String("NONE"),
				PosixPermissions: pulumi.String("NONE"),
				Uid:              pulumi.String("NONE"),
				VerifyMode:       pulumi.String("ONLY_FILES_TRANSFERRED"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DataSync.Task("example", new()
    {
        DestinationLocationArn = destination.Arn,
        Name = "example",
        SourceLocationArn = source.Arn,
        TaskMode = "ENHANCED",
        Options = new Aws.DataSync.Inputs.TaskOptionsArgs
        {
            Gid = "NONE",
            PosixPermissions = "NONE",
            Uid = "NONE",
            VerifyMode = "ONLY_FILES_TRANSFERRED",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.Task;
import com.pulumi.aws.datasync.TaskArgs;
import com.pulumi.aws.datasync.inputs.TaskOptionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Task("example", TaskArgs.builder()
            .destinationLocationArn(destination.arn())
            .name("example")
            .sourceLocationArn(source.arn())
            .taskMode("ENHANCED")
            .options(TaskOptionsArgs.builder()
                .gid("NONE")
                .posixPermissions("NONE")
                .uid("NONE")
                .verifyMode("ONLY_FILES_TRANSFERRED")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:datasync:Task
    properties:
      destinationLocationArn: ${destination.arn}
      name: example
      sourceLocationArn: ${source.arn}
      taskMode: ENHANCED
      options:
        gid: NONE
        posixPermissions: NONE
        uid: NONE
        verifyMode: ONLY_FILES_TRANSFERRED
Copy

Create Task Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Task(name: string, args: TaskArgs, opts?: CustomResourceOptions);
@overload
def Task(resource_name: str,
         args: TaskArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Task(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         destination_location_arn: Optional[str] = None,
         source_location_arn: Optional[str] = None,
         cloudwatch_log_group_arn: Optional[str] = None,
         excludes: Optional[TaskExcludesArgs] = None,
         includes: Optional[TaskIncludesArgs] = None,
         name: Optional[str] = None,
         options: Optional[TaskOptionsArgs] = None,
         schedule: Optional[TaskScheduleArgs] = None,
         tags: Optional[Mapping[str, str]] = None,
         task_mode: Optional[str] = None,
         task_report_config: Optional[TaskTaskReportConfigArgs] = None)
func NewTask(ctx *Context, name string, args TaskArgs, opts ...ResourceOption) (*Task, error)
public Task(string name, TaskArgs args, CustomResourceOptions? opts = null)
public Task(String name, TaskArgs args)
public Task(String name, TaskArgs args, CustomResourceOptions options)

type: aws:datasync:Task
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TaskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TaskArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TaskArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TaskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TaskArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var taskResource = new Aws.DataSync.Task("taskResource", new()
{
    DestinationLocationArn = "string",
    SourceLocationArn = "string",
    CloudwatchLogGroupArn = "string",
    Excludes = new Aws.DataSync.Inputs.TaskExcludesArgs
    {
        FilterType = "string",
        Value = "string",
    },
    Includes = new Aws.DataSync.Inputs.TaskIncludesArgs
    {
        FilterType = "string",
        Value = "string",
    },
    Name = "string",
    Options = new Aws.DataSync.Inputs.TaskOptionsArgs
    {
        Atime = "string",
        BytesPerSecond = 0,
        Gid = "string",
        LogLevel = "string",
        Mtime = "string",
        ObjectTags = "string",
        OverwriteMode = "string",
        PosixPermissions = "string",
        PreserveDeletedFiles = "string",
        PreserveDevices = "string",
        SecurityDescriptorCopyFlags = "string",
        TaskQueueing = "string",
        TransferMode = "string",
        Uid = "string",
        VerifyMode = "string",
    },
    Schedule = new Aws.DataSync.Inputs.TaskScheduleArgs
    {
        ScheduleExpression = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    TaskMode = "string",
    TaskReportConfig = new Aws.DataSync.Inputs.TaskTaskReportConfigArgs
    {
        S3Destination = new Aws.DataSync.Inputs.TaskTaskReportConfigS3DestinationArgs
        {
            BucketAccessRoleArn = "string",
            S3BucketArn = "string",
            Subdirectory = "string",
        },
        OutputType = "string",
        ReportLevel = "string",
        ReportOverrides = new Aws.DataSync.Inputs.TaskTaskReportConfigReportOverridesArgs
        {
            DeletedOverride = "string",
            SkippedOverride = "string",
            TransferredOverride = "string",
            VerifiedOverride = "string",
        },
        S3ObjectVersioning = "string",
    },
});
Copy
example, err := datasync.NewTask(ctx, "taskResource", &datasync.TaskArgs{
	DestinationLocationArn: pulumi.String("string"),
	SourceLocationArn:      pulumi.String("string"),
	CloudwatchLogGroupArn:  pulumi.String("string"),
	Excludes: &datasync.TaskExcludesArgs{
		FilterType: pulumi.String("string"),
		Value:      pulumi.String("string"),
	},
	Includes: &datasync.TaskIncludesArgs{
		FilterType: pulumi.String("string"),
		Value:      pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Options: &datasync.TaskOptionsArgs{
		Atime:                       pulumi.String("string"),
		BytesPerSecond:              pulumi.Int(0),
		Gid:                         pulumi.String("string"),
		LogLevel:                    pulumi.String("string"),
		Mtime:                       pulumi.String("string"),
		ObjectTags:                  pulumi.String("string"),
		OverwriteMode:               pulumi.String("string"),
		PosixPermissions:            pulumi.String("string"),
		PreserveDeletedFiles:        pulumi.String("string"),
		PreserveDevices:             pulumi.String("string"),
		SecurityDescriptorCopyFlags: pulumi.String("string"),
		TaskQueueing:                pulumi.String("string"),
		TransferMode:                pulumi.String("string"),
		Uid:                         pulumi.String("string"),
		VerifyMode:                  pulumi.String("string"),
	},
	Schedule: &datasync.TaskScheduleArgs{
		ScheduleExpression: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TaskMode: pulumi.String("string"),
	TaskReportConfig: &datasync.TaskTaskReportConfigArgs{
		S3Destination: &datasync.TaskTaskReportConfigS3DestinationArgs{
			BucketAccessRoleArn: pulumi.String("string"),
			S3BucketArn:         pulumi.String("string"),
			Subdirectory:        pulumi.String("string"),
		},
		OutputType:  pulumi.String("string"),
		ReportLevel: pulumi.String("string"),
		ReportOverrides: &datasync.TaskTaskReportConfigReportOverridesArgs{
			DeletedOverride:     pulumi.String("string"),
			SkippedOverride:     pulumi.String("string"),
			TransferredOverride: pulumi.String("string"),
			VerifiedOverride:    pulumi.String("string"),
		},
		S3ObjectVersioning: pulumi.String("string"),
	},
})
Copy
var taskResource = new Task("taskResource", TaskArgs.builder()
    .destinationLocationArn("string")
    .sourceLocationArn("string")
    .cloudwatchLogGroupArn("string")
    .excludes(TaskExcludesArgs.builder()
        .filterType("string")
        .value("string")
        .build())
    .includes(TaskIncludesArgs.builder()
        .filterType("string")
        .value("string")
        .build())
    .name("string")
    .options(TaskOptionsArgs.builder()
        .atime("string")
        .bytesPerSecond(0)
        .gid("string")
        .logLevel("string")
        .mtime("string")
        .objectTags("string")
        .overwriteMode("string")
        .posixPermissions("string")
        .preserveDeletedFiles("string")
        .preserveDevices("string")
        .securityDescriptorCopyFlags("string")
        .taskQueueing("string")
        .transferMode("string")
        .uid("string")
        .verifyMode("string")
        .build())
    .schedule(TaskScheduleArgs.builder()
        .scheduleExpression("string")
        .build())
    .tags(Map.of("string", "string"))
    .taskMode("string")
    .taskReportConfig(TaskTaskReportConfigArgs.builder()
        .s3Destination(TaskTaskReportConfigS3DestinationArgs.builder()
            .bucketAccessRoleArn("string")
            .s3BucketArn("string")
            .subdirectory("string")
            .build())
        .outputType("string")
        .reportLevel("string")
        .reportOverrides(TaskTaskReportConfigReportOverridesArgs.builder()
            .deletedOverride("string")
            .skippedOverride("string")
            .transferredOverride("string")
            .verifiedOverride("string")
            .build())
        .s3ObjectVersioning("string")
        .build())
    .build());
Copy
task_resource = aws.datasync.Task("taskResource",
    destination_location_arn="string",
    source_location_arn="string",
    cloudwatch_log_group_arn="string",
    excludes={
        "filter_type": "string",
        "value": "string",
    },
    includes={
        "filter_type": "string",
        "value": "string",
    },
    name="string",
    options={
        "atime": "string",
        "bytes_per_second": 0,
        "gid": "string",
        "log_level": "string",
        "mtime": "string",
        "object_tags": "string",
        "overwrite_mode": "string",
        "posix_permissions": "string",
        "preserve_deleted_files": "string",
        "preserve_devices": "string",
        "security_descriptor_copy_flags": "string",
        "task_queueing": "string",
        "transfer_mode": "string",
        "uid": "string",
        "verify_mode": "string",
    },
    schedule={
        "schedule_expression": "string",
    },
    tags={
        "string": "string",
    },
    task_mode="string",
    task_report_config={
        "s3_destination": {
            "bucket_access_role_arn": "string",
            "s3_bucket_arn": "string",
            "subdirectory": "string",
        },
        "output_type": "string",
        "report_level": "string",
        "report_overrides": {
            "deleted_override": "string",
            "skipped_override": "string",
            "transferred_override": "string",
            "verified_override": "string",
        },
        "s3_object_versioning": "string",
    })
Copy
const taskResource = new aws.datasync.Task("taskResource", {
    destinationLocationArn: "string",
    sourceLocationArn: "string",
    cloudwatchLogGroupArn: "string",
    excludes: {
        filterType: "string",
        value: "string",
    },
    includes: {
        filterType: "string",
        value: "string",
    },
    name: "string",
    options: {
        atime: "string",
        bytesPerSecond: 0,
        gid: "string",
        logLevel: "string",
        mtime: "string",
        objectTags: "string",
        overwriteMode: "string",
        posixPermissions: "string",
        preserveDeletedFiles: "string",
        preserveDevices: "string",
        securityDescriptorCopyFlags: "string",
        taskQueueing: "string",
        transferMode: "string",
        uid: "string",
        verifyMode: "string",
    },
    schedule: {
        scheduleExpression: "string",
    },
    tags: {
        string: "string",
    },
    taskMode: "string",
    taskReportConfig: {
        s3Destination: {
            bucketAccessRoleArn: "string",
            s3BucketArn: "string",
            subdirectory: "string",
        },
        outputType: "string",
        reportLevel: "string",
        reportOverrides: {
            deletedOverride: "string",
            skippedOverride: "string",
            transferredOverride: "string",
            verifiedOverride: "string",
        },
        s3ObjectVersioning: "string",
    },
});
Copy
type: aws:datasync:Task
properties:
    cloudwatchLogGroupArn: string
    destinationLocationArn: string
    excludes:
        filterType: string
        value: string
    includes:
        filterType: string
        value: string
    name: string
    options:
        atime: string
        bytesPerSecond: 0
        gid: string
        logLevel: string
        mtime: string
        objectTags: string
        overwriteMode: string
        posixPermissions: string
        preserveDeletedFiles: string
        preserveDevices: string
        securityDescriptorCopyFlags: string
        taskQueueing: string
        transferMode: string
        uid: string
        verifyMode: string
    schedule:
        scheduleExpression: string
    sourceLocationArn: string
    tags:
        string: string
    taskMode: string
    taskReportConfig:
        outputType: string
        reportLevel: string
        reportOverrides:
            deletedOverride: string
            skippedOverride: string
            transferredOverride: string
            verifiedOverride: string
        s3Destination:
            bucketAccessRoleArn: string
            s3BucketArn: string
            subdirectory: string
        s3ObjectVersioning: string
Copy

Task Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Task resource accepts the following input properties:

DestinationLocationArn
This property is required.
Changes to this property will trigger replacement.
string
Amazon Resource Name (ARN) of destination DataSync Location.
SourceLocationArn
This property is required.
Changes to this property will trigger replacement.
string
Amazon Resource Name (ARN) of source DataSync Location.
CloudwatchLogGroupArn string
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
Excludes TaskExcludes
Filter rules that determines which files to exclude from a task.
Includes TaskIncludes
Filter rules that determines which files to include in a task.
Name string
Name of the DataSync Task.
Options TaskOptions
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
Schedule TaskSchedule
Specifies a schedule used to periodically transfer files from a source to a destination location.
Tags Dictionary<string, string>
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TaskMode Changes to this property will trigger replacement. string
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
TaskReportConfig TaskTaskReportConfig
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
DestinationLocationArn
This property is required.
Changes to this property will trigger replacement.
string
Amazon Resource Name (ARN) of destination DataSync Location.
SourceLocationArn
This property is required.
Changes to this property will trigger replacement.
string
Amazon Resource Name (ARN) of source DataSync Location.
CloudwatchLogGroupArn string
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
Excludes TaskExcludesArgs
Filter rules that determines which files to exclude from a task.
Includes TaskIncludesArgs
Filter rules that determines which files to include in a task.
Name string
Name of the DataSync Task.
Options TaskOptionsArgs
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
Schedule TaskScheduleArgs
Specifies a schedule used to periodically transfer files from a source to a destination location.
Tags map[string]string
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TaskMode Changes to this property will trigger replacement. string
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
TaskReportConfig TaskTaskReportConfigArgs
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
destinationLocationArn
This property is required.
Changes to this property will trigger replacement.
String
Amazon Resource Name (ARN) of destination DataSync Location.
sourceLocationArn
This property is required.
Changes to this property will trigger replacement.
String
Amazon Resource Name (ARN) of source DataSync Location.
cloudwatchLogGroupArn String
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
excludes TaskExcludes
Filter rules that determines which files to exclude from a task.
includes TaskIncludes
Filter rules that determines which files to include in a task.
name String
Name of the DataSync Task.
options TaskOptions
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
schedule TaskSchedule
Specifies a schedule used to periodically transfer files from a source to a destination location.
tags Map<String,String>
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
taskMode Changes to this property will trigger replacement. String
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
taskReportConfig TaskTaskReportConfig
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
destinationLocationArn
This property is required.
Changes to this property will trigger replacement.
ARN
Amazon Resource Name (ARN) of destination DataSync Location.
sourceLocationArn
This property is required.
Changes to this property will trigger replacement.
ARN
Amazon Resource Name (ARN) of source DataSync Location.
cloudwatchLogGroupArn ARN
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
excludes TaskExcludes
Filter rules that determines which files to exclude from a task.
includes TaskIncludes
Filter rules that determines which files to include in a task.
name string
Name of the DataSync Task.
options TaskOptions
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
schedule TaskSchedule
Specifies a schedule used to periodically transfer files from a source to a destination location.
tags {[key: string]: string}
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
taskMode Changes to this property will trigger replacement. string
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
taskReportConfig TaskTaskReportConfig
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
destination_location_arn
This property is required.
Changes to this property will trigger replacement.
str
Amazon Resource Name (ARN) of destination DataSync Location.
source_location_arn
This property is required.
Changes to this property will trigger replacement.
str
Amazon Resource Name (ARN) of source DataSync Location.
cloudwatch_log_group_arn str
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
excludes TaskExcludesArgs
Filter rules that determines which files to exclude from a task.
includes TaskIncludesArgs
Filter rules that determines which files to include in a task.
name str
Name of the DataSync Task.
options TaskOptionsArgs
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
schedule TaskScheduleArgs
Specifies a schedule used to periodically transfer files from a source to a destination location.
tags Mapping[str, str]
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
task_mode Changes to this property will trigger replacement. str
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
task_report_config TaskTaskReportConfigArgs
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
destinationLocationArn
This property is required.
Changes to this property will trigger replacement.
Amazon Resource Name (ARN) of destination DataSync Location.
sourceLocationArn
This property is required.
Changes to this property will trigger replacement.
Amazon Resource Name (ARN) of source DataSync Location.
cloudwatchLogGroupArn
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
excludes Property Map
Filter rules that determines which files to exclude from a task.
includes Property Map
Filter rules that determines which files to include in a task.
name String
Name of the DataSync Task.
options Property Map
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
schedule Property Map
Specifies a schedule used to periodically transfer files from a source to a destination location.
tags Map<String>
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
taskMode Changes to this property will trigger replacement. String
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
taskReportConfig Property Map
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Task resource produces the following output properties:

Arn string
Amazon Resource Name (ARN) of the DataSync Task.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the DataSync Task.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the DataSync Task.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the DataSync Task.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the DataSync Task.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the DataSync Task.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing Task Resource

Get an existing Task resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TaskState, opts?: CustomResourceOptions): Task
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        cloudwatch_log_group_arn: Optional[str] = None,
        destination_location_arn: Optional[str] = None,
        excludes: Optional[TaskExcludesArgs] = None,
        includes: Optional[TaskIncludesArgs] = None,
        name: Optional[str] = None,
        options: Optional[TaskOptionsArgs] = None,
        schedule: Optional[TaskScheduleArgs] = None,
        source_location_arn: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        task_mode: Optional[str] = None,
        task_report_config: Optional[TaskTaskReportConfigArgs] = None) -> Task
func GetTask(ctx *Context, name string, id IDInput, state *TaskState, opts ...ResourceOption) (*Task, error)
public static Task Get(string name, Input<string> id, TaskState? state, CustomResourceOptions? opts = null)
public static Task get(String name, Output<String> id, TaskState state, CustomResourceOptions options)
resources:  _:    type: aws:datasync:Task    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
Amazon Resource Name (ARN) of the DataSync Task.
CloudwatchLogGroupArn string
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
DestinationLocationArn Changes to this property will trigger replacement. string
Amazon Resource Name (ARN) of destination DataSync Location.
Excludes TaskExcludes
Filter rules that determines which files to exclude from a task.
Includes TaskIncludes
Filter rules that determines which files to include in a task.
Name string
Name of the DataSync Task.
Options TaskOptions
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
Schedule TaskSchedule
Specifies a schedule used to periodically transfer files from a source to a destination location.
SourceLocationArn Changes to this property will trigger replacement. string
Amazon Resource Name (ARN) of source DataSync Location.
Tags Dictionary<string, string>
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TaskMode Changes to this property will trigger replacement. string
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
TaskReportConfig TaskTaskReportConfig
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
Arn string
Amazon Resource Name (ARN) of the DataSync Task.
CloudwatchLogGroupArn string
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
DestinationLocationArn Changes to this property will trigger replacement. string
Amazon Resource Name (ARN) of destination DataSync Location.
Excludes TaskExcludesArgs
Filter rules that determines which files to exclude from a task.
Includes TaskIncludesArgs
Filter rules that determines which files to include in a task.
Name string
Name of the DataSync Task.
Options TaskOptionsArgs
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
Schedule TaskScheduleArgs
Specifies a schedule used to periodically transfer files from a source to a destination location.
SourceLocationArn Changes to this property will trigger replacement. string
Amazon Resource Name (ARN) of source DataSync Location.
Tags map[string]string
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TaskMode Changes to this property will trigger replacement. string
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
TaskReportConfig TaskTaskReportConfigArgs
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
arn String
Amazon Resource Name (ARN) of the DataSync Task.
cloudwatchLogGroupArn String
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
destinationLocationArn Changes to this property will trigger replacement. String
Amazon Resource Name (ARN) of destination DataSync Location.
excludes TaskExcludes
Filter rules that determines which files to exclude from a task.
includes TaskIncludes
Filter rules that determines which files to include in a task.
name String
Name of the DataSync Task.
options TaskOptions
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
schedule TaskSchedule
Specifies a schedule used to periodically transfer files from a source to a destination location.
sourceLocationArn Changes to this property will trigger replacement. String
Amazon Resource Name (ARN) of source DataSync Location.
tags Map<String,String>
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

taskMode Changes to this property will trigger replacement. String
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
taskReportConfig TaskTaskReportConfig
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
arn string
Amazon Resource Name (ARN) of the DataSync Task.
cloudwatchLogGroupArn ARN
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
destinationLocationArn Changes to this property will trigger replacement. ARN
Amazon Resource Name (ARN) of destination DataSync Location.
excludes TaskExcludes
Filter rules that determines which files to exclude from a task.
includes TaskIncludes
Filter rules that determines which files to include in a task.
name string
Name of the DataSync Task.
options TaskOptions
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
schedule TaskSchedule
Specifies a schedule used to periodically transfer files from a source to a destination location.
sourceLocationArn Changes to this property will trigger replacement. ARN
Amazon Resource Name (ARN) of source DataSync Location.
tags {[key: string]: string}
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

taskMode Changes to this property will trigger replacement. string
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
taskReportConfig TaskTaskReportConfig
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
arn str
Amazon Resource Name (ARN) of the DataSync Task.
cloudwatch_log_group_arn str
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
destination_location_arn Changes to this property will trigger replacement. str
Amazon Resource Name (ARN) of destination DataSync Location.
excludes TaskExcludesArgs
Filter rules that determines which files to exclude from a task.
includes TaskIncludesArgs
Filter rules that determines which files to include in a task.
name str
Name of the DataSync Task.
options TaskOptionsArgs
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
schedule TaskScheduleArgs
Specifies a schedule used to periodically transfer files from a source to a destination location.
source_location_arn Changes to this property will trigger replacement. str
Amazon Resource Name (ARN) of source DataSync Location.
tags Mapping[str, str]
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

task_mode Changes to this property will trigger replacement. str
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
task_report_config TaskTaskReportConfigArgs
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.
arn String
Amazon Resource Name (ARN) of the DataSync Task.
cloudwatchLogGroupArn
Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.
destinationLocationArn Changes to this property will trigger replacement.
Amazon Resource Name (ARN) of destination DataSync Location.
excludes Property Map
Filter rules that determines which files to exclude from a task.
includes Property Map
Filter rules that determines which files to include in a task.
name String
Name of the DataSync Task.
options Property Map
Configuration block containing option that controls the default behavior when you start an execution of this DataSync Task. For each individual task execution, you can override these options by specifying an overriding configuration in those executions.
schedule Property Map
Specifies a schedule used to periodically transfer files from a source to a destination location.
sourceLocationArn Changes to this property will trigger replacement.
Amazon Resource Name (ARN) of source DataSync Location.
tags Map<String>
Key-value pairs of resource tags to assign to the DataSync Task. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

taskMode Changes to this property will trigger replacement. String
One of the following task modes for your data transfer:

  • BASIC (default) - Transfer files or objects between Amazon Web Services storage and on-premises, edge, or other cloud storage.
  • ENHANCED - Transfer virtually unlimited numbers of objects with enhanced metrics, more detailed logs, and higher performance than Basic mode. Currently available for transfers between Amazon S3 locations.
taskReportConfig Property Map
Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.

Supporting Types

TaskExcludes
, TaskExcludesArgs

FilterType string
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
Value string
A single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
FilterType string
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
Value string
A single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
filterType String
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
value String
A single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
filterType string
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
value string
A single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
filter_type str
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
value str
A single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
filterType String
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
value String
A single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

TaskIncludes
, TaskIncludesArgs

FilterType string
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
Value string
A single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
FilterType string
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
Value string
A single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
filterType String
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
value String
A single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
filterType string
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
value string
A single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
filter_type str
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
value str
A single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
filterType String
The type of filter rule to apply. Valid values: SIMPLE_PATTERN.
value String
A single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

TaskOptions
, TaskOptionsArgs

Atime string
A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.
BytesPerSecond int
Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).
Gid string
Group identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
LogLevel string
Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: OFF, BASIC, TRANSFER. Default: OFF.
Mtime string
A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.
ObjectTags string
Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: PRESERVE, NONE. Default value: PRESERVE.
OverwriteMode string
Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: ALWAYS, NEVER. Default: ALWAYS.
PosixPermissions string
Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: NONE, PRESERVE. Default: PRESERVE.
PreserveDeletedFiles string
Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.
PreserveDevices string
Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).
SecurityDescriptorCopyFlags string
Determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. Valid values: NONE, OWNER_DACL, OWNER_DACL_SACL. Default: OWNER_DACL.
TaskQueueing string
Determines whether tasks should be queued before executing the tasks. Valid values: ENABLED, DISABLED. Default ENABLED.
TransferMode string
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Valid values: CHANGED, ALL. Default: CHANGED
Uid string
User identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
VerifyMode string
Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED. Default: POINT_IN_TIME_CONSISTENT.
Atime string
A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.
BytesPerSecond int
Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).
Gid string
Group identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
LogLevel string
Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: OFF, BASIC, TRANSFER. Default: OFF.
Mtime string
A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.
ObjectTags string
Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: PRESERVE, NONE. Default value: PRESERVE.
OverwriteMode string
Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: ALWAYS, NEVER. Default: ALWAYS.
PosixPermissions string
Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: NONE, PRESERVE. Default: PRESERVE.
PreserveDeletedFiles string
Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.
PreserveDevices string
Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).
SecurityDescriptorCopyFlags string
Determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. Valid values: NONE, OWNER_DACL, OWNER_DACL_SACL. Default: OWNER_DACL.
TaskQueueing string
Determines whether tasks should be queued before executing the tasks. Valid values: ENABLED, DISABLED. Default ENABLED.
TransferMode string
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Valid values: CHANGED, ALL. Default: CHANGED
Uid string
User identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
VerifyMode string
Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED. Default: POINT_IN_TIME_CONSISTENT.
atime String
A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.
bytesPerSecond Integer
Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).
gid String
Group identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
logLevel String
Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: OFF, BASIC, TRANSFER. Default: OFF.
mtime String
A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.
objectTags String
Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: PRESERVE, NONE. Default value: PRESERVE.
overwriteMode String
Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: ALWAYS, NEVER. Default: ALWAYS.
posixPermissions String
Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: NONE, PRESERVE. Default: PRESERVE.
preserveDeletedFiles String
Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.
preserveDevices String
Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).
securityDescriptorCopyFlags String
Determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. Valid values: NONE, OWNER_DACL, OWNER_DACL_SACL. Default: OWNER_DACL.
taskQueueing String
Determines whether tasks should be queued before executing the tasks. Valid values: ENABLED, DISABLED. Default ENABLED.
transferMode String
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Valid values: CHANGED, ALL. Default: CHANGED
uid String
User identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
verifyMode String
Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED. Default: POINT_IN_TIME_CONSISTENT.
atime string
A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.
bytesPerSecond number
Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).
gid string
Group identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
logLevel string
Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: OFF, BASIC, TRANSFER. Default: OFF.
mtime string
A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.
objectTags string
Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: PRESERVE, NONE. Default value: PRESERVE.
overwriteMode string
Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: ALWAYS, NEVER. Default: ALWAYS.
posixPermissions string
Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: NONE, PRESERVE. Default: PRESERVE.
preserveDeletedFiles string
Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.
preserveDevices string
Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).
securityDescriptorCopyFlags string
Determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. Valid values: NONE, OWNER_DACL, OWNER_DACL_SACL. Default: OWNER_DACL.
taskQueueing string
Determines whether tasks should be queued before executing the tasks. Valid values: ENABLED, DISABLED. Default ENABLED.
transferMode string
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Valid values: CHANGED, ALL. Default: CHANGED
uid string
User identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
verifyMode string
Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED. Default: POINT_IN_TIME_CONSISTENT.
atime str
A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.
bytes_per_second int
Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).
gid str
Group identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
log_level str
Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: OFF, BASIC, TRANSFER. Default: OFF.
mtime str
A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.
object_tags str
Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: PRESERVE, NONE. Default value: PRESERVE.
overwrite_mode str
Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: ALWAYS, NEVER. Default: ALWAYS.
posix_permissions str
Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: NONE, PRESERVE. Default: PRESERVE.
preserve_deleted_files str
Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.
preserve_devices str
Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).
security_descriptor_copy_flags str
Determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. Valid values: NONE, OWNER_DACL, OWNER_DACL_SACL. Default: OWNER_DACL.
task_queueing str
Determines whether tasks should be queued before executing the tasks. Valid values: ENABLED, DISABLED. Default ENABLED.
transfer_mode str
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Valid values: CHANGED, ALL. Default: CHANGED
uid str
User identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
verify_mode str
Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED. Default: POINT_IN_TIME_CONSISTENT.
atime String
A file metadata that shows the last time a file was accessed (that is when the file was read or written to). If set to BEST_EFFORT, the DataSync Task attempts to preserve the original (that is, the version before sync PREPARING phase) atime attribute on all source files. Valid values: BEST_EFFORT, NONE. Default: BEST_EFFORT.
bytesPerSecond Number
Limits the bandwidth utilized. For example, to set a maximum of 1 MB, set this value to 1048576. Value values: -1 or greater. Default: -1 (unlimited).
gid String
Group identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
logLevel String
Determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. Valid values: OFF, BASIC, TRANSFER. Default: OFF.
mtime String
A file metadata that indicates the last time a file was modified (written to) before the sync PREPARING phase. Value values: NONE, PRESERVE. Default: PRESERVE.
objectTags String
Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value. Valid values: PRESERVE, NONE. Default value: PRESERVE.
overwriteMode String
Determines whether files at the destination should be overwritten or preserved when copying files. Valid values: ALWAYS, NEVER. Default: ALWAYS.
posixPermissions String
Determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. Valid values: NONE, PRESERVE. Default: PRESERVE.
preserveDeletedFiles String
Whether files deleted in the source should be removed or preserved in the destination file system. Valid values: PRESERVE, REMOVE. Default: PRESERVE.
preserveDevices String
Whether the DataSync Task should preserve the metadata of block and character devices in the source files system, and recreate the files with that device name and metadata on the destination. The DataSync Task can’t sync the actual contents of such devices, because many of the devices are non-terminal and don’t return an end of file (EOF) marker. Valid values: NONE, PRESERVE. Default: NONE (ignore special devices).
securityDescriptorCopyFlags String
Determines which components of the SMB security descriptor are copied from source to destination objects. This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. Valid values: NONE, OWNER_DACL, OWNER_DACL_SACL. Default: OWNER_DACL.
taskQueueing String
Determines whether tasks should be queued before executing the tasks. Valid values: ENABLED, DISABLED. Default ENABLED.
transferMode String
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location. Valid values: CHANGED, ALL. Default: CHANGED
uid String
User identifier of the file's owners. Valid values: BOTH, INT_VALUE, NAME, NONE. Default: INT_VALUE (preserve integer value of the ID).
verifyMode String
Whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. Valid values: NONE, POINT_IN_TIME_CONSISTENT, ONLY_FILES_TRANSFERRED. Default: POINT_IN_TIME_CONSISTENT.

TaskSchedule
, TaskScheduleArgs

ScheduleExpression This property is required. string
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
ScheduleExpression This property is required. string
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
scheduleExpression This property is required. String
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
scheduleExpression This property is required. string
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
schedule_expression This property is required. str
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.
scheduleExpression This property is required. String
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

TaskTaskReportConfig
, TaskTaskReportConfigArgs

S3Destination This property is required. TaskTaskReportConfigS3Destination
Configuration block containing the configuration for the Amazon S3 bucket where DataSync uploads your task report. See s3_destination below.
OutputType string
Specifies the type of task report you'd like. Valid values: SUMMARY_ONLY and STANDARD.
ReportLevel string
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
ReportOverrides TaskTaskReportConfigReportOverrides
Configuration block containing the configuration of the reporting level for aspects of your task report. See report_overrides below.
S3ObjectVersioning string
Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. Valid values: INCLUDE and NONE.
S3Destination This property is required. TaskTaskReportConfigS3Destination
Configuration block containing the configuration for the Amazon S3 bucket where DataSync uploads your task report. See s3_destination below.
OutputType string
Specifies the type of task report you'd like. Valid values: SUMMARY_ONLY and STANDARD.
ReportLevel string
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
ReportOverrides TaskTaskReportConfigReportOverrides
Configuration block containing the configuration of the reporting level for aspects of your task report. See report_overrides below.
S3ObjectVersioning string
Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. Valid values: INCLUDE and NONE.
s3Destination This property is required. TaskTaskReportConfigS3Destination
Configuration block containing the configuration for the Amazon S3 bucket where DataSync uploads your task report. See s3_destination below.
outputType String
Specifies the type of task report you'd like. Valid values: SUMMARY_ONLY and STANDARD.
reportLevel String
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
reportOverrides TaskTaskReportConfigReportOverrides
Configuration block containing the configuration of the reporting level for aspects of your task report. See report_overrides below.
s3ObjectVersioning String
Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. Valid values: INCLUDE and NONE.
s3Destination This property is required. TaskTaskReportConfigS3Destination
Configuration block containing the configuration for the Amazon S3 bucket where DataSync uploads your task report. See s3_destination below.
outputType string
Specifies the type of task report you'd like. Valid values: SUMMARY_ONLY and STANDARD.
reportLevel string
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
reportOverrides TaskTaskReportConfigReportOverrides
Configuration block containing the configuration of the reporting level for aspects of your task report. See report_overrides below.
s3ObjectVersioning string
Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. Valid values: INCLUDE and NONE.
s3_destination This property is required. TaskTaskReportConfigS3Destination
Configuration block containing the configuration for the Amazon S3 bucket where DataSync uploads your task report. See s3_destination below.
output_type str
Specifies the type of task report you'd like. Valid values: SUMMARY_ONLY and STANDARD.
report_level str
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
report_overrides TaskTaskReportConfigReportOverrides
Configuration block containing the configuration of the reporting level for aspects of your task report. See report_overrides below.
s3_object_versioning str
Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. Valid values: INCLUDE and NONE.
s3Destination This property is required. Property Map
Configuration block containing the configuration for the Amazon S3 bucket where DataSync uploads your task report. See s3_destination below.
outputType String
Specifies the type of task report you'd like. Valid values: SUMMARY_ONLY and STANDARD.
reportLevel String
Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
reportOverrides Property Map
Configuration block containing the configuration of the reporting level for aspects of your task report. See report_overrides below.
s3ObjectVersioning String
Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution. Valid values: INCLUDE and NONE.

TaskTaskReportConfigReportOverrides
, TaskTaskReportConfigReportOverridesArgs

DeletedOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
SkippedOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
TransferredOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
VerifiedOverride string

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.

NOTE: If any report_overrides are set to the same value as task_report_config.report_level, they will always be flagged as changed. Only set overrides to a value that differs from task_report_config.report_level.

DeletedOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
SkippedOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
TransferredOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
VerifiedOverride string

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.

NOTE: If any report_overrides are set to the same value as task_report_config.report_level, they will always be flagged as changed. Only set overrides to a value that differs from task_report_config.report_level.

deletedOverride String
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
skippedOverride String
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
transferredOverride String
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
verifiedOverride String

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.

NOTE: If any report_overrides are set to the same value as task_report_config.report_level, they will always be flagged as changed. Only set overrides to a value that differs from task_report_config.report_level.

deletedOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
skippedOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
transferredOverride string
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
verifiedOverride string

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.

NOTE: If any report_overrides are set to the same value as task_report_config.report_level, they will always be flagged as changed. Only set overrides to a value that differs from task_report_config.report_level.

deleted_override str
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
skipped_override str
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
transferred_override str
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
verified_override str

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.

NOTE: If any report_overrides are set to the same value as task_report_config.report_level, they will always be flagged as changed. Only set overrides to a value that differs from task_report_config.report_level.

deletedOverride String
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
skippedOverride String
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
transferredOverride String
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.
verifiedOverride String

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. Valid values: ERRORS_ONLY and SUCCESSES_AND_ERRORS.

NOTE: If any report_overrides are set to the same value as task_report_config.report_level, they will always be flagged as changed. Only set overrides to a value that differs from task_report_config.report_level.

TaskTaskReportConfigS3Destination
, TaskTaskReportConfigS3DestinationArgs

BucketAccessRoleArn This property is required. string
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.
S3BucketArn This property is required. string
Specifies the ARN of the S3 bucket where DataSync uploads your report.
Subdirectory string
Specifies a bucket prefix for your report.
BucketAccessRoleArn This property is required. string
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.
S3BucketArn This property is required. string
Specifies the ARN of the S3 bucket where DataSync uploads your report.
Subdirectory string
Specifies a bucket prefix for your report.
bucketAccessRoleArn This property is required. String
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.
s3BucketArn This property is required. String
Specifies the ARN of the S3 bucket where DataSync uploads your report.
subdirectory String
Specifies a bucket prefix for your report.
bucketAccessRoleArn This property is required. string
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.
s3BucketArn This property is required. string
Specifies the ARN of the S3 bucket where DataSync uploads your report.
subdirectory string
Specifies a bucket prefix for your report.
bucket_access_role_arn This property is required. str
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.
s3_bucket_arn This property is required. str
Specifies the ARN of the S3 bucket where DataSync uploads your report.
subdirectory str
Specifies a bucket prefix for your report.
bucketAccessRoleArn This property is required. String
Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.
s3BucketArn This property is required. String
Specifies the ARN of the S3 bucket where DataSync uploads your report.
subdirectory String
Specifies a bucket prefix for your report.

Import

Using pulumi import, import aws_datasync_task using the DataSync Task Amazon Resource Name (ARN). For example:

$ pulumi import aws:datasync/task:Task example arn:aws:datasync:us-east-1:123456789012:task/task-12345678901234567
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws