Class Task

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.DataSync.Task("example", new Aws.DataSync.TaskArgs
    {
        DestinationLocationArn = aws_datasync_location_s3.Destination.Arn,
        Options = new Aws.DataSync.Inputs.TaskOptionsArgs
        {
            BytesPerSecond = -1,
        },
        SourceLocationArn = aws_datasync_location_nfs.Source.Arn,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Task

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.DataSync

Assembly: Pulumi.Aws.dll

Syntax

public class Task : CustomResource

Constructors

Task(String, TaskArgs, CustomResourceOptions)

Create a Task resource with the given unique name, arguments, and options.

Declaration

public Task(string name, TaskArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
TaskArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Amazon Resource Name (ARN) of the DataSync Task.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

CloudwatchLogGroupArn

Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task.

Declaration

public Output<string> CloudwatchLogGroupArn { get; }

Property Value

Type	Description
Output<System.String>

DestinationLocationArn

Amazon Resource Name (ARN) of destination DataSync Location.

Declaration

public Output<string> DestinationLocationArn { get; }

Property Value

Type	Description
Output<System.String>

Name

Name of the DataSync Task.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Options

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.

Declaration

public Output<TaskOptions> Options { get; }

Property Value

Type	Description
Output<TaskOptions>

SourceLocationArn

Amazon Resource Name (ARN) of source DataSync Location.

Declaration

public Output<string> SourceLocationArn { get; }

Property Value

Type	Description
Output<System.String>

Tags

Key-value pairs of resource tags to assign to the DataSync Task.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, TaskState, CustomResourceOptions)

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

Declaration

public static Task Get(string name, Input<string> id, TaskState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
TaskState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Task