Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. datasync
  5. Task

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi
pulumi/pulumi-aws

aws.datasync.Task

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 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

    With Scheduling

    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 = aws_datasync_location_s3.Destination.Arn,
        SourceLocationArn = aws_datasync_location_nfs.Source.Arn,
        Schedule = new Aws.DataSync.Inputs.TaskScheduleArgs
        {
            ScheduleExpression = "cron(0 12 ? * SUN,WED *)",
        },
    });

});

    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(aws_datasync_location_s3.Destination.Arn),
			SourceLocationArn:      pulumi.Any(aws_datasync_location_nfs.Source.Arn),
			Schedule: &datasync.TaskScheduleArgs{
				ScheduleExpression: pulumi.String("cron(0 12 ? * SUN,WED *)"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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(aws_datasync_location_s3.destination().arn())
            .sourceLocationArn(aws_datasync_location_nfs.source().arn())
            .schedule(TaskScheduleArgs.builder()
                .scheduleExpression("cron(0 12 ? * SUN,WED *)")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.datasync.Task("example",
    destination_location_arn=aws_datasync_location_s3["destination"]["arn"],
    source_location_arn=aws_datasync_location_nfs["source"]["arn"],
    schedule=aws.datasync.TaskScheduleArgs(
        schedule_expression="cron(0 12 ? * SUN,WED *)",
    ))

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

const example = new aws.datasync.Task("example", {
    destinationLocationArn: aws_datasync_location_s3.destination.arn,
    sourceLocationArn: aws_datasync_location_nfs.source.arn,
    schedule: {
        scheduleExpression: "cron(0 12 ? * SUN,WED *)",
    },
});

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

    With Filtering

    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 = aws_datasync_location_s3.Destination.Arn,
        SourceLocationArn = aws_datasync_location_nfs.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",
        },
    });

});

    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(aws_datasync_location_s3.Destination.Arn),
			SourceLocationArn:      pulumi.Any(aws_datasync_location_nfs.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
	})
}

    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(aws_datasync_location_s3.destination().arn())
            .sourceLocationArn(aws_datasync_location_nfs.source().arn())
            .excludes(TaskExcludesArgs.builder()
                .filterType("SIMPLE_PATTERN")
                .value("/folder1|/folder2")
                .build())
            .includes(TaskIncludesArgs.builder()
                .filterType("SIMPLE_PATTERN")
                .value("/folder1|/folder2")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.datasync.Task("example",
    destination_location_arn=aws_datasync_location_s3["destination"]["arn"],
    source_location_arn=aws_datasync_location_nfs["source"]["arn"],
    excludes=aws.datasync.TaskExcludesArgs(
        filter_type="SIMPLE_PATTERN",
        value="/folder1|/folder2",
    ),
    includes=aws.datasync.TaskIncludesArgs(
        filter_type="SIMPLE_PATTERN",
        value="/folder1|/folder2",
    ))

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

const example = new aws.datasync.Task("example", {
    destinationLocationArn: aws_datasync_location_s3.destination.arn,
    sourceLocationArn: aws_datasync_location_nfs.source.arn,
    excludes: {
        filterType: "SIMPLE_PATTERN",
        value: "/folder1|/folder2",
    },
    includes: {
        filterType: "SIMPLE_PATTERN",
        value: "/folder1|/folder2",
    },
});

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

    Create Task Resource

    new Task(name: string, args: TaskArgs, opts?: CustomResourceOptions);
    @overload
def Task(resource_name: str,
         opts: Optional[ResourceOptions] = 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,
         task_report_config: Optional[TaskTaskReportConfigArgs] = None)
@overload
def Task(resource_name: str,
         args: TaskArgs,
         opts: Optional[ResourceOptions] = 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.
    name string
    The unique name of the resource.
    args TaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args TaskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TaskArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The Task resource accepts the following input properties:

    DestinationLocationArn string

    Amazon Resource Name (ARN) of destination DataSync Location.

    SourceLocationArn 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.

    TaskReportConfig TaskTaskReportConfig

    Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.

    DestinationLocationArn string

    Amazon Resource Name (ARN) of destination DataSync Location.

    SourceLocationArn 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.

    TaskReportConfig TaskTaskReportConfigArgs

    Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.

    destinationLocationArn String

    Amazon Resource Name (ARN) of destination DataSync Location.

    sourceLocationArn 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.

    taskReportConfig TaskTaskReportConfig

    Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.

    destinationLocationArn ARN

    Amazon Resource Name (ARN) of destination DataSync Location.

    sourceLocationArn 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.

    taskReportConfig TaskTaskReportConfig

    Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.

    destination_location_arn str

    Amazon Resource Name (ARN) of destination DataSync Location.

    source_location_arn 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_report_config TaskTaskReportConfigArgs

    Configuration block containing the configuration of a DataSync Task Report. See task_report_config below.

    destinationLocationArn

    Amazon Resource Name (ARN) of destination DataSync Location.

    sourceLocationArn

    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.

    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_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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 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.

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

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

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

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

    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

    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.

    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 string

    Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

    ScheduleExpression string

    Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

    scheduleExpression String

    Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

    scheduleExpression string

    Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

    schedule_expression str

    Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

    scheduleExpression String

    Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

    TaskTaskReportConfig, TaskTaskReportConfigArgs

    S3Destination 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 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 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 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 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 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.

    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.

    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.

    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.

    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.

    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.

    TaskTaskReportConfigS3Destination, TaskTaskReportConfigS3DestinationArgs

    BucketAccessRoleArn string

    Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.

    S3BucketArn string

    Specifies the ARN of the S3 bucket where DataSync uploads your report.

    Subdirectory string

    Specifies a bucket prefix for your report.

    BucketAccessRoleArn string

    Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.

    S3BucketArn string

    Specifies the ARN of the S3 bucket where DataSync uploads your report.

    Subdirectory string

    Specifies a bucket prefix for your report.

    bucketAccessRoleArn String

    Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.

    s3BucketArn String

    Specifies the ARN of the S3 bucket where DataSync uploads your report.

    subdirectory String

    Specifies a bucket prefix for your report.

    bucketAccessRoleArn string

    Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.

    s3BucketArn 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 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 str

    Specifies the ARN of the S3 bucket where DataSync uploads your report.

    subdirectory str

    Specifies a bucket prefix for your report.

    bucketAccessRoleArn String

    Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket.

    s3BucketArn 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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi
    pulumi/pulumi-aws